fix: dry-run option is missing in the usage instructions

danstis commented 7 months ago

User description

Fixes #202

Type

enhancement, documentation

Description

Introduced a new -d, --dry-run option in rmstale to allow users to simulate the removal process without actually deleting any files. This enhancement is crucial for users who want to test the behavior of rmstale without risking data loss.
Updated the command-line options order in both the application usage instructions and the README documentation to improve consistency and readability.

Changes walkthrough

Relevant files

Enhancement

rmstale.go

Add dry-run option and reorder CLI options

rmstale.go

Added a new command-line option -d, --dry-run for running the process
without removing files.

Reordered command-line options for better readability.

+3/-2

Documentation

README.md

Document dry-run option and update flags order

README.md

Documented the new -d, --dry-run option in the usage section.

Reordered the flags in the documentation to match the order in the
application.

+3/-2

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

sophie-syntax[bot] commented 7 months ago

PR Description updated to latest commit (https://github.com/danstis/rmstale/commit/49675a00e08a9a71fd73f8fde552e87ed86c1f75)

sophie-syntax[bot] commented 7 months ago

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and mainly involve documentation and a minor enhancement in functionality. The addition of a new command-line option and the reordering of existing options are clear and should not require extensive time to review.
🧪 Relevant tests	No
🔍 Possible issues	Possible Issue: The addition of the `-d, --dry-run` option in `rmstale.go` is a great feature, but it's not clear if the implementation ensures that no files are actually removed when this option is used. It would be beneficial to see the implementation details to ensure that this feature works as intended.
🔒 Security concerns	No

✨ Review tool usage guide:

**Overview:** The `review` tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be [added](https://pr-agent-docs.codium.ai/tools/review/#general-configurations) by configuring the tool. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on any PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L23) related to the review tool (`pr_reviewer` section), use the following template: ``` /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_reviewer] some_config1=... some_config2=... ``` See the review [usage page](https://pr-agent-docs.codium.ai/tools/review/) for a comprehensive guide on using this tool.

sophie-syntax[bot] commented 7 months ago

PR Code Suggestions

Category	Suggestions
Maintainability	Improve alignment of flag descriptions in the usage string. ___ Ensure consistent spacing for the flags in the usage string to improve readability. The alignment of the flag descriptions should be uniform. [rmstale.go [23-24]](https://github.com/danstis/rmstale/pull/205/files#diff-8d2045f56d565d537deafa629d12ea2b52f0701a7366f155b4b1038745e58e4eR23-R24) ```diff -a, --age Period in days before an item is considered stale. --d, --dry-run Runs the process in dry-run mode, no files will be removed. +-d, --dry-run Runs the process in dry-run mode, no files will be removed. -e, --extension Filter files for a defined file extension. ```

Category

Suggestions

Maintainability

Improve alignment of flag descriptions in the usage string.

___ **Ensure consistent spacing for the flags in the usage string to improve readability. The
alignment of the flag descriptions should be uniform.** [rmstale.go [23-24]](https://github.com/danstis/rmstale/pull/205/files#diff-8d2045f56d565d537deafa629d12ea2b52f0701a7366f155b4b1038745e58e4eR23-R24) ```diff -a, --age Period in days before an item is considered stale. --d, --dry-run Runs the process in dry-run mode, no files will be removed. +-d, --dry-run Runs the process in dry-run mode, no files will be removed. -e, --extension Filter files for a defined file extension. ```

✨ Improve tool usage guide:

**Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on a PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L78) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` See the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.