feat: add command compliance-check list
#7
Conversation
WalkthroughA new CLI command for managing compliance checks was introduced, including API client support, CLI command wiring, and comprehensive tests. A new Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant Commands
participant APIClient
participant API
User->>CLI: Run "compliance-check list"
CLI->>Commands: printChecks()
Commands->>APIClient: getAllChecks()
APIClient->>API: GET /api/v1/compliance-check
API-->>APIClient: Compliance check data
APIClient-->>Commands: APICheckItem[]
Commands-->>CLI: CommandResult (messages, success)
CLI-->>User: Output compliance checks
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (8)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/types.ts (1)
125-140: Well-structured type definition with room for improvement.The
APICheckItemtype is comprehensive and covers all necessary fields for compliance checks. The structure aligns well with the API response format.Consider extracting the priority group union type for better maintainability:
+type PriorityGroup = 'P0' | 'P1' | 'P2' | 'P3' | 'P4' | 'P5' | 'P6' | 'P7' | 'P8' | 'P9' | 'P10' | 'P11' | 'P12' | 'P13' | 'P14' | 'R0' | 'R1' | 'R2' | 'R3' | 'R4' | 'R5' | 'R6' | 'R7' | 'R8' | 'R9' | 'R10' | 'R11' | 'R12' | 'R13' | 'R14'; + export type APICheckItem = { id: number; title: string; description: string; default_section_number: string; default_section_name: string; code_name: string; - default_priority_group: 'P0' | 'P1' | 'P2' | 'P3' | 'P4' | 'P5' | 'P6' | 'P7' | 'P8' | 'P9' | 'P10' | 'P11' | 'P12' | 'P13' | 'P14' | 'R0' | 'R1' | 'R2' | 'R3' | 'R4' | 'R5' | 'R6' | 'R7' | 'R8' | 'R9' | 'R10' | 'R11' | 'R12' | 'R13' | 'R14'; + default_priority_group: PriorityGroup; is_c_scrm: boolean; implementation_status: 'pending' | 'completed'; implementation_type: string | null; implementation_details_reference: string | null; details_url: string; created_at: string; updated_at: string; };src/cli-commands.ts (1)
87-112: Solid implementation with minor formatting inconsistency.The
printChecksfunction is well-implemented with proper error handling and follows the established pattern fromprintChecklists.Consider aligning the message formatting with the existing
printChecklistsfunction for consistency:- messages.push('Compliance checks available:') + messages.push('Compliance checks:')And consider including the title in the output format for consistency with checklists:
- messages.push(`- ${check.code_name}: ${check.description}. ${check.details_url}`) + messages.push(`- ${check.title} (${check.code_name}): ${check.description}. Docs: ${check.details_url}`)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/__tests__/cli-commands.test.ts(2 hunks)src/__tests__/fixtures.ts(2 hunks)src/api-client.ts(2 hunks)src/cli-commands.ts(2 hunks)src/index.ts(2 hunks)src/types.ts(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (3)
src/index.ts (2)
src/cli-commands.ts (1)
printChecks(87-112)src/utils.ts (1)
handleCommandResult(38-45)
src/cli-commands.ts (2)
src/types.ts (1)
CommandResult(170-173)src/api-client.ts (1)
getAllChecks(65-72)
src/api-client.ts (1)
src/types.ts (1)
APICheckItem(125-140)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: Test on windows-latest with Node 24.x
- GitHub Check: Test on windows-latest with Node 22.x
- GitHub Check: Test on macOS-latest with Node 24.x
- GitHub Check: Test on ubuntu-latest with Node 24.x
- GitHub Check: Test on ubuntu-latest with Node 20.x
- GitHub Check: Test on windows-latest with Node 20.x
- GitHub Check: Test on ubuntu-latest with Node 22.x
🔇 Additional comments (11)
src/__tests__/fixtures.ts (2)
1-1: Import statement properly updated.The import statement correctly includes the new
APICheckItemtype needed for the mock data.
108-123: Well-structured mock data for testing.The mock data provides comprehensive test coverage with realistic values that match the
APICheckItemtype structure. The data includes proper field values for testing different scenarios.src/api-client.ts (2)
3-3: Import statement correctly updated.The import properly includes the new
APICheckItemtype required for the function implementation.
65-72: Well-implemented API client function.The
getAllChecksfunction follows the established pattern from existing API client functions. Error handling is consistent and appropriate, with proper type casting and HTTP status code validation.src/index.ts (2)
7-7: Import statement properly updated.The import correctly includes the new
printChecksfunction needed for the CLI command implementation.
38-48: Well-structured CLI command implementation.The new
compliance-checkcommand follows the established pattern of other CLI commands in the application. The command structure, description, and async handling are all implemented correctly and consistently.src/cli-commands.ts (1)
3-3: Import statement correctly updated.The import properly includes the new
getAllChecksfunction required for the implementation.src/__tests__/cli-commands.test.ts (4)
3-3: LGTM! Import statement correctly updated.The import statement has been properly updated to include the new
printChecksfunction.
5-5: LGTM! Type import correctly added.The import statement has been properly updated to include the new
APICheckItemtype.
6-6: LGTM! Mock data import correctly added.The import statement has been properly updated to include the new
mockAPICheckResponsefixture.
282-382: Excellent test coverage for the newprintChecksfunctionality.The test suite is comprehensive and well-structured, covering all essential scenarios:
✅ Strengths:
- Complete coverage: Tests success cases, error handling (API errors, network errors), and edge cases (empty response)
- Consistent structure: Follows the same pattern as existing
printCheckliststests, maintaining code consistency- Proper mocking: Uses
nockeffectively to mock HTTP calls and verifies all endpoints are called- Detailed assertions: Validates message content, success/failure states, and expected data fields (
code_name,description,details_url)- Multiple scenarios: Tests both single and multiple check items handling
The implementation demonstrates good testing practices and maintains consistency with the existing codebase.
Related #1
Summary by CodeRabbit