Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cli): add CLI --dry-run flag #7

Open
11 tasks
ekkolon opened this issue Jan 25, 2024 · 0 comments
Open
11 tasks

feat(cli): add CLI --dry-run flag #7

ekkolon opened this issue Jan 25, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@ekkolon
Copy link
Owner

ekkolon commented Jan 25, 2024

Description:

Objective:
Implement a --dry-run flag in the CLI to allow users to simulate the licensing process without making actual changes to files.

Features:

  • Introduce a --dry-run flag for the CLI.
  • When the --dry-run flag is used, the CLI should output the intended changes without applying them.
  • Ensure that the dry run accurately reflects the actions that would be taken during a regular run.

Motivation:

  • Users may want to preview the changes the CLI will make before applying them.
  • Enhances user confidence in the licensing process.

Tasks:

  • CLI Modification:

    • Add support for the --dry-run flag in the CLI parsing logic.
  • Simulation Output:

    • Implement the logic to simulate the licensing process without actually modifying files.
    • Output the intended changes to the console.
  • Documentation:

    • Update the CLI documentation to include information about the new --dry-run flag.
    • Provide examples and usage instructions.
  • Testing:

    • Create test cases to ensure that the --dry-run flag functions as expected.
    • Include tests for various scenarios, including different licensing configurations.
@ekkolon ekkolon added the enhancement New feature or request label Mar 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant