Remove the legacy CLI 🎉

[UlisesGascon]

Related OpenPathfinder/visionBoard-cli#1

Summary by CodeRabbit

• Chores
  • Removed the command-line interface (CLI) and all related commands for managing projects, workflows, checks, and checklists.
  • Deleted associated test files for CLI functionality.
  • Removed CLI dependencies and executable mapping from the project configuration.
• Refactor
  • Centralized workflow metadata and access into a new structure, providing improved workflow details retrieval.
• Tests
  • Updated and simplified test suites to remove file-based input, focusing on direct data input for imports.
  • Adjusted test imports to reflect internal module restructuring.

[coderabbitai]

Walkthrough

This change removes the entire CLI tool and its supporting modules, including all CLI command definitions, their implementations, and associated tests. It also deletes the CLI executable entry from package.json and removes dependencies related to CLI functionality. The workflow registry is refactored and centralized in the workflows module, with new metadata accessor functions.

Changes

File(s)	Change Summary
tests/cli/check.test.js, tests/cli/project.test.js, tests/cli/workflows.test.js	Deleted all CLI-related test suites for checks, projects, and workflows.
tests/httpServer/apiV1.test.js	Updated mocks and imports to reference the new workflows module path.
tests/importers.test.js	Refactored tests to pass data directly to bulkImport and removed file system mocks and file-based tests.
package.json	Removed the CLI executable entry (bin field) and CLI dependencies (commander, inquirer).
src/cli/checklists.js, src/cli/checks.js, src/cli/project.js, src/cli/workflows.js, src/cli/index.js	Deleted all CLI command implementation modules and the CLI aggregator module.
src/httpServer/routers/apiV1.js	Changed import path for getWorkflowsDetails to reference the new workflows registry location.
src/workflows/index.js	Added centralized workflow registry and metadata accessor (getWorkflowsDetails).
visionboard.js	Deleted the main CLI entry point and all command definitions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI (visionboard.js)
    participant CLI Command Module
    participant Database

    User->>CLI (visionboard.js): Run CLI command (e.g., add project)
    CLI (visionboard.js)->>CLI Command Module: Invoke command logic
    CLI Command Module->>Database: Perform DB operations
    Database-->>CLI Command Module: Return results
    CLI Command Module-->>CLI (visionboard.js): Output/log result
    CLI (visionboard.js)-->>User: Display result

    Note over CLI (visionboard.js),CLI Command Module: Entire flow removed in this change

Loading

sequenceDiagram
    participant App Server
    participant Workflows Module

    App Server->>Workflows Module: getWorkflowsDetails()
    Workflows Module-->>App Server: Return workflows metadata

    Note over Workflows Module: New centralized workflow registry and accessor

Loading

Poem

A bunny once typed on the command line,
But now those commands are lost in time.
The carrots of workflows, all neat in a row,
Are cataloged smartly—no CLI to show!
With code now lighter, I hop and I cheer,
For change is the only thing constant here.
🥕

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef0b1bb and 4ab9ead.

⛔ Files ignored due to path filters (2)

• __tests__/cli/__snapshots__/workflows.test.js.snap is excluded by !**/*.snap
• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (14)

• __tests__/cli/check.test.js (0 hunks)
• __tests__/cli/project.test.js (0 hunks)
• __tests__/cli/workflows.test.js (0 hunks)
• __tests__/httpServer/apiV1.test.js (4 hunks)
• __tests__/importers.test.js (3 hunks)
• package.json (0 hunks)
• src/cli/checklists.js (0 hunks)
• src/cli/checks.js (0 hunks)
• src/cli/index.js (0 hunks)
• src/cli/project.js (0 hunks)
• src/cli/workflows.js (0 hunks)
• src/httpServer/routers/apiV1.js (1 hunks)
• src/workflows/index.js (2 hunks)
• visionboard.js (0 hunks)

💤 Files with no reviewable changes (10)

• package.json
• src/cli/index.js
• tests/cli/check.test.js
• tests/cli/project.test.js
• src/cli/checks.js
• tests/cli/workflows.test.js
• src/cli/workflows.js
• src/cli/project.js
• src/cli/checklists.js
• visionboard.js

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Playwright Tests

🔇 Additional comments (11)

src/httpServer/routers/apiV1.js (1)

6-6: LGTM! Import path correctly updated.

The import path change from '../../cli/workflows' to '../../workflows' aligns with the centralization of workflow functionality and removal of CLI modules.

__tests__/httpServer/apiV1.test.js (2)

7-7: LGTM! Test imports consistently updated.

All mock, import, and spy references have been correctly updated from the CLI workflows module to the centralized workflows module, maintaining test functionality while supporting the CLI removal.

Also applies to: 31-31, 170-170

---

693-693: Good practice: Converting skipped test to todo.

Converting the skipped test to a todo test is appropriate and follows Jest best practices.

__tests__/importers.test.js (3)

31-31: Good refactoring: Test suite re-enabled.

Re-enabling the test suite and shifting from file-based to direct programmatic testing aligns well with the CLI removal objectives.

---

38-41: Improved test approach: Direct data input.

The refactoring from file-based input to direct data passing with bulkImport({ operationId, knex, data }) is cleaner and more maintainable. The tests are now more focused and easier to understand.

Also applies to: 56-59, 73-76

---

84-92: Good addition: Error handling test.

Adding a test for unsupported operation IDs improves test coverage and ensures proper error handling for invalid operations.

src/workflows/index.js (5)

8-8: LGTM! Required imports added.

The new imports for lodash, generateStaticReports, and schema validation are properly added to support the centralized workflow management.

Also applies to: 11-12

---

127-165: Excellent centralization: Workflow metadata registry.

The commandList array provides a clean, declarative approach to workflow management. Each workflow entry has consistent metadata including name, description, enablement status, and schema validation. This is much more maintainable than scattered CLI command definitions.

---

167-184: Well-designed accessor function.

The getWorkflowsDetails function properly transforms the command list into both a workflows object (keyed by kebab-case names) and a workflows list for API consumption. The use of lodash kebabCase ensures consistent naming.

---

191-192: LGTM! Exports updated correctly.

The module exports have been properly updated to include the new runOneComplianceCheck function and getWorkflowsDetails accessor, maintaining backward compatibility while adding the new centralized functionality.

---

173-173: Verify schema serialization approach.

The JSON.stringify(workflow.schema) approach for schema handling should be verified to ensure it works correctly with the validation logic in the consuming code.

#!/bin/bash
# Description: Check how schemas are used in the codebase to verify JSON.stringify approach is correct

# Search for schema usage patterns
echo "=== Checking schema usage patterns ==="
rg -A 3 -B 3 "schema.*JSON\.parse|JSON\.parse.*schema"

echo "=== Checking workflow schema validation ==="
rg -A 5 "validateExecuteOneCheck|executeOneCheckSchema"

echo "=== Checking if schema is used as object or string ==="
rg -A 3 "workflow\.schema"

Also applies to: 179-179

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.