mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 10:48:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Rename FixKind to FixAvailability (#7658)

Browse source 
**Summary** `FixKind` feels to generic, i suggest renaming it to
something like `FixAvailibility`.

Commands used:

```bash
rg FixKind --files-with-matches | xargs sed -i 's/FixKind/FixAvailability/g'
rg fix_kind --files-with-matches | xargs sed -i 's/fix_kind/fix_availability/g'
rg FIX_KIND --files-with-matches | xargs sed -i 's/FIX_KIND/FIX_AVAILABILITY/g'
cargo fmt
```

`rg -i "fix.kind"` doesn't show any matches anymore.
This commit is contained in:
konsti 2023-10-02 16:38:25 +02:00 • committed by GitHub
parent ebdfcee87f
commit 0961f008b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
76 changed files with 185 additions and 179 deletions
Download patch file Download diff file Expand all files Collapse all files

11
crates/ruff_dev/src/generate_docs.rs
View file

@ -8,7 +8,7 @@ use anyhow::Result;
use regex::{Captures, Regex};
use strum::IntoEnumIterator;
use ruff_diagnostics::FixKind;
use ruff_diagnostics::FixAvailability;
use ruff_linter::registry::{Linter, Rule, RuleNamespace};
use ruff_workspace::options::Options;
use ruff_workspace::options_base::OptionsMetadata;
@ -37,9 +37,12 @@ pub(crate) fn main(args: &Args) -> Result<()> {
output.push('\n');
}
let fix_kind = rule.fixable();
if matches!(fix_kind, FixKind::Always | FixKind::Sometimes) {
output.push_str(&fix_kind.to_string());
let fix_availability = rule.fixable();
if matches!(
fix_availability,
FixAvailability::Always | FixAvailability::Sometimes
) {
output.push_str(&fix_availability.to_string());
output.push('\n');
output.push('\n');
}

6
crates/ruff_dev/src/generate_rules_table.rs
View file

@ -5,7 +5,7 @@
use itertools::Itertools;
use strum::IntoEnumIterator;
use ruff_diagnostics::FixKind;
use ruff_diagnostics::FixAvailability;
use ruff_linter::registry::{Linter, Rule, RuleNamespace};
use ruff_linter::upstream_categories::UpstreamCategoryAndPrefix;
use ruff_workspace::options::Options;
@ -21,10 +21,10 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator<Item = Rule>,
table_out.push('\n');
for rule in rules {
let fix_token = match rule.fixable() {
FixKind::Always | FixKind::Sometimes => {
FixAvailability::Always | FixAvailability::Sometimes => {
format!("<span style='opacity: 1'>{FIX_SYMBOL}</span>")
}
FixKind::None => format!("<span style='opacity: 0.1'>{FIX_SYMBOL}</span>"),
FixAvailability::None => format!("<span style='opacity: 0.1'>{FIX_SYMBOL}</span>"),
};
let preview_token = if rule.is_preview() || rule.is_nursery() {
format!("<span style='opacity: 1'>{PREVIEW_SYMBOL}</span>")