diff --git a/pages/common/ruff-check.md b/pages/common/ruff-check.md new file mode 100644 index 000000000..db3c19fad --- /dev/null +++ b/pages/common/ruff-check.md @@ -0,0 +1,33 @@ +# ruff check + +> An extremely fast Python linter. `check` is the default command - it can be omitted everywhere. +> If no files or directories are specified, the current working directory is used by default. +> More information: . + +- Run the linter on the given files or directories: + +`ruff check {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Apply the suggested fixes, modifying the files in-place: + +`ruff check --fix` + +- Run the linter and re-lint on change: + +`ruff check --watch` + +- Only enable the specified rules (or all rules), ignoring the configuration file: + +`ruff check --select {{ALL|rule_code1,rule_code2,...}}` + +- Additionally enable the specified rules: + +`ruff check --extend-select {{rule_code1,rule_code2,...}}` + +- Disable the specified rules: + +`ruff check --ignore {{rule_code1,rule_code2,...}}` + +- Ignore all existing violations of a rule by adding `# noqa` directives to all lines that violate it: + +`ruff check --select {{rule_code}} --add-noqa` diff --git a/pages/common/ruff-format.md b/pages/common/ruff-format.md new file mode 100644 index 000000000..5bcb43e9a --- /dev/null +++ b/pages/common/ruff-format.md @@ -0,0 +1,17 @@ +# ruff format + +> An extremely fast Python code formatter. +> If no files or directories are specified, the current working directory is used by default. +> More information: . + +- Format given files or directories in-place: + +`ruff format {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Print which files would have been modified and return a non-zero exit code if there are files to reformat, and zero otherwise: + +`ruff format --check` + +- Print what changes would be made without modifying the files: + +`ruff format --diff` diff --git a/pages/common/ruff.md b/pages/common/ruff.md new file mode 100644 index 000000000..ee7a7904e --- /dev/null +++ b/pages/common/ruff.md @@ -0,0 +1,12 @@ +# ruff + +> An extremely fast Python linter and code formatter, written in Rust. +> More information: . + +- View documentation for the Ruff linter: + +`tldr ruff check` + +- View documentation for the Ruff code formatter: + +`tldr ruff format`