language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-28 04:45:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add a script that tests formatter stability on repositories (#5055)

Browse source 
## Summary

We want to ensure that once formatted content stays the same when
formatted again, which is known as formatter stability or formatter
idempotency, and that the formatter prints syntactically valid code. As
our test cases cover only a limited amount of code, this allows checking
entire repositories.

This adds a new subcommand to `ruff_dev` which can be invoked as `cargo
run --bin ruff_dev -- check-formatter-stability <repo>`. While initially
only intended to check stability, it has also found cases where the
formatter printed invalid syntax or panicked.

 ## Test Plan

Running this on cpython is already identifying bugs
(https://github.com/astral-sh/ruff/pull/5089)
This commit is contained in:
konstin 2023-06-19 16:13:38 +02:00 • committed by GitHub
parent 0e028142f4
commit b8d378b0a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 309 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

35
crates/ruff_dev/src/main.rs
View file

@ -6,7 +6,9 @@ use anyhow::Result;
use clap::{Parser, Subcommand};
use ruff::logging::{set_up_logging, LogLevel};
use ruff_cli::check;
use std::process::ExitCode;
mod check_formatter_stability;
mod generate_all;
mod generate_cli_help;
mod generate_docs;
@ -61,33 +63,40 @@ enum Command {
#[clap(long, short = 'n')]
repeat: usize,
},
/// Format a repository twice and ensure that it looks that the first and second formatting
/// look the same. Same arguments as `ruff check`
CheckFormatterStability(check_formatter_stability::Args),
}
fn main() -> Result<()> {
fn main() -> Result<ExitCode> {
let args = Args::parse();
#[allow(clippy::print_stdout)]
match &args.command {
Command::GenerateAll(args) => generate_all::main(args)?,
Command::GenerateJSONSchema(args) => generate_json_schema::main(args)?,
match args.command {
Command::GenerateAll(args) => generate_all::main(&args)?,
Command::GenerateJSONSchema(args) => generate_json_schema::main(&args)?,
Command::GenerateRulesTable => println!("{}", generate_rules_table::generate()),
Command::GenerateOptions => println!("{}", generate_options::generate()),
Command::GenerateCliHelp(args) => generate_cli_help::main(args)?,
Command::GenerateDocs(args) => generate_docs::main(args)?,
Command::PrintAST(args) => print_ast::main(args)?,
Command::PrintCST(args) => print_cst::main(args)?,
Command::PrintTokens(args) => print_tokens::main(args)?,
Command::RoundTrip(args) => round_trip::main(args)?,
Command::GenerateCliHelp(args) => generate_cli_help::main(&args)?,
Command::GenerateDocs(args) => generate_docs::main(&args)?,
Command::PrintAST(args) => print_ast::main(&args)?,
Command::PrintCST(args) => print_cst::main(&args)?,
Command::PrintTokens(args) => print_tokens::main(&args)?,
Command::RoundTrip(args) => round_trip::main(&args)?,
Command::Repeat {
args,
repeat,
log_level_args,
} => {
let log_level = LogLevel::from(log_level_args);
let log_level = LogLevel::from(&log_level_args);
set_up_logging(&log_level)?;
for _ in 0..*repeat {
for _ in 0..repeat {
check(args.clone(), log_level)?;
}
}
Command::CheckFormatterStability(args) => {
let exit_code = check_formatter_stability::main(&args)?;
return Ok(exit_code);
}
}
Ok(())
Ok(ExitCode::SUCCESS)
}