mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-27 04:19:18 +00:00
8118d29419
## Summary Long ago, we had a single `ruff` crate. We started to break that up, and at some point, we wanted to separate the CLI from the core library. So we created `ruff_cli`, which created a `ruff` binary. Later, the `ruff` crate was renamed to `ruff_linter` and further broken up into additional crates. (This is all from memory -- I didn't bother to look through the history to ensure that this is 100% correct :)) Now that `ruff` no longer exists, this PR renames `ruff_cli` to `ruff`. The primary benefit is that the binary target and the crate name are now the same, which helps with downstream tooling like `cargo-dist`, and also removes some complexity from the crate and `Cargo.toml` itself. ## Test Plan - Ran `rm -rf target/release`. - Ran `cargo build --release`. - Verified that `./target/release/ruff` was created.
108 lines
3.9 KiB
Rust
108 lines
3.9 KiB
Rust
//! This crate implements an internal CLI for developers of Ruff.
|
|
//!
|
|
//! Within the ruff repository you can run it with `cargo dev`.
|
|
|
|
use anyhow::Result;
|
|
use clap::{Parser, Subcommand};
|
|
use ruff::check;
|
|
use ruff_linter::logging::{set_up_logging, LogLevel};
|
|
use std::process::ExitCode;
|
|
|
|
mod format_dev;
|
|
mod generate_all;
|
|
mod generate_cli_help;
|
|
mod generate_docs;
|
|
mod generate_json_schema;
|
|
mod generate_options;
|
|
mod generate_rules_table;
|
|
mod print_ast;
|
|
mod print_cst;
|
|
mod print_tokens;
|
|
mod round_trip;
|
|
|
|
const ROOT_DIR: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/../../");
|
|
|
|
#[derive(Parser)]
|
|
#[command(author, version, about, long_about = None)]
|
|
#[command(propagate_version = true)]
|
|
struct Args {
|
|
#[command(subcommand)]
|
|
command: Command,
|
|
}
|
|
|
|
#[derive(Subcommand)]
|
|
#[allow(clippy::large_enum_variant)]
|
|
enum Command {
|
|
/// Run all code and documentation generation steps.
|
|
GenerateAll(generate_all::Args),
|
|
/// Generate JSON schema for the TOML configuration file.
|
|
GenerateJSONSchema(generate_json_schema::Args),
|
|
/// Generate a Markdown-compatible table of supported lint rules.
|
|
GenerateRulesTable,
|
|
/// Generate a Markdown-compatible listing of configuration options.
|
|
GenerateOptions,
|
|
/// Generate CLI help.
|
|
GenerateCliHelp(generate_cli_help::Args),
|
|
/// Generate Markdown docs.
|
|
GenerateDocs(generate_docs::Args),
|
|
/// Print the AST for a given Python file.
|
|
PrintAST(print_ast::Args),
|
|
/// Print the LibCST CST for a given Python file.
|
|
PrintCST(print_cst::Args),
|
|
/// Print the token stream for a given Python file.
|
|
PrintTokens(print_tokens::Args),
|
|
/// Run round-trip source code generation on a given Python file.
|
|
RoundTrip(round_trip::Args),
|
|
/// Run a ruff command n times for profiling/benchmarking
|
|
Repeat {
|
|
#[clap(flatten)]
|
|
args: ruff::args::CheckCommand,
|
|
#[clap(flatten)]
|
|
log_level_args: ruff::args::LogLevelArgs,
|
|
/// Run this many times
|
|
#[clap(long)]
|
|
repeat: usize,
|
|
},
|
|
/// Several utils related to the formatter which can be run on one or more repositories. The
|
|
/// selected set of files in a repository is the same as for `ruff check`.
|
|
///
|
|
/// * Check formatter stability: Format a repository twice and ensure that it looks that the
|
|
/// first and second formatting look the same.
|
|
/// * Format: Format the files in a repository to be able to check them with `git diff`
|
|
/// * Statistics: The subcommand the Jaccard index between the (assumed to be black formatted)
|
|
/// input and the ruff formatted output
|
|
FormatDev(format_dev::Args),
|
|
}
|
|
|
|
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)?,
|
|
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::Repeat {
|
|
args,
|
|
repeat,
|
|
log_level_args,
|
|
} => {
|
|
let log_level = LogLevel::from(&log_level_args);
|
|
set_up_logging(&log_level)?;
|
|
for _ in 0..repeat {
|
|
check(args.clone(), log_level)?;
|
|
}
|
|
}
|
|
Command::FormatDev(args) => {
|
|
let exit_code = format_dev::main(&args)?;
|
|
return Ok(exit_code);
|
|
}
|
|
}
|
|
Ok(ExitCode::SUCCESS)
|
|
}
|