Python/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff synced 2026-01-20 21:10:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Create per-rule pages and link from README (#2644)

Browse Source
This commit is contained in:
Charlie Marsh
2023-02-07 18:15:05 -05:00
committed by GitHub
parent f1cdd108e6
commit 271e4fda8c
17 changed files with 156 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
crates/ruff_cli/src/commands.rs
View File

@@ -278,25 +278,31 @@ pub fn rule(rule: &Rule, format: HelpFormat) -> Result<()> {
let mut stdout = BufWriter::new(io::stdout().lock());
match format {
HelpFormat::Text => {
writeln!(stdout, "{}\n", rule.as_ref())?;
writeln!(stdout, "Code: {} ({})\n", rule.code(), linter.name())?;
writeln!(
stdout,
"[{}] {} ({})",
linter.name(),
rule.as_ref(),
rule.code(),
)?;
writeln!(stdout)?;
if let Some(explanation) = rule.explanation() {
writeln!(stdout, "{}\n", explanation)?;
writeln!(stdout, "{}", explanation.trim())?;
} else {
writeln!(stdout, "Message formats:\n")?;
writeln!(stdout, "Message formats:")?;
for format in rule.message_formats() {
writeln!(stdout, "* {format}")?;
}
}
if let Some(autofix) = rule.autofixable() {
writeln!(stdout)?;
writeln!(
stdout,
"{}",
match autofix.available {
AutofixAvailability::Sometimes => "Autofix is sometimes available.\n",
AutofixAvailability::Always => "Autofix is always available.\n",
AutofixAvailability::Sometimes => "Autofix is sometimes available.",
AutofixAvailability::Always => "Autofix is always available.",
}
)?;
}