Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Respect excludes in ruff server configuration discovery #11551

Merged
merged 3 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/ruff_server/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ ruff_workspace = { workspace = true }

anyhow = { workspace = true }
crossbeam = { workspace = true }
globset = { workspace = true }
jod-thread = { workspace = true }
lsp-server = { workspace = true }
lsp-types = { workspace = true }
Expand Down
77 changes: 58 additions & 19 deletions crates/ruff_server/src/session/index/ruff_settings.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
use globset::Candidate;
use ruff_linter::{
display_settings, fs::normalize_path_to, settings::types::FilePattern,
settings::types::PreviewMode,
};
use ruff_workspace::resolver::match_candidate_exclusion;
use ruff_workspace::{
configuration::{Configuration, FormatConfiguration, LintConfiguration, RuleSelection},
pyproject::{find_user_settings_toml, settings_toml},
Expand All @@ -12,12 +14,13 @@ use std::{
path::{Path, PathBuf},
sync::Arc,
};
use walkdir::{DirEntry, WalkDir};
use walkdir::WalkDir;

use crate::session::settings::{ConfigurationPreference, ResolvedEditorSettings};

#[derive(Default)]
pub(crate) struct RuffSettings {
/// Settings used to manage file inclusion and exclusion.
file_resolver: ruff_workspace::FileResolverSettings,
/// Settings to pass into the Ruff linter.
linter: ruff_linter::settings::LinterSettings,
/// Settings to pass into the Ruff formatter.
Expand Down Expand Up @@ -54,7 +57,7 @@ impl RuffSettings {
.ok()
})
.unwrap_or_else(|| {
let default_configuration = ruff_workspace::configuration::Configuration::default();
let default_configuration = Configuration::default();
EditorConfigurationTransformer(editor_settings, root)
.transform(default_configuration)
.into_settings(root)
Expand All @@ -64,6 +67,7 @@ impl RuffSettings {
});

RuffSettings {
file_resolver: fallback.file_resolver,
formatter: fallback.formatter,
linter: fallback.linter,
}
Expand All @@ -85,20 +89,18 @@ impl RuffSettingsIndex {
// Add any settings from above the workspace root.
for directory in root.ancestors() {
if let Some(pyproject) = settings_toml(directory).ok().flatten() {
if index.contains_key(&pyproject) {
continue;
}

let Ok(settings) = ruff_workspace::resolver::resolve_root_settings(
&pyproject,
Relativity::Parent,
&EditorConfigurationTransformer(editor_settings, root),
) else {
continue;
};

index.insert(
directory.to_path_buf(),
Arc::new(RuffSettings {
file_resolver: settings.file_resolver,
linter: settings.linter,
formatter: settings.formatter,
}),
Expand All @@ -107,18 +109,55 @@ impl RuffSettingsIndex {
}
}

// Add any settings within the workspace itself.
for directory in WalkDir::new(root)
.into_iter()
.filter_map(Result::ok)
.filter(|entry| entry.file_type().is_dir())
.map(DirEntry::into_path)
{
if let Some(pyproject) = settings_toml(&directory).ok().flatten() {
if index.contains_key(&pyproject) {
continue;
// Add any settings within the workspace itself
let mut walker = WalkDir::new(root).into_iter();

while let Some(entry) = walker.next() {
let Ok(entry) = entry else {
continue;
};

// Skip non-directories.
if !entry.file_type().is_dir() {
continue;
}

let directory = entry.into_path();

// If the directory is excluded from the workspace, skip it.
if let Some(file_name) = directory.file_name() {
if let Some((_, settings)) = index
.range(..directory.clone())
.rfind(|(path, _)| directory.starts_with(path))
{
let candidate = Candidate::new(&directory);
let basename = Candidate::new(file_name);
if match_candidate_exclusion(
&candidate,
&basename,
&settings.file_resolver.exclude,
) {
tracing::debug!("Ignored path via `exclude`: {}", directory.display());

walker.skip_current_dir();
continue;
} else if match_candidate_exclusion(
&candidate,
&basename,
&settings.file_resolver.extend_exclude,
) {
tracing::debug!(
"Ignored path via `extend-exclude`: {}",
directory.display()
);

walker.skip_current_dir();
continue;
}
}
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is loosely drawn from python_files_in_path.


if let Some(pyproject) = settings_toml(&directory).ok().flatten() {
let Ok(settings) = ruff_workspace::resolver::resolve_root_settings(
&pyproject,
Relativity::Parent,
Expand All @@ -129,6 +168,7 @@ impl RuffSettingsIndex {
index.insert(
directory,
Arc::new(RuffSettings {
file_resolver: settings.file_resolver,
linter: settings.linter,
formatter: settings.formatter,
}),
Expand All @@ -145,8 +185,7 @@ impl RuffSettingsIndex {
if let Some((_, settings)) = self
.index
.range(..document_path.to_path_buf())
.rev()
.find(|(path, _)| document_path.starts_with(path))
.rfind(|(path, _)| document_path.starts_with(path))
{
return settings.clone();
}
Expand Down
Loading