mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-27 20:42:10 +00:00
b8d378b0a3
## 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)
94 lines
3.6 KiB
Rust
94 lines
3.6 KiB
Rust
use std::path::{Path, PathBuf};
|
|
|
|
use anyhow::Result;
|
|
use path_absolutize::path_dedot;
|
|
|
|
use ruff::resolver::{
|
|
resolve_settings_with_processor, ConfigProcessor, PyprojectConfig, PyprojectDiscoveryStrategy,
|
|
Relativity,
|
|
};
|
|
use ruff::settings::configuration::Configuration;
|
|
use ruff::settings::{pyproject, AllSettings};
|
|
|
|
use crate::args::Overrides;
|
|
|
|
/// Resolve the relevant settings strategy and defaults for the current
|
|
/// invocation.
|
|
pub fn resolve(
|
|
isolated: bool,
|
|
config: Option<&Path>,
|
|
overrides: &Overrides,
|
|
stdin_filename: Option<&Path>,
|
|
) -> Result<PyprojectConfig> {
|
|
// First priority: if we're running in isolated mode, use the default settings.
|
|
if isolated {
|
|
let mut config = Configuration::default();
|
|
overrides.process_config(&mut config);
|
|
let settings = AllSettings::from_configuration(config, &path_dedot::CWD)?;
|
|
return Ok(PyprojectConfig::new(
|
|
PyprojectDiscoveryStrategy::Fixed,
|
|
settings,
|
|
None,
|
|
));
|
|
}
|
|
|
|
// Second priority: the user specified a `pyproject.toml` file. Use that
|
|
// `pyproject.toml` for _all_ configuration, and resolve paths relative to the
|
|
// current working directory. (This matches ESLint's behavior.)
|
|
if let Some(pyproject) = config
|
|
.map(|config| config.display().to_string())
|
|
.map(|config| shellexpand::full(&config).map(|config| PathBuf::from(config.as_ref())))
|
|
.transpose()?
|
|
{
|
|
let settings = resolve_settings_with_processor(&pyproject, &Relativity::Cwd, overrides)?;
|
|
return Ok(PyprojectConfig::new(
|
|
PyprojectDiscoveryStrategy::Fixed,
|
|
settings,
|
|
Some(pyproject),
|
|
));
|
|
}
|
|
|
|
// Third priority: find a `pyproject.toml` file in either an ancestor of
|
|
// `stdin_filename` (if set) or the current working path all paths relative to
|
|
// that directory. (With `Strategy::Hierarchical`, we'll end up finding
|
|
// the "closest" `pyproject.toml` file for every Python file later on,
|
|
// so these act as the "default" settings.)
|
|
if let Some(pyproject) = pyproject::find_settings_toml(
|
|
stdin_filename
|
|
.as_ref()
|
|
.unwrap_or(&path_dedot::CWD.as_path()),
|
|
)? {
|
|
let settings = resolve_settings_with_processor(&pyproject, &Relativity::Parent, overrides)?;
|
|
return Ok(PyprojectConfig::new(
|
|
PyprojectDiscoveryStrategy::Hierarchical,
|
|
settings,
|
|
Some(pyproject),
|
|
));
|
|
}
|
|
|
|
// Fourth priority: find a user-specific `pyproject.toml`, but resolve all paths
|
|
// relative the current working directory. (With `Strategy::Hierarchical`, we'll
|
|
// end up the "closest" `pyproject.toml` file for every Python file later on, so
|
|
// these act as the "default" settings.)
|
|
if let Some(pyproject) = pyproject::find_user_settings_toml() {
|
|
let settings = resolve_settings_with_processor(&pyproject, &Relativity::Cwd, overrides)?;
|
|
return Ok(PyprojectConfig::new(
|
|
PyprojectDiscoveryStrategy::Hierarchical,
|
|
settings,
|
|
Some(pyproject),
|
|
));
|
|
}
|
|
|
|
// Fallback: load Ruff's default settings, and resolve all paths relative to the
|
|
// current working directory. (With `Strategy::Hierarchical`, we'll end up the
|
|
// "closest" `pyproject.toml` file for every Python file later on, so these act
|
|
// as the "default" settings.)
|
|
let mut config = Configuration::default();
|
|
overrides.process_config(&mut config);
|
|
let settings = AllSettings::from_configuration(config, &path_dedot::CWD)?;
|
|
Ok(PyprojectConfig::new(
|
|
PyprojectDiscoveryStrategy::Hierarchical,
|
|
settings,
|
|
None,
|
|
))
|
|
}
|