Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Automatically update README.md from generate_rules_table.rs (#606)
- Loading branch information
1 parent
c48c766
commit 2e1799d
Showing
3 changed files
with
103 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,81 @@ | ||
| //! Generate a Markdown-compatible table of supported lint rules. | ||
| use std::fs; | ||
| use std::fs::OpenOptions; | ||
| use std::io::Write; | ||
|
|
||
| use anyhow::Result; | ||
| use clap::Parser; | ||
| use ruff::checks::{CheckCategory, CheckCode}; | ||
| use strum::IntoEnumIterator; | ||
|
|
||
| fn main() { | ||
| const FILE: &str = "README.md"; | ||
| const BEGIN_PRAGMA: &str = "<!-- Begin auto-generated sections. -->"; | ||
| const END_PRAGMA: &str = "<!-- End auto-generated sections. -->"; | ||
|
|
||
| #[derive(Parser)] | ||
| #[command(author, version, about, long_about = None)] | ||
| /// Generate a Markdown-compatible table of supported lint rules. | ||
| struct Cli { | ||
| /// Write the generated table to stdout (rather than to `README.md`). | ||
| #[arg(long)] | ||
| dry_run: bool, | ||
| } | ||
|
|
||
| fn main() -> Result<()> { | ||
| let cli = Cli::parse(); | ||
|
|
||
| // Generate the table string. | ||
| let mut output = String::new(); | ||
| for check_category in CheckCategory::iter() { | ||
| println!("### {}", check_category.title()); | ||
| println!(); | ||
| output.push_str(&format!("### {}", check_category.title())); | ||
| output.push('\n'); | ||
| output.push('\n'); | ||
|
|
||
| output.push_str("| Coade | Name | Message | Fix |"); | ||
| output.push('\n'); | ||
| output.push_str("| ---- | ---- | ------- | --- |"); | ||
| output.push('\n'); | ||
|
|
||
| println!("| Code | Name | Message | Fix |"); | ||
| println!("| ---- | ---- | ------- | --- |"); | ||
| for check_code in CheckCode::iter() { | ||
| if check_code.category() == check_category { | ||
| let check_kind = check_code.kind(); | ||
| let fix_token = if check_kind.fixable() { "🛠" } else { "" }; | ||
| println!( | ||
| output.push_str(&format!( | ||
| "| {} | {} | {} | {} |", | ||
| check_kind.code().as_ref(), | ||
| check_kind.as_ref(), | ||
| check_kind.summary().replace("|", r"\|"), | ||
| fix_token | ||
| ); | ||
| )); | ||
| output.push('\n'); | ||
| } | ||
| } | ||
| println!(); | ||
| output.push('\n'); | ||
| } | ||
|
|
||
| if cli.dry_run { | ||
| print!("{}", output); | ||
| } else { | ||
| // Read the existing file. | ||
| let existing = fs::read_to_string(FILE)?; | ||
|
|
||
| // Extract the prefix. | ||
| let index = existing | ||
| .find(BEGIN_PRAGMA) | ||
| .expect("Unable to find begin pragma."); | ||
| let prefix = &existing[..index + BEGIN_PRAGMA.len()]; | ||
|
|
||
| // Extract the suffix. | ||
| let index = existing | ||
| .find(END_PRAGMA) | ||
| .expect("Unable to find end pragma."); | ||
| let suffix = &existing[index..]; | ||
|
|
||
| // Write the prefix, new contents, and suffix. | ||
| let mut f = OpenOptions::new().write(true).truncate(true).open(FILE)?; | ||
| write!(f, "{}\n\n", prefix)?; | ||
| write!(f, "{}", output)?; | ||
| write!(f, "{}", suffix)?; | ||
| } | ||
|
|
||
| Ok(()) | ||
| } |