Add `ruff rule --all` subcommand (with JSON output) #5059

akx · 2023-06-13T18:11:51Z

Summary

This adds a ruff rule --all switch that prints out a human-readable Markdown or a machine-readable JSON document of the lint rules known to Ruff.

I needed a machine-readable document of the rules for a project, and figured it could be useful for other people – or tooling! – to be able to interrogate Ruff about its arcane knowledge.

The JSON output is an array of the same objects printed by ruff rule --format=json.

Test Plan

I ran ruff rule --all --format=json. I think more might be needed, but maybe a snapshot test is overkill?

github-actions · 2023-06-13T18:28:04Z

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00      9.2±0.35ms     4.4 MB/sec    1.06      9.8±0.44ms     4.2 MB/sec
formatter/numpy/ctypeslib.py               1.04      2.2±0.19ms     7.6 MB/sec    1.00      2.1±0.10ms     7.9 MB/sec
formatter/numpy/globals.py                 1.00   246.9±10.21µs    12.0 MB/sec    1.00   247.1±19.90µs    11.9 MB/sec
formatter/pydantic/types.py                1.00      4.7±0.25ms     5.4 MB/sec    1.04      4.9±0.22ms     5.2 MB/sec
linter/all-rules/large/dataset.py          1.00     16.7±0.76ms     2.4 MB/sec    1.05     17.6±0.77ms     2.3 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      4.0±0.16ms     4.2 MB/sec    1.08      4.3±0.21ms     3.8 MB/sec
linter/all-rules/numpy/globals.py          1.00   519.5±28.21µs     5.7 MB/sec    1.07   555.1±20.90µs     5.3 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.1±0.26ms     3.6 MB/sec    1.09      7.7±0.32ms     3.3 MB/sec
linter/default-rules/large/dataset.py      1.00      7.8±0.28ms     5.2 MB/sec    1.08      8.4±0.30ms     4.8 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00  1718.5±96.01µs     9.7 MB/sec    1.03  1767.6±68.80µs     9.4 MB/sec
linter/default-rules/numpy/globals.py      1.00   205.1±12.57µs    14.4 MB/sec    1.04   212.9±16.57µs    13.9 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.8±0.18ms     6.8 MB/sec    1.00      3.7±0.15ms     6.8 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00     10.9±0.28ms     3.7 MB/sec    1.00     10.9±0.24ms     3.7 MB/sec
formatter/numpy/ctypeslib.py               1.02      2.4±0.07ms     7.0 MB/sec    1.00      2.3±0.07ms     7.1 MB/sec
formatter/numpy/globals.py                 1.00   268.0±11.17µs    11.0 MB/sec    1.03   276.6±19.56µs    10.7 MB/sec
formatter/pydantic/types.py                1.00      5.1±0.13ms     5.0 MB/sec    1.03      5.3±0.15ms     4.8 MB/sec
linter/all-rules/large/dataset.py          1.00     18.3±0.43ms     2.2 MB/sec    1.00     18.3±0.42ms     2.2 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.01      4.7±0.14ms     3.5 MB/sec    1.00      4.7±0.10ms     3.6 MB/sec
linter/all-rules/numpy/globals.py          1.00   577.2±17.17µs     5.1 MB/sec    1.00   577.0±17.39µs     5.1 MB/sec
linter/all-rules/pydantic/types.py         1.02      8.2±0.24ms     3.1 MB/sec    1.00      8.0±0.24ms     3.2 MB/sec
linter/default-rules/large/dataset.py      1.03      9.6±0.17ms     4.2 MB/sec    1.00      9.3±0.20ms     4.4 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00      2.1±0.04ms     8.1 MB/sec    1.00      2.0±0.06ms     8.1 MB/sec
linter/default-rules/numpy/globals.py      1.01    238.0±6.82µs    12.4 MB/sec    1.00    235.3±7.36µs    12.5 MB/sec
linter/default-rules/pydantic/types.py     1.00      4.3±0.10ms     6.0 MB/sec    1.00      4.3±0.12ms     6.0 MB/sec

akx · 2023-06-27T12:31:51Z

Sorry for the ping, but... ping, @charliermarsh? 😅

charliermarsh · 2023-06-27T16:45:22Z

Thank you for the ping and sorry @akx. What do you think about adding an --all flag or something to ruff rule? It feels like a lot to add an additional subcommand for something that's somewhat niche.

akx · 2023-06-27T18:57:49Z

@charliermarsh Sure, that sounds good to me too, I'll rework this :)

crates/ruff_cli/src/commands/rule.rs

MichaReiser · 2023-06-28T11:57:09Z

crates/ruff_cli/src/commands/rule.rs

+
+/// Explain a `Rule` to the user.
+pub(crate) fn rule(rule: Rule, format: HelpFormat) -> Result<()> {
+    let mut stdout = BufWriter::new(io::stdout().lock());


@dhruvmanila is it OK if we use stdout here or should this command also support forwarding to a file?

I think it's fine to use stdout here. We can always add it in the future if there's a use case.

MichaReiser · 2023-06-28T11:59:46Z

crates/ruff_cli/src/commands/rule.rs

+    if rule.is_nursery() {
+        output.push_str(&format!(
+            r#"This rule is part of the **nursery**, a collection of newer lints that are
 still under development. As such, it must be enabled by explicitly selecting


Should the JSON and human readable text have the same fields? IT seems that the nursery information is only available in the human readable output?

I added a nursery boolean to the JSON output (and TBH I thought I had done that before...).

MichaReiser · 2023-06-28T12:00:42Z

crates/ruff_cli/src/commands/rule.rs

-            output.push_str(&format!("# {} ({})", rule.as_ref(), rule.noqa_code()));
-            output.push('\n');
-            output.push('\n');
+fn format_rule_text(rule: Rule) -> String {


Nit: You could instead also implement Display for e.g. Explanation (this would also ensure that the JSON output and the human-readable output contain the same information).

I think I'll leave that for a future refactoring (I think the docs-generation code could be unified with this too?).

Co-authored-by: Micha Reiser <[email protected]>

akx force-pushed the rules-json branch from 4162e74 to c782b67 Compare June 13, 2023 18:14

akx marked this pull request as ready for review June 13, 2023 18:14

This comment was marked as outdated.

Sign in to view

akx marked this pull request as draft June 13, 2023 18:17

akx force-pushed the rules-json branch from c782b67 to f04faf9 Compare June 13, 2023 19:25

akx changed the title ~~Add ruff rules-json subcommand~~ Add ruff rules subcommand (with JSON output) Jun 13, 2023

akx marked this pull request as ready for review June 13, 2023 19:32

akx force-pushed the rules-json branch from f04faf9 to c0ffb88 Compare June 27, 2023 19:09

akx changed the title ~~Add ruff rules subcommand (with JSON output)~~ Add ruff rule --all subcommand (with JSON output) Jun 27, 2023

akx force-pushed the rules-json branch from c0ffb88 to 3883d60 Compare June 28, 2023 05:29

MichaReiser reviewed Jun 28, 2023

View reviewed changes

akx force-pushed the rules-json branch from b787d23 to 0212e92 Compare June 29, 2023 07:50

Add ruff rule --all subcommand (with JSON output support)

08c1db0

Co-authored-by: Micha Reiser <[email protected]>

akx force-pushed the rules-json branch from 0212e92 to 08c1db0 Compare June 29, 2023 07:54

akx requested a review from MichaReiser June 29, 2023 07:57

charliermarsh added 3 commits July 4, 2023 15:34

Make mutually exclusive

5fc9e23

Merge branch 'main' into rules-json

b377299

Add colon

83203fb

charliermarsh added the cli Related to the command-line interface label Jul 4, 2023

charliermarsh enabled auto-merge (squash) July 4, 2023 19:38

charliermarsh merged commit d7214e7 into astral-sh:main Jul 4, 2023

akx deleted the rules-json branch July 4, 2023 19:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `ruff rule --all` subcommand (with JSON output) #5059

Add `ruff rule --all` subcommand (with JSON output) #5059

akx commented Jun 13, 2023 •

edited

Loading

This comment was marked as outdated.

github-actions bot commented Jun 13, 2023 •

edited

Loading

akx commented Jun 27, 2023

charliermarsh commented Jun 27, 2023

akx commented Jun 27, 2023

MichaReiser Jun 28, 2023

dhruvmanila Jun 28, 2023

MichaReiser Jun 28, 2023

akx Jun 29, 2023

MichaReiser Jun 28, 2023

akx Jun 29, 2023

Add ruff rule --all subcommand (with JSON output) #5059

Add ruff rule --all subcommand (with JSON output) #5059

Conversation

akx commented Jun 13, 2023 • edited Loading

Summary

Test Plan

This comment was marked as outdated.

github-actions bot commented Jun 13, 2023 • edited Loading

PR Check Results

Ecosystem

Benchmark

Linux

Windows

akx commented Jun 27, 2023

charliermarsh commented Jun 27, 2023

akx commented Jun 27, 2023

MichaReiser Jun 28, 2023

Choose a reason for hiding this comment

dhruvmanila Jun 28, 2023

Choose a reason for hiding this comment

MichaReiser Jun 28, 2023

Choose a reason for hiding this comment

akx Jun 29, 2023

Choose a reason for hiding this comment

MichaReiser Jun 28, 2023

Choose a reason for hiding this comment

akx Jun 29, 2023

Choose a reason for hiding this comment

Add `ruff rule --all` subcommand (with JSON output) #5059

Add `ruff rule --all` subcommand (with JSON output) #5059

akx commented Jun 13, 2023 •

edited

Loading

github-actions bot commented Jun 13, 2023 •

edited

Loading