feat:add headless arg to help

SafetyQuincyF commented 3 weeks ago

Description

Add --headless to help option for safety.

Type of Change

[ ] Bug fix
[x] New feature
[ ] Documentation update
[ ] Refactor
[ ] Other (please describe):

Testing

[ ] Tests added or updated
[x] No tests required

Checklist

[x] Code is well-documented
[x] Changelog is updated (if needed)
[x] No sensitive information (e.g., keys, credentials) is included in the code
[ ] All PR feedback is addressed

Summary by CodeRabbit

New Features
- Added a new debugging configuration for the "safety" module to easily access help information.
- Introduced a new command-line option for headless authentication, providing users with guidance on its usage.
Documentation
- Enhanced the help description for the authentication process, including details on automatic browser opening and headless authentication.
- Added deprecation warnings for older commands, guiding users towards the new command structure.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

A new debugging configuration named "Safety --help" has been added to the .vscode/launch.json file, allowing users to launch the "safety" module with the --help argument. Additionally, the CLI_AUTH_COMMAND_HELP string in safety/scan/constants.py has been updated from a single-line to a multi-line format, providing a clearer explanation of the authentication process, including details on headless authentication. The command-line interface has also been modified to remove the stage parameter and introduce a new --headless option.

Changes

File	Change Summary
.vscode/launch.json	Added a new debugging configuration: "Safety --help" to launch the "safety" module with `--help`.
safety/scan/constants.py	Updated `CLI_AUTH_COMMAND_HELP` from a single-line to a multi-line string for better clarity; added `CLI_HEADLESS_AUTH_HELP`.
safety/auth/cli_utils.py	Removed `stage` parameter from `auth_options`, added `--headless` option, and updated imports to include `CLI_HEADLESS_AUTH_HELP`.
safety/cli.py	Removed `stage` parameter from `auth_options` decorators in `check` and `license` commands; retained `print_deprecation_message` function.

Possibly related PRs

609: The changes in this PR include the addition of multiple configurations in the .vscode/launch.json file, which is directly related to the main PR's addition of the "Safety --help" configuration.
614: This PR modifies the .vscode/launch.json file by adding a new configuration for the "Safety License", indicating a direct connection to the changes made in the main PR.
628: This PR introduces a new launch configuration in the .vscode/launch.json file for "Safety Auth Login --headless", which is relevant to the debugging configurations discussed in the main PR.

Suggested reviewers

dylanpulver

🐰 In the meadow, where rabbits hop,
A new help command, we can't stop!
With safety's guide, so clear and bright,
Debugging's now a pure delight!
Hooray for changes, big and small,
In our cozy burrow, we welcome all! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate unit testing code.` - `@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.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

SafetyQuincyF commented 3 weeks ago

I am benching this due to complexity adding --headless to options would require a rewrite of how auth login is done. @dylanpulver

pyupio / safety