mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-30 22:01:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

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

2
crates/ruff_diagnostics/src/lib.rs
View file

@ -2,7 +2,7 @@ pub use diagnostic::{Diagnostic, DiagnosticKind};
pub use edit::Edit;
pub use fix::{Applicability, Fix, IsolationLevel};
pub use source_map::{SourceMap, SourceMarker};
pub use violation::{AlwaysFixableViolation, FixKind, Violation};
pub use violation::{AlwaysFixableViolation, FixAvailability, Violation};
mod diagnostic;
mod edit;

16
crates/ruff_diagnostics/src/violation.rs
View file

@ -1,26 +1,26 @@
use std::fmt::{Debug, Display};
#[derive(Debug, Copy, Clone)]
pub enum FixKind {
pub enum FixAvailability {
Sometimes,
Always,
None,
}
impl Display for FixKind {
impl Display for FixAvailability {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
FixKind::Sometimes => write!(f, "Fix is sometimes available."),
FixKind::Always => write!(f, "Fix is always available."),
FixKind::None => write!(f, "Fix is not available."),
FixAvailability::Sometimes => write!(f, "Fix is sometimes available."),
FixAvailability::Always => write!(f, "Fix is always available."),
FixAvailability::None => write!(f, "Fix is not available."),
}
}
}
pub trait Violation: Debug + PartialEq + Eq {
/// `None` in the case an fix is never available or otherwise Some
/// [`FixKind`] describing the available fix.
const FIX_KIND: FixKind = FixKind::None;
/// [`FixAvailability`] describing the available fix.
const FIX_AVAILABILITY: FixAvailability = FixAvailability::None;
/// The message used to describe the violation.
fn message(&self) -> String;
@ -65,7 +65,7 @@ pub trait AlwaysFixableViolation: Debug + PartialEq + Eq {
/// A blanket implementation.
impl<V: AlwaysFixableViolation> Violation for V {
const FIX_KIND: FixKind = FixKind::Always;
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always;
fn message(&self) -> String {
<Self as AlwaysFixableViolation>::message(self)