diff --git a/crates/ruff_cli/src/args.rs b/crates/ruff_cli/src/args.rs index 6ff4362eef..c08fd003e7 100644 --- a/crates/ruff_cli/src/args.rs +++ b/crates/ruff_cli/src/args.rs @@ -77,16 +77,19 @@ pub struct CheckCommand { /// List of files or directories to check. pub files: Vec, /// Attempt to automatically fix lint violations. + /// Use `--no-fix` to disable. #[arg(long, overrides_with("no_fix"))] fix: bool, #[clap(long, overrides_with("fix"), hide = true)] no_fix: bool, /// Show violations with source code. + /// Use `--no-show-source` to disable. #[arg(long, overrides_with("no_show_source"))] show_source: bool, #[clap(long, overrides_with("show_source"), hide = true)] no_show_source: bool, /// Show an enumeration of all autofixed lint violations. + /// Use `--no-show-fixes` to disable. #[arg(long, overrides_with("no_show_fixes"))] show_fixes: bool, #[clap(long, overrides_with("show_fixes"), hide = true)] @@ -98,6 +101,7 @@ pub struct CheckCommand { #[arg(short, long)] pub watch: bool, /// Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix`. + /// Use `--no-fix-only` to disable. #[arg(long, overrides_with("no_fix_only"))] fix_only: bool, #[clap(long, overrides_with("fix_only"), hide = true)] @@ -115,6 +119,7 @@ pub struct CheckCommand { #[arg(long, value_enum)] pub target_version: Option, /// Enable preview mode; checks will include unstable rules and fixes. + /// Use `--no-preview` to disable. #[arg(long, overrides_with("no_preview"))] preview: bool, #[clap(long, overrides_with("preview"), hide = true)] @@ -226,6 +231,7 @@ pub struct CheckCommand { )] pub extend_unfixable: Option>, /// Respect file exclusions via `.gitignore` and other standard ignore files. + /// Use `--no-respect-gitignore` to disable. #[arg( long, overrides_with("no_respect_gitignore"), @@ -235,6 +241,7 @@ pub struct CheckCommand { #[clap(long, overrides_with("respect_gitignore"), hide = true)] no_respect_gitignore: bool, /// Enforce exclusions, even for paths passed to Ruff directly on the command-line. + /// Use `--no-force-exclude` to disable. #[arg( long, overrides_with("no_force_exclude"), @@ -341,6 +348,7 @@ pub struct FormatCommand { #[arg(long, conflicts_with = "isolated")] pub config: Option, /// Respect file exclusions via `.gitignore` and other standard ignore files. + /// Use `--no-respect-gitignore` to disable. #[arg( long, overrides_with("no_respect_gitignore"), @@ -350,6 +358,7 @@ pub struct FormatCommand { #[clap(long, overrides_with("respect_gitignore"), hide = true)] no_respect_gitignore: bool, /// Enforce exclusions, even for paths passed to Ruff directly on the command-line. + /// Use `--no-force-exclude` to disable. #[arg( long, overrides_with("no_force_exclude"), @@ -369,6 +378,7 @@ pub struct FormatCommand { pub stdin_filename: Option, /// Enable preview mode; checks will include unstable rules and fixes. + /// Use `--no-preview` to disable. #[arg(long, overrides_with("no_preview"), hide = true)] preview: bool, #[clap(long, overrides_with("preview"), hide = true)] diff --git a/docs/configuration.md b/docs/configuration.md index fa546ce3b6..d145e6e76f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -193,17 +193,17 @@ Arguments: Options: --fix - Attempt to automatically fix lint violations + Attempt to automatically fix lint violations. Use `--no-fix` to disable --show-source - Show violations with source code + Show violations with source code. Use `--no-show-source` to disable --show-fixes - Show an enumeration of all autofixed lint violations + Show an enumeration of all autofixed lint violations. Use `--no-show-fixes` to disable --diff Avoid writing any fixed files back; instead, output a diff for each changed file to stdout. Implies `--fix-only` -w, --watch Run in watch mode by re-running whenever files change --fix-only - Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix` + Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix`. Use `--no-fix-only` to disable --ignore-noqa Ignore any `# noqa` comments --format @@ -213,7 +213,7 @@ Options: --target-version The minimum Python version that should be supported [possible values: py37, py38, py39, py310, py311, py312] --preview - Enable preview mode; checks will include unstable rules and fixes + Enable preview mode; checks will include unstable rules and fixes. Use `--no-preview` to disable --config Path to the `pyproject.toml` or `ruff.toml` file to use for configuration --statistics @@ -248,8 +248,8 @@ Rule selection: File selection: --exclude List of paths, used to omit files and/or directories from analysis --extend-exclude Like --exclude, but adds additional files and directories on top of those already excluded - --respect-gitignore Respect file exclusions via `.gitignore` and other standard ignore files - --force-exclude Enforce exclusions, even for paths passed to Ruff directly on the command-line + --respect-gitignore Respect file exclusions via `.gitignore` and other standard ignore files. Use `--no-respect-gitignore` to disable + --force-exclude Enforce exclusions, even for paths passed to Ruff directly on the command-line. Use `--no-force-exclude` to disable Miscellaneous: -n, --no-cache