Rename run.rs command to check.rs (#6980)

The CLI command is called "check", so this is more consistent (and
consistent with the pattern used in other commands).
This commit is contained in:
Charlie Marsh 2023-08-29 11:52:06 -04:00 committed by GitHub
parent 924f10186f
commit 34221346c1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 12 additions and 12 deletions

View file

@ -28,7 +28,7 @@ use crate::diagnostics::Diagnostics;
use crate::panic::catch_unwind; use crate::panic::catch_unwind;
/// Run the linter over a collection of files. /// Run the linter over a collection of files.
pub(crate) fn run( pub(crate) fn check(
files: &[PathBuf], files: &[PathBuf],
pyproject_config: &PyprojectConfig, pyproject_config: &PyprojectConfig,
overrides: &Overrides, overrides: &Overrides,
@ -245,7 +245,7 @@ mod test {
use crate::args::Overrides; use crate::args::Overrides;
use super::run; use super::check;
/// We check that regular python files, pyproject.toml and jupyter notebooks all handle io /// We check that regular python files, pyproject.toml and jupyter notebooks all handle io
/// errors gracefully /// errors gracefully
@ -278,7 +278,7 @@ mod test {
PyprojectConfig::new(PyprojectDiscoveryStrategy::Fixed, settings, None); PyprojectConfig::new(PyprojectDiscoveryStrategy::Fixed, settings, None);
// Run // Run
let diagnostics = run( let diagnostics = check(
// Notebooks are not included by default // Notebooks are not included by default
&[tempdir.path().to_path_buf(), notebook], &[tempdir.path().to_path_buf(), notebook],
&pyproject_config, &pyproject_config,

View file

@ -18,7 +18,7 @@ pub(crate) fn read_from_stdin() -> Result<String> {
} }
/// Run the linter over a single file, read from `stdin`. /// Run the linter over a single file, read from `stdin`.
pub(crate) fn run_stdin( pub(crate) fn check_stdin(
filename: Option<&Path>, filename: Option<&Path>,
pyproject_config: &PyprojectConfig, pyproject_config: &PyprojectConfig,
overrides: &Overrides, overrides: &Overrides,

View file

@ -1,10 +1,10 @@
pub(crate) mod add_noqa; pub(crate) mod add_noqa;
pub(crate) mod check;
pub(crate) mod check_stdin;
pub(crate) mod clean; pub(crate) mod clean;
pub(crate) mod config; pub(crate) mod config;
pub(crate) mod format; pub(crate) mod format;
pub(crate) mod linter; pub(crate) mod linter;
pub(crate) mod rule; pub(crate) mod rule;
pub(crate) mod run;
pub(crate) mod run_stdin;
pub(crate) mod show_files; pub(crate) mod show_files;
pub(crate) mod show_settings; pub(crate) mod show_settings;

View file

@ -1,5 +1,5 @@
--- ---
source: crates/ruff_cli/src/commands/run.rs source: crates/ruff_cli/src/commands/check.rs
--- ---
/home/ferris/project/code.py:1:1: E902 Permission denied (os error 13) /home/ferris/project/code.py:1:1: E902 Permission denied (os error 13)
/home/ferris/project/notebook.ipynb:1:1: E902 Permission denied (os error 13) /home/ferris/project/notebook.ipynb:1:1: E902 Permission denied (os error 13)

View file

@ -16,7 +16,7 @@ use ruff::{fs, warn_user_once};
use ruff_python_formatter::{format_module, PyFormatOptions}; use ruff_python_formatter::{format_module, PyFormatOptions};
use crate::args::{Args, CheckCommand, Command, FormatCommand}; use crate::args::{Args, CheckCommand, Command, FormatCommand};
use crate::commands::run_stdin::read_from_stdin; use crate::commands::check_stdin::read_from_stdin;
use crate::printer::{Flags as PrinterFlags, Printer}; use crate::printer::{Flags as PrinterFlags, Printer};
pub mod args; pub mod args;
@ -300,7 +300,7 @@ pub fn check(args: CheckCommand, log_level: LogLevel) -> Result<ExitStatus> {
Printer::clear_screen()?; Printer::clear_screen()?;
printer.write_to_user("Starting linter in watch mode...\n"); printer.write_to_user("Starting linter in watch mode...\n");
let messages = commands::run::run( let messages = commands::check::check(
&cli.files, &cli.files,
&pyproject_config, &pyproject_config,
&overrides, &overrides,
@ -332,7 +332,7 @@ pub fn check(args: CheckCommand, log_level: LogLevel) -> Result<ExitStatus> {
Printer::clear_screen()?; Printer::clear_screen()?;
printer.write_to_user("File change detected...\n"); printer.write_to_user("File change detected...\n");
let messages = commands::run::run( let messages = commands::check::check(
&cli.files, &cli.files,
&pyproject_config, &pyproject_config,
&overrides, &overrides,
@ -350,7 +350,7 @@ pub fn check(args: CheckCommand, log_level: LogLevel) -> Result<ExitStatus> {
// Generate lint violations. // Generate lint violations.
let diagnostics = if is_stdin { let diagnostics = if is_stdin {
commands::run_stdin::run_stdin( commands::check_stdin::check_stdin(
cli.stdin_filename.map(fs::normalize_path).as_deref(), cli.stdin_filename.map(fs::normalize_path).as_deref(),
&pyproject_config, &pyproject_config,
&overrides, &overrides,
@ -358,7 +358,7 @@ pub fn check(args: CheckCommand, log_level: LogLevel) -> Result<ExitStatus> {
autofix, autofix,
)? )?
} else { } else {
commands::run::run( commands::check::check(
&cli.files, &cli.files,
&pyproject_config, &pyproject_config,
&overrides, &overrides,