Skip to content

Commit 0961f00

Browse files
authored
Rename FixKind to FixAvailability (#7658)
**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.
1 parent ebdfcee commit 0961f00

File tree

76 files changed

+185
-179
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+185
-179
lines changed

crates/ruff_cli/src/commands/rule.rs

+7-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use serde::ser::SerializeSeq;
55
use serde::{Serialize, Serializer};
66
use strum::IntoEnumIterator;
77

8-
use ruff_diagnostics::FixKind;
8+
use ruff_diagnostics::FixAvailability;
99
use ruff_linter::registry::{Linter, Rule, RuleNamespace};
1010

1111
use crate::args::HelpFormat;
@@ -51,9 +51,12 @@ fn format_rule_text(rule: Rule) -> String {
5151
output.push('\n');
5252
output.push('\n');
5353

54-
let fix_kind = rule.fixable();
55-
if matches!(fix_kind, FixKind::Always | FixKind::Sometimes) {
56-
output.push_str(&fix_kind.to_string());
54+
let fix_availability = rule.fixable();
55+
if matches!(
56+
fix_availability,
57+
FixAvailability::Always | FixAvailability::Sometimes
58+
) {
59+
output.push_str(&fix_availability.to_string());
5760
output.push('\n');
5861
output.push('\n');
5962
}

crates/ruff_dev/src/generate_docs.rs

+7-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use anyhow::Result;
88
use regex::{Captures, Regex};
99
use strum::IntoEnumIterator;
1010

11-
use ruff_diagnostics::FixKind;
11+
use ruff_diagnostics::FixAvailability;
1212
use ruff_linter::registry::{Linter, Rule, RuleNamespace};
1313
use ruff_workspace::options::Options;
1414
use ruff_workspace::options_base::OptionsMetadata;
@@ -37,9 +37,12 @@ pub(crate) fn main(args: &Args) -> Result<()> {
3737
output.push('\n');
3838
}
3939

40-
let fix_kind = rule.fixable();
41-
if matches!(fix_kind, FixKind::Always | FixKind::Sometimes) {
42-
output.push_str(&fix_kind.to_string());
40+
let fix_availability = rule.fixable();
41+
if matches!(
42+
fix_availability,
43+
FixAvailability::Always | FixAvailability::Sometimes
44+
) {
45+
output.push_str(&fix_availability.to_string());
4346
output.push('\n');
4447
output.push('\n');
4548
}

crates/ruff_dev/src/generate_rules_table.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use itertools::Itertools;
66
use strum::IntoEnumIterator;
77

8-
use ruff_diagnostics::FixKind;
8+
use ruff_diagnostics::FixAvailability;
99
use ruff_linter::registry::{Linter, Rule, RuleNamespace};
1010
use ruff_linter::upstream_categories::UpstreamCategoryAndPrefix;
1111
use ruff_workspace::options::Options;
@@ -21,10 +21,10 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator<Item = Rule>,
2121
table_out.push('\n');
2222
for rule in rules {
2323
let fix_token = match rule.fixable() {
24-
FixKind::Always | FixKind::Sometimes => {
24+
FixAvailability::Always | FixAvailability::Sometimes => {
2525
format!("<span style='opacity: 1'>{FIX_SYMBOL}</span>")
2626
}
27-
FixKind::None => format!("<span style='opacity: 0.1'>{FIX_SYMBOL}</span>"),
27+
FixAvailability::None => format!("<span style='opacity: 0.1'>{FIX_SYMBOL}</span>"),
2828
};
2929
let preview_token = if rule.is_preview() || rule.is_nursery() {
3030
format!("<span style='opacity: 1'>{PREVIEW_SYMBOL}</span>")

crates/ruff_diagnostics/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ pub use diagnostic::{Diagnostic, DiagnosticKind};
22
pub use edit::Edit;
33
pub use fix::{Applicability, Fix, IsolationLevel};
44
pub use source_map::{SourceMap, SourceMarker};
5-
pub use violation::{AlwaysFixableViolation, FixKind, Violation};
5+
pub use violation::{AlwaysFixableViolation, FixAvailability, Violation};
66

77
mod diagnostic;
88
mod edit;

crates/ruff_diagnostics/src/violation.rs

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
use std::fmt::{Debug, Display};
22

33
#[derive(Debug, Copy, Clone)]
4-
pub enum FixKind {
4+
pub enum FixAvailability {
55
Sometimes,
66
Always,
77
None,
88
}
99

10-
impl Display for FixKind {
10+
impl Display for FixAvailability {
1111
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1212
match self {
13-
FixKind::Sometimes => write!(f, "Fix is sometimes available."),
14-
FixKind::Always => write!(f, "Fix is always available."),
15-
FixKind::None => write!(f, "Fix is not available."),
13+
FixAvailability::Sometimes => write!(f, "Fix is sometimes available."),
14+
FixAvailability::Always => write!(f, "Fix is always available."),
15+
FixAvailability::None => write!(f, "Fix is not available."),
1616
}
1717
}
1818
}
1919

2020
pub trait Violation: Debug + PartialEq + Eq {
2121
/// `None` in the case an fix is never available or otherwise Some
22-
/// [`FixKind`] describing the available fix.
23-
const FIX_KIND: FixKind = FixKind::None;
22+
/// [`FixAvailability`] describing the available fix.
23+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::None;
2424

2525
/// The message used to describe the violation.
2626
fn message(&self) -> String;
@@ -65,7 +65,7 @@ pub trait AlwaysFixableViolation: Debug + PartialEq + Eq {
6565

6666
/// A blanket implementation.
6767
impl<V: AlwaysFixableViolation> Violation for V {
68-
const FIX_KIND: FixKind = FixKind::Always;
68+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always;
6969

7070
fn message(&self) -> String {
7171
<Self as AlwaysFixableViolation>::message(self)

crates/ruff_linter/src/rules/flake8_bugbear/rules/mutable_argument_default.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use ast::call_path::{from_qualified_name, CallPath};
2-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
2+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
33
use ruff_macros::{derive_message_formats, violation};
44
use ruff_python_ast::helpers::is_docstring_stmt;
55
use ruff_python_ast::{self as ast, Expr, Parameter, ParameterWithDefault};
@@ -64,7 +64,7 @@ use crate::registry::AsRule;
6464
pub struct MutableArgumentDefault;
6565

6666
impl Violation for MutableArgumentDefault {
67-
const FIX_KIND: FixKind = FixKind::Sometimes;
67+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
6868

6969
#[derive_message_formats]
7070
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_bugbear/rules/unreliable_callable_check.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use ruff_python_ast::{self as ast, Constant, Expr};
22

3-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
3+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
44
use ruff_macros::{derive_message_formats, violation};
55
use ruff_text_size::Ranged;
66

@@ -37,7 +37,7 @@ use crate::registry::AsRule;
3737
pub struct UnreliableCallableCheck;
3838

3939
impl Violation for UnreliableCallableCheck {
40-
const FIX_KIND: FixKind = FixKind::Sometimes;
40+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
4141

4242
#[derive_message_formats]
4343
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_bugbear/rules/unused_loop_control_variable.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use rustc_hash::FxHashMap;
22

3-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
3+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
44
use ruff_macros::{derive_message_formats, violation};
55
use ruff_python_ast::visitor::Visitor;
66
use ruff_python_ast::{self as ast, Expr};
@@ -56,7 +56,7 @@ pub struct UnusedLoopControlVariable {
5656
}
5757

5858
impl Violation for UnusedLoopControlVariable {
59-
const FIX_KIND: FixKind = FixKind::Sometimes;
59+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
6060

6161
#[derive_message_formats]
6262
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_comprehension_any_all.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use ruff_python_ast::{self as ast, Expr, Keyword};
22

33
use ruff_diagnostics::Violation;
4-
use ruff_diagnostics::{Diagnostic, FixKind};
4+
use ruff_diagnostics::{Diagnostic, FixAvailability};
55
use ruff_macros::{derive_message_formats, violation};
66
use ruff_python_ast::helpers::any_over_expr;
77
use ruff_text_size::Ranged;
@@ -44,7 +44,7 @@ use crate::rules::flake8_comprehensions::fixes;
4444
pub struct UnnecessaryComprehensionAnyAll;
4545

4646
impl Violation for UnnecessaryComprehensionAnyAll {
47-
const FIX_KIND: FixKind = FixKind::Sometimes;
47+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
4848

4949
#[derive_message_formats]
5050
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_map.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use std::fmt;
22

33
use ruff_diagnostics::{Diagnostic, Fix};
4-
use ruff_diagnostics::{FixKind, Violation};
4+
use ruff_diagnostics::{FixAvailability, Violation};
55
use ruff_macros::{derive_message_formats, violation};
66
use ruff_python_ast::visitor;
77
use ruff_python_ast::visitor::Visitor;
@@ -47,7 +47,7 @@ pub struct UnnecessaryMap {
4747
}
4848

4949
impl Violation for UnnecessaryMap {
50-
const FIX_KIND: FixKind = FixKind::Sometimes;
50+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
5151

5252
#[derive_message_formats]
5353
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_errmsg/rules/string_in_exception.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use ruff_python_ast::{self as ast, Arguments, Constant, Expr, ExprContext, Stmt};
22
use ruff_text_size::{Ranged, TextRange};
33

4-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
4+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
55
use ruff_macros::{derive_message_formats, violation};
66
use ruff_python_ast::whitespace;
77
use ruff_python_codegen::{Generator, Stylist};
@@ -50,7 +50,7 @@ use crate::registry::{AsRule, Rule};
5050
pub struct RawStringInException;
5151

5252
impl Violation for RawStringInException {
53-
const FIX_KIND: FixKind = FixKind::Sometimes;
53+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
5454

5555
#[derive_message_formats]
5656
fn message(&self) -> String {
@@ -104,7 +104,7 @@ impl Violation for RawStringInException {
104104
pub struct FStringInException;
105105

106106
impl Violation for FStringInException {
107-
const FIX_KIND: FixKind = FixKind::Sometimes;
107+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
108108

109109
#[derive_message_formats]
110110
fn message(&self) -> String {
@@ -160,7 +160,7 @@ impl Violation for FStringInException {
160160
pub struct DotFormatInException;
161161

162162
impl Violation for DotFormatInException {
163-
const FIX_KIND: FixKind = FixKind::Sometimes;
163+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
164164

165165
#[derive_message_formats]
166166
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_implicit_str_concat/rules/implicit.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use ruff_python_parser::lexer::LexResult;
33
use ruff_python_parser::Tok;
44
use ruff_text_size::{Ranged, TextRange};
55

6-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
6+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
77
use ruff_macros::{derive_message_formats, violation};
88
use ruff_python_ast::str::{leading_quote, trailing_quote};
99
use ruff_python_index::Indexer;
@@ -36,7 +36,7 @@ use crate::rules::flake8_implicit_str_concat::settings::Settings;
3636
pub struct SingleLineImplicitStringConcatenation;
3737

3838
impl Violation for SingleLineImplicitStringConcatenation {
39-
const FIX_KIND: FixKind = FixKind::Sometimes;
39+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
4040

4141
#[derive_message_formats]
4242
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_import_conventions/rules/unconventional_import_alias.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use rustc_hash::FxHashMap;
22

3-
use ruff_diagnostics::{Diagnostic, Fix, FixKind, Violation};
3+
use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation};
44
use ruff_macros::{derive_message_formats, violation};
55
use ruff_python_semantic::{Binding, Imported};
66
use ruff_text_size::Ranged;
@@ -37,7 +37,7 @@ pub struct UnconventionalImportAlias {
3737
}
3838

3939
impl Violation for UnconventionalImportAlias {
40-
const FIX_KIND: FixKind = FixKind::Sometimes;
40+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
4141

4242
#[derive_message_formats]
4343
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_logging/rules/direct_logger_instantiation.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
1+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
22
use ruff_macros::{derive_message_formats, violation};
33
use ruff_python_ast as ast;
44
use ruff_text_size::Ranged;
@@ -41,7 +41,7 @@ use crate::registry::AsRule;
4141
pub struct DirectLoggerInstantiation;
4242

4343
impl Violation for DirectLoggerInstantiation {
44-
const FIX_KIND: FixKind = FixKind::Sometimes;
44+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
4545

4646
#[derive_message_formats]
4747
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_logging/rules/invalid_get_logger_argument.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
1+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
22
use ruff_macros::{derive_message_formats, violation};
33
use ruff_python_ast::{self as ast, Expr};
44
use ruff_text_size::Ranged;
@@ -44,7 +44,7 @@ use crate::registry::AsRule;
4444
pub struct InvalidGetLoggerArgument;
4545

4646
impl Violation for InvalidGetLoggerArgument {
47-
const FIX_KIND: FixKind = FixKind::Sometimes;
47+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
4848

4949
#[derive_message_formats]
5050
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_logging/rules/undocumented_warn.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use ruff_python_ast::Expr;
22

3-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
3+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
44
use ruff_macros::{derive_message_formats, violation};
55
use ruff_text_size::Ranged;
66

@@ -36,7 +36,7 @@ use crate::registry::AsRule;
3636
pub struct UndocumentedWarn;
3737

3838
impl Violation for UndocumentedWarn {
39-
const FIX_KIND: FixKind = FixKind::Sometimes;
39+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
4040
#[derive_message_formats]
4141
fn message(&self) -> String {
4242
format!("Use of undocumented `logging.WARN` constant")

crates/ruff_linter/src/rules/flake8_pie/rules/reimplemented_list_builtin.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use ruff_python_ast::{self as ast, Expr, ExprLambda};
22

33
use ruff_diagnostics::{Diagnostic, Edit, Fix};
4-
use ruff_diagnostics::{FixKind, Violation};
4+
use ruff_diagnostics::{FixAvailability, Violation};
55
use ruff_macros::{derive_message_formats, violation};
66
use ruff_text_size::Ranged;
77

@@ -40,7 +40,7 @@ use crate::registry::AsRule;
4040
pub struct ReimplementedListBuiltin;
4141

4242
impl Violation for ReimplementedListBuiltin {
43-
const FIX_KIND: FixKind = FixKind::Sometimes;
43+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
4444

4545
#[derive_message_formats]
4646
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_union_member.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use std::collections::HashSet;
55
use crate::checkers::ast::Checker;
66
use crate::registry::AsRule;
77
use crate::rules::flake8_pyi::helpers::traverse_union;
8-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
8+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
99
use ruff_macros::{derive_message_formats, violation};
1010
use ruff_python_ast::comparable::ComparableExpr;
1111
use ruff_text_size::Ranged;
@@ -34,7 +34,7 @@ pub struct DuplicateUnionMember {
3434
}
3535

3636
impl Violation for DuplicateUnionMember {
37-
const FIX_KIND: FixKind = FixKind::Sometimes;
37+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
3838

3939
#[derive_message_formats]
4040
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_pyi/rules/ellipsis_in_non_empty_class_body.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use ruff_diagnostics::{Diagnostic, Fix, FixKind, Violation};
1+
use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation};
22
use ruff_macros::{derive_message_formats, violation};
33
use ruff_python_ast::{Constant, Expr, ExprConstant, Stmt, StmtExpr};
44
use ruff_text_size::Ranged;
@@ -31,7 +31,7 @@ use crate::registry::AsRule;
3131
pub struct EllipsisInNonEmptyClassBody;
3232

3333
impl Violation for EllipsisInNonEmptyClassBody {
34-
const FIX_KIND: FixKind = FixKind::Sometimes;
34+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
3535

3636
#[derive_message_formats]
3737
fn message(&self) -> String {

crates/ruff_linter/src/rules/flake8_pyi/rules/exit_annotations.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use ruff_python_ast::{
66
};
77
use smallvec::SmallVec;
88

9-
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixKind, Violation};
9+
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation};
1010
use ruff_macros::{derive_message_formats, violation};
1111
use ruff_python_ast::helpers::is_const_none;
1212
use ruff_python_semantic::SemanticModel;
@@ -49,7 +49,7 @@ pub struct BadExitAnnotation {
4949
}
5050

5151
impl Violation for BadExitAnnotation {
52-
const FIX_KIND: FixKind = FixKind::Sometimes;
52+
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
5353

5454
#[derive_message_formats]
5555
fn message(&self) -> String {

0 commit comments

Comments
 (0)