16e79c8db6
The idea is nice and simple we replace:
fn placeholder() -> Self;
with
fn message_formats() -> &'static [&'static str];
So e.g. if a Violation implementation defines:
fn message(&self) -> String {
format!("Local variable `{name}` is assigned to but never used")
}
it would also have to define:
fn message_formats() -> &'static [&'static str] {
&["Local variable `{name}` is assigned to but never used"]
}
Since we however obviously do not want to duplicate all of our format
strings we simply introduce a new procedural macro attribute
#[derive_message_formats] that can be added to the message method
declaration in order to automatically derive the message_formats
implementation.
This commit implements the macro. The following and final commit
updates violations.rs to use the macro. (The changes have been separated
because the next commit is autogenerated via a Python script.)
111 lines
3.6 KiB
Rust
111 lines
3.6 KiB
Rust
//! Generate a Markdown-compatible table of supported lint rules.
|
|
|
|
use anyhow::Result;
|
|
use clap::Args;
|
|
use ruff::registry::{Prefixes, RuleCodePrefix, RuleOrigin};
|
|
use strum::IntoEnumIterator;
|
|
|
|
use crate::utils::replace_readme_section;
|
|
|
|
const TABLE_BEGIN_PRAGMA: &str = "<!-- Begin auto-generated sections. -->";
|
|
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. -->";
|
|
|
|
#[derive(Args)]
|
|
pub struct Cli {
|
|
/// Write the generated table to stdout (rather than to `README.md`).
|
|
#[arg(long)]
|
|
pub(crate) dry_run: bool,
|
|
}
|
|
|
|
fn generate_table(table_out: &mut String, prefix: &RuleCodePrefix) {
|
|
table_out.push_str("| Code | Name | Message | Fix |");
|
|
table_out.push('\n');
|
|
table_out.push_str("| ---- | ---- | ------- | --- |");
|
|
table_out.push('\n');
|
|
for rule in prefix.codes() {
|
|
let fix_token = match rule.autofixable() {
|
|
None => "",
|
|
Some(_) => "🛠",
|
|
};
|
|
|
|
table_out.push_str(&format!(
|
|
"| {} | {} | {} | {} |",
|
|
rule.code(),
|
|
rule.as_ref(),
|
|
rule.message_formats()[0].replace('|', r"\|"),
|
|
fix_token
|
|
));
|
|
table_out.push('\n');
|
|
}
|
|
table_out.push('\n');
|
|
}
|
|
|
|
pub fn main(cli: &Cli) -> Result<()> {
|
|
// Generate the table string.
|
|
let mut table_out = String::new();
|
|
let mut toc_out = String::new();
|
|
for origin in RuleOrigin::iter() {
|
|
let prefixes = origin.prefixes();
|
|
let codes_csv: String = prefixes.as_list(", ");
|
|
table_out.push_str(&format!("### {} ({codes_csv})", origin.name()));
|
|
table_out.push('\n');
|
|
table_out.push('\n');
|
|
|
|
toc_out.push_str(&format!(
|
|
" 1. [{} ({})](#{}-{})\n",
|
|
origin.name(),
|
|
codes_csv,
|
|
origin.name().to_lowercase().replace(' ', "-"),
|
|
codes_csv.to_lowercase().replace(',', "-").replace(' ', "")
|
|
));
|
|
|
|
if let Some(url) = origin.url() {
|
|
let host = url
|
|
.trim_start_matches("https://")
|
|
.split('/')
|
|
.next()
|
|
.unwrap();
|
|
table_out.push_str(&format!(
|
|
"For more, see [{}]({}) on {}.",
|
|
origin.name(),
|
|
url,
|
|
match host {
|
|
"pypi.org" => "PyPI",
|
|
"github.com" => "GitHub",
|
|
host => panic!(
|
|
"unexpected host in URL of {}, expected pypi.org or github.com but found \
|
|
{host}",
|
|
origin.name()
|
|
),
|
|
}
|
|
));
|
|
table_out.push('\n');
|
|
table_out.push('\n');
|
|
}
|
|
|
|
match prefixes {
|
|
Prefixes::Single(prefix) => generate_table(&mut table_out, &prefix),
|
|
Prefixes::Multiple(entries) => {
|
|
for (prefix, category) in entries {
|
|
table_out.push_str(&format!("#### {category} ({})", prefix.as_ref()));
|
|
table_out.push('\n');
|
|
generate_table(&mut table_out, &prefix);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if cli.dry_run {
|
|
print!("Table of Contents: {toc_out}\n Rules Tables: {table_out}");
|
|
} else {
|
|
// Extra newline in the markdown numbered list looks weird
|
|
replace_readme_section(toc_out.trim_end(), TOC_BEGIN_PRAGMA, TOC_END_PRAGMA)?;
|
|
replace_readme_section(&table_out, TABLE_BEGIN_PRAGMA, TABLE_END_PRAGMA)?;
|
|
}
|
|
|
|
Ok(())
|
|
}
|