Skip to content

Commit

Permalink
refactor: Move fix symbol legend into ruff_dev
Browse files Browse the repository at this point in the history
  • Loading branch information
not-my-profile authored and charliermarsh committed Feb 17, 2023
1 parent 180541a commit a2277cf
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -717,11 +717,11 @@ By default, Ruff enables Flake8's `E` and `F` rules. Ruff supports all rules fro
and a [subset](#error-e) of the `E` category, omitting those stylistic rules made obsolete by the
use of an autoformatter, like [Black](https://github.com/psf/black).

The 🛠 emoji indicates that a rule is automatically fixable by the `--fix` command-line option.

<!-- Sections automatically generated by `cargo dev generate-rules-table`. -->
<!-- Begin auto-generated sections. -->

The 🛠 emoji indicates that a rule is automatically fixable by the `--fix` command-line option.

### Pyflakes (F)

For more, see [Pyflakes](https://pypi.org/project/pyflakes/) on PyPI.
Expand Down
5 changes: 3 additions & 2 deletions crates/ruff_dev/src/generate_rules_table.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const TABLE_END_PRAGMA: &str = "<!-- End auto-generated sections. -->";
const TOC_BEGIN_PRAGMA: &str = "<!-- Begin auto-generated table of contents. -->";
const TOC_END_PRAGMA: &str = "<!-- End auto-generated table of contents. -->";

const FIX_SYMBOL: &str = "🛠";
const URL_PREFIX: &str = "https://beta.ruff.rs/docs/rules";

#[derive(clap::Args)]
Expand All @@ -31,7 +32,7 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator<Item = Rule>,
for rule in rules {
let fix_token = match rule.autofixable() {
None => "",
Some(_) => "🛠",
Some(_) => FIX_SYMBOL,
};

let rule_name = rule.as_ref();
Expand All @@ -55,7 +56,7 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator<Item = Rule>,

pub fn main(args: &Args) -> Result<()> {
// Generate the table string.
let mut table_out = String::new();
let mut table_out = format!("The {FIX_SYMBOL} emoji indicates that a rule is automatically fixable by the `--fix` command-line option.\n\n");
let mut toc_out = String::new();
for linter in Linter::iter() {
let codes_csv: String = match linter.common_prefix() {
Expand Down

0 comments on commit a2277cf

Please sign in to comment.