Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs and pre-commit after #3006 (#3038)

This commit is contained in:
Jonathan Plasse 2023-02-19 20:23:01 +01:00 committed by GitHub
parent 35d4e03f2a
commit d6a100028c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.pre-commit-config.yaml
View File

@ -30,7 +30,7 @@ repos:
pass_filenames: false pass_filenames: false
- id: ruff - id: ruff
name: ruff name: ruff
entry: cargo run -- --no-cache --fix entry: cargo run -p ruff_cli -- check --no-cache --force-exclude --fix --exit-non-zero-on-fix
language: rust language: rust
types_or: [python, pyi] types_or: [python, pyi]
require_serial: true require_serial: true

4
CONTRIBUTING.md
View File

@ -52,7 +52,7 @@ cargo install cargo-insta
After cloning the repository, run Ruff locally with: After cloning the repository, run Ruff locally with:
```shell ```shell
cargo run check /path/to/file.py --no-cache cargo run -p ruff_cli -- check /path/to/file.py --no-cache
``` ```
Prior to opening a pull request, ensure that your code has been auto-formatted, Prior to opening a pull request, ensure that your code has been auto-formatted,
@ -135,7 +135,7 @@ contain a variety of violations and non-violations designed to evaluate and demo
of your lint rule. of your lint rule.
Run `cargo dev generate-all` to generate the code for your new fixture. Then run Ruff Run `cargo dev generate-all` to generate the code for your new fixture. Then run Ruff
locally with (e.g.) `cargo run check crates/ruff/resources/test/fixtures/pycodestyle/E402.py --no-cache --select E402`. locally with (e.g.) `cargo run -p ruff_cli -- check crates/ruff/resources/test/fixtures/pycodestyle/E402.py --no-cache --select E402`.
Once you're satisfied with the output, codify the behavior as a snapshot test by adding a new Once you're satisfied with the output, codify the behavior as a snapshot test by adding a new
`test_case` macro in the relevant `crates/ruff/src/[linter]/mod.rs` file. Then, run `cargo test --all`. `test_case` macro in the relevant `crates/ruff/src/[linter]/mod.rs` file. Then, run `cargo test --all`.

50
crates/ruff/resources/test/project/README.md
View File

@ -8,14 +8,14 @@ behaviors.
Running from the repo root should pick up and enforce the appropriate settings for each package: Running from the repo root should pick up and enforce the appropriate settings for each package:
```console ```console
∴ cargo run resources/test/project/ ∴ cargo run -p ruff_cli -- check crates/ruff/resources/test/project/
resources/test/project/examples/.dotfiles/script.py:1:1: I001 Import block is un-sorted or un-formatted crates/ruff/resources/test/project/examples/.dotfiles/script.py:1:1: I001 Import block is un-sorted or un-formatted
resources/test/project/examples/.dotfiles/script.py:1:8: F401 `numpy` imported but unused crates/ruff/resources/test/project/examples/.dotfiles/script.py:1:8: F401 `numpy` imported but unused
resources/test/project/examples/.dotfiles/script.py:2:17: F401 `app.app_file` imported but unused crates/ruff/resources/test/project/examples/.dotfiles/script.py:2:17: F401 `app.app_file` imported but unused
resources/test/project/examples/docs/docs/file.py:1:1: I001 Import block is un-sorted or un-formatted crates/ruff/resources/test/project/examples/docs/docs/file.py:1:1: I001 Import block is un-sorted or un-formatted
resources/test/project/examples/docs/docs/file.py:8:5: F841 Local variable `x` is assigned to but never used crates/ruff/resources/test/project/examples/docs/docs/file.py:8:5: F841 Local variable `x` is assigned to but never used
resources/test/project/project/file.py:1:8: F401 `os` imported but unused crates/ruff/resources/test/project/project/file.py:1:8: F401 `os` imported but unused
resources/test/project/project/import_file.py:1:1: I001 Import block is un-sorted or un-formatted crates/ruff/resources/test/project/project/import_file.py:1:1: I001 Import block is un-sorted or un-formatted
Found 7 errors. Found 7 errors.
7 potentially fixable with the --fix option. 7 potentially fixable with the --fix option.
``` ```
@ -23,7 +23,7 @@ Found 7 errors.
Running from the project directory itself should exhibit the same behavior: Running from the project directory itself should exhibit the same behavior:
```console ```console
∴ (cd resources/test/project/ && cargo run .) ∴ (cd crates/ruff/resources/test/project/ && cargo run -p ruff_cli -- check .)
examples/.dotfiles/script.py:1:1: I001 Import block is un-sorted or un-formatted examples/.dotfiles/script.py:1:1: I001 Import block is un-sorted or un-formatted
examples/.dotfiles/script.py:1:8: F401 `numpy` imported but unused examples/.dotfiles/script.py:1:8: F401 `numpy` imported but unused
examples/.dotfiles/script.py:2:17: F401 `app.app_file` imported but unused examples/.dotfiles/script.py:2:17: F401 `app.app_file` imported but unused
@ -39,7 +39,7 @@ Running from the sub-package directory should exhibit the same behavior, but omi
files: files:
```console ```console
∴ (cd resources/test/project/examples/docs && cargo run .) ∴ (cd crates/ruff/resources/test/project/examples/docs && cargo run -p ruff_cli -- check .)
docs/file.py:1:1: I001 Import block is un-sorted or un-formatted docs/file.py:1:1: I001 Import block is un-sorted or un-formatted
docs/file.py:8:5: F841 Local variable `x` is assigned to but never used docs/file.py:8:5: F841 Local variable `x` is assigned to but never used
Found 2 errors. Found 2 errors.
@ -50,16 +50,16 @@ Found 2 errors.
file paths from the current working directory: file paths from the current working directory:
```console ```console
∴ (cargo run -- --config=resources/test/project/pyproject.toml resources/test/project/) ∴ (cargo run -p ruff_cli -- check --config=crates/ruff/resources/test/project/pyproject.toml crates/ruff/resources/test/project/)
resources/test/project/examples/.dotfiles/script.py:1:8: F401 `numpy` imported but unused crates/ruff/resources/test/project/examples/.dotfiles/script.py:1:8: F401 `numpy` imported but unused
resources/test/project/examples/.dotfiles/script.py:2:17: F401 `app.app_file` imported but unused crates/ruff/resources/test/project/examples/.dotfiles/script.py:2:17: F401 `app.app_file` imported but unused
resources/test/project/examples/docs/docs/concepts/file.py:1:8: F401 `os` imported but unused crates/ruff/resources/test/project/examples/docs/docs/concepts/file.py:1:8: F401 `os` imported but unused
resources/test/project/examples/docs/docs/file.py:1:1: I001 Import block is un-sorted or un-formatted crates/ruff/resources/test/project/examples/docs/docs/file.py:1:1: I001 Import block is un-sorted or un-formatted
resources/test/project/examples/docs/docs/file.py:1:8: F401 `os` imported but unused crates/ruff/resources/test/project/examples/docs/docs/file.py:1:8: F401 `os` imported but unused
resources/test/project/examples/docs/docs/file.py:3:8: F401 `numpy` imported but unused crates/ruff/resources/test/project/examples/docs/docs/file.py:3:8: F401 `numpy` imported but unused
resources/test/project/examples/docs/docs/file.py:4:27: F401 `docs.concepts.file` imported but unused crates/ruff/resources/test/project/examples/docs/docs/file.py:4:27: F401 `docs.concepts.file` imported but unused
resources/test/project/examples/excluded/script.py:1:8: F401 `os` imported but unused crates/ruff/resources/test/project/examples/excluded/script.py:1:8: F401 `os` imported but unused
resources/test/project/project/file.py:1:8: F401 `os` imported but unused crates/ruff/resources/test/project/project/file.py:1:8: F401 `os` imported but unused
Found 9 errors. Found 9 errors.
9 potentially fixable with the --fix option. 9 potentially fixable with the --fix option.
``` ```
@ -68,7 +68,7 @@ Running from a parent directory should "ignore" the `exclude` (hence, `concepts/
included in the output): included in the output):
```console ```console
∴ (cd resources/test/project/examples && cargo run -- --config=docs/ruff.toml .) ∴ (cd crates/ruff/resources/test/project/examples && cargo run -p ruff_cli -- check --config=docs/ruff.toml .)
docs/docs/concepts/file.py:5:5: F841 Local variable `x` is assigned to but never used docs/docs/concepts/file.py:5:5: F841 Local variable `x` is assigned to but never used
docs/docs/file.py:1:1: I001 Import block is un-sorted or un-formatted docs/docs/file.py:1:1: I001 Import block is un-sorted or un-formatted
docs/docs/file.py:8:5: F841 Local variable `x` is assigned to but never used docs/docs/file.py:8:5: F841 Local variable `x` is assigned to but never used
@ -80,8 +80,8 @@ Found 4 errors.
Passing an excluded directory directly should report errors in the contained files: Passing an excluded directory directly should report errors in the contained files:
```console ```console
∴ cargo run resources/test/project/examples/excluded/ ∴ cargo run -p ruff_cli -- check crates/ruff/resources/test/project/examples/excluded/
resources/test/project/examples/excluded/script.py:1:8: F401 `os` imported but unused crates/ruff/resources/test/project/examples/excluded/script.py:1:8: F401 `os` imported but unused
Found 1 error. Found 1 error.
1 potentially fixable with the --fix option. 1 potentially fixable with the --fix option.
``` ```
@ -89,8 +89,8 @@ Found 1 error.
Unless we `--force-exclude`: Unless we `--force-exclude`:
```console ```console
∴ cargo run resources/test/project/examples/excluded/ --force-exclude ∴ cargo run -p ruff_cli -- check crates/ruff/resources/test/project/examples/excluded/ --force-exclude
warning: No Python files found under the given path(s) warning: No Python files found under the given path(s)
∴ cargo run resources/test/project/examples/excluded/script.py --force-exclude ∴ cargo run -p ruff_cli -- check crates/ruff/resources/test/project/examples/excluded/script.py --force-exclude
warning: No Python files found under the given path(s) warning: No Python files found under the given path(s)
``` ```