feat(cli): Add project command

[rajdip-b]

User description

Description

Fixes #298

---

PR Type

enhancement

---

Description

• Introduced a new ProjectCommand class with various subcommands for managing projects, including create, delete, fork, get, list, sync, unlink, and update operations.
• Refactored ScanCommand to utilize the Logger for logging instead of direct console output, improving consistency and maintainability.
• Integrated the ProjectCommand into the CLI command list, enabling project management functionalities.

---

Changes walkthrough 📝

Relevant files

Enhancement

12 files project.command.ts Add `ProjectCommand` class with subcommands for project management apps/cli/src/commands/project.command.ts Added a new ProjectCommand class extending BaseCommand. Implemented methods to manage project-related commands. Integrated subcommands for project operations. +34/-0    create.project.ts Add `CreateProject` command for project creation                  apps/cli/src/commands/project/create.project.ts Added CreateProject class extending BaseCommand. Implemented methods to create a project. +11/-0    delete.project.ts Add `DeleteProject` command for project deletion                  apps/cli/src/commands/project/delete.project.ts Added DeleteProject class extending BaseCommand. Implemented methods to delete a project. +11/-0    fork.project.ts Add `ForkProject` command for project forking                        apps/cli/src/commands/project/fork.project.ts Added ForkProject class extending BaseCommand. Implemented methods to fork a project. +11/-0    get.project.ts Add `GetProject` command to fetch project details                apps/cli/src/commands/project/get.project.ts Added GetProject class extending BaseCommand. Implemented methods to fetch project details. Added argument handling for project slug. +50/-0    list-forks.project.ts Add `ListProjectForks` command to list project forks          apps/cli/src/commands/project/list-forks.project.ts Added ListProjectForks class extending BaseCommand. Implemented methods to list all forks of a project. +11/-0    list.project.ts Add `ListProject` command to list workspace projects          apps/cli/src/commands/project/list.project.ts Added ListProject class extending BaseCommand. Implemented methods to list all projects in a workspace. Added argument handling for workspace slug. +46/-0    sync.project.ts Add `SyncProject` command for syncing forked projects        apps/cli/src/commands/project/sync.project.ts Added SyncProject class extending BaseCommand. Implemented methods to sync a forked project. +11/-0    unlink.project.ts Add `UnlinkProject` command to unlink forked projects        apps/cli/src/commands/project/unlink.project.ts Added UnlinkProject class extending BaseCommand. Implemented methods to unlink a forked project. +11/-0    update.project.ts Add `UpdateProject` command for project updates                    apps/cli/src/commands/project/update.project.ts Added UpdateProject class extending BaseCommand. Implemented methods to update a project. +11/-0    scan.command.ts Refactor `ScanCommand` to use `Logger` for logging              apps/cli/src/commands/scan.command.ts Replaced console logs with Logger for logging. Removed usage of colors package for output formatting. +23/-37  index.ts Integrate `ProjectCommand` into CLI command list                  apps/cli/src/index.ts Added ProjectCommand to the list of commands. +2/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free]

CI Failure Feedback 🧐

(Checks updated until commit 06ac85c)

Action: Validate PR title

Failed stage: Lint PR [❌]

Failed test name: Validate PR title

Failure summary: The action failed because the pull request title did not include a release type prefix. The title "initiated" does not conform to the conventional commits specification, which requires a prefix to indicate the type of change (e.g., feat, fix, chore).

Relevant error logs: 1: ##[group]Operating System 2: Ubuntu ... 35: Download action repository 'amannn/action-semantic-pull-request@v5' (SHA:0723387faaf9b38adef4775cd42cfd5155ed6017) 36: Complete job name: Validate PR title 37: ##[group]Run amannn/action-semantic-pull-request@v5 38: with: 39: githubBaseUrl: https://api.github.com 40: env: 41: GITHUB_TOKEN: *** 42: ##[endgroup] 43: ##[error]No release type found in pull request title "initiated". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

---

✨ CI feedback usage guide:

---

The CI feedback tool (/checks) automatically triggers when a PR has a failed check.
The tool analyzes the failed checks and provides several feedbacks:

• Failed stage
• Failed test name
• Failure summary
• Relevant error logs

In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:

/checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"

where {repo_name} is the name of the repository, {run_number} is the run number of the failed check, and {job_number} is the job number of the failed check.

Configuration options

• enable_auto_checks_feedback - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
• excluded_checks_list - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
• enable_help_text - if set to true, the tool will provide a help message with the feedback. Default is true.
• persistent_comment - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
• final_update_message - if persistent_comment is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

See more information about the checks tool in the docs.

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Error Handling The error message in the catch block is too generic. It should provide more specific information about what went wrong. Type Safety The use of 'any' type for the project object in the forEach loop reduces type safety. Consider defining a proper interface for the project object. Duplicate Code There are two identical log messages for "🔍 Secret Scan Started". This duplication should be removed.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Add a check for the existence of data in the success case to prevent potential runtime errors Consider adding error handling for cases where data might be undefined. This can prevent potential runtime errors if the API response doesn't contain the expected data structure. apps/cli/src/commands/project/get.project.ts [38-48] -if (success) { +if (success && data) { Logger.info(`Name: ${data.name}`) Logger.info(`Slug: ${data.slug}`) Logger.info(`Description: ${data.description}`) Logger.info(`Public Key: ${data.publicKey}`) Logger.info(`Private Key: ${data.privateKey}`) Logger.info(`Is Forked: ${data.isForked}`) Logger.info(`Access Level: ${data.accessLevel}`) +} else if (success) { + Logger.error('Project data is missing from the response') } else { Logger.error(`Failed fetching project: ${error.message}`) } Apply this suggestion Suggestion importance[1-10]: 9 Why: The suggestion addresses a potential runtime error by adding a check for the existence of data before accessing its properties, which is crucial for robust error handling.	9
Possible bug	Add a check for the existence of the regex match result to prevent potential runtime errors Consider adding a check for the existence of matched[0] before using it in the replace method to prevent potential runtime errors if the regex match fails. apps/cli/src/commands/scan.command.ts [91-92] const matched = line.match(regex) -const highlightedLine = line.replace(regex, matched[0]).trim() +const highlightedLine = matched ? line.replace(regex, matched[0]).trim() : line.trim() Apply this suggestion Suggestion importance[1-10]: 8 Why: This suggestion addresses a potential bug by ensuring that the code does not attempt to access an undefined element, which is important for preventing runtime errors.	8
Enhancement	Add type safety for the project object in the forEach loop to improve code reliability Consider adding type safety for the project object in the forEach loop. This can help prevent potential runtime errors and improve code maintainability. apps/cli/src/commands/project/list.project.ts [38-44] +interface Project { + name: string; + slug: string; +} + if (success) { - data.items.forEach((project: any) => { + data.items.forEach((project: Project) => { Logger.info(`- ${project.name} (${project.slug})`) }) } else { Logger.error(`Failed fetching projects: ${error.message}`) } Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding type safety improves code reliability and maintainability by ensuring that the project object has the expected structure, reducing the risk of runtime errors.	7
Best practice	Use template literals for string interpolation to improve code readability Consider using template literals for string interpolation instead of concatenation for better readability and maintainability. apps/cli/src/commands/scan.command.ts [105] -Logger.info(`${`${secret.file}:${secret.line}`}: ${secret.content}`) +Logger.info(`${secret.file}:${secret.line}: ${secret.content}`) Apply this suggestion Suggestion importance[1-10]: 5 Why: The suggestion improves code readability by using template literals, which is a minor enhancement but contributes to better code style and maintainability.	5

💡 Need additional feedback ? start a PR chat

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.11%. Comparing base (ce50743) to head (dbdaf8b).
Report is 195 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #451      +/-   ##
===========================================
- Coverage    91.71%   88.11%   -3.60%     
===========================================
  Files          111      105       -6     
  Lines         2510     2726     +216     
  Branches       469      413      -56     
===========================================
+ Hits          2302     2402     +100     
- Misses         208      324     +116     

Flag	Coverage Δ
api-e2e-tests	88.11% <100.00%> (-3.60%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀