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

fix(project): correctly ignore folders #2147

Merged
merged 4 commits into from
Mar 21, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ our [guidelines for writing a good changelog entry](https://github.com/biomejs/b

### CLI

#### Bug fixes

- Fixes [#2131](https://github.com/biomejs/biome/issues/2131), where folders were incorrectly ignored when running the command `check`. Now folders are correctly ignored based on their command. Contributed by @ematipico

### Configuration

#### Bug fixes
Expand Down
14 changes: 10 additions & 4 deletions crates/biome_cli/src/execute/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use crate::execute::traverse::traverse;
use crate::{CliDiagnostic, CliSession};
use biome_diagnostics::{category, Category};
use biome_fs::BiomePath;
use biome_service::workspace::{FeatureName, FixFileMode};
use biome_service::workspace::{FeatureName, FeaturesBuilder, FixFileMode};
use std::ffi::OsString;
use std::fmt::{Display, Formatter};
use std::path::{Path, PathBuf};
Expand All @@ -28,10 +28,16 @@ pub(crate) struct Execution {
}

impl Execution {
pub(crate) fn as_feature_name(&self) -> FeatureName {
pub(crate) fn to_features(&self) -> Vec<FeatureName> {
match self.traversal_mode {
TraversalMode::Format { .. } => FeatureName::Format,
_ => FeatureName::Lint,
TraversalMode::Format { .. } => FeaturesBuilder::new().with_formatter().build(),
TraversalMode::Lint { .. } => FeaturesBuilder::new().with_linter().build(),
TraversalMode::Check { .. } | TraversalMode::CI { .. } => FeaturesBuilder::new()
.with_organize_imports()
.with_formatter()
.with_linter()
.build(),
TraversalMode::Migrate { .. } => vec![],
Copy link
Member Author

Choose a reason for hiding this comment

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

Migrate should never reach this code path.

}
}
}
Expand Down
8 changes: 2 additions & 6 deletions crates/biome_cli/src/execute/process_file.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use crate::execute::traverse::TraversalOptions;
use crate::execute::TraversalMode;
use biome_diagnostics::{category, DiagnosticExt, DiagnosticTags, Error};
use biome_fs::BiomePath;
use biome_service::workspace::{FeatureName, FeaturesBuilder, SupportKind, SupportsFeatureParams};
use biome_service::workspace::{FeatureName, SupportKind, SupportsFeatureParams};
use std::marker::PhantomData;
use std::ops::Deref;
use std::path::Path;
Expand Down Expand Up @@ -132,11 +132,7 @@ pub(crate) fn process_file(ctx: &TraversalOptions, path: &Path) -> FileResult {
.workspace
.file_features(SupportsFeatureParams {
path: biome_path,
feature: FeaturesBuilder::new()
.with_formatter()
.with_linter()
.with_organize_imports()
.build(),
feature: ctx.execution.to_features(),
})
.with_file_path_and_code_and_tags(
path.display().to_string(),
Expand Down
10 changes: 3 additions & 7 deletions crates/biome_cli/src/execute/traverse.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use biome_diagnostics::PrintGitHubDiagnostic;
use biome_diagnostics::{category, DiagnosticExt, Error, PrintDiagnostic, Resource, Severity};
use biome_fs::{BiomePath, FileSystem, PathInterner};
use biome_fs::{TraversalContext, TraversalScope};
use biome_service::workspace::{FeaturesBuilder, IsPathIgnoredParams};
use biome_service::workspace::IsPathIgnoredParams;
use biome_service::{extension_error, workspace::SupportsFeatureParams, Workspace, WorkspaceError};
use crossbeam::channel::{unbounded, Receiver, Sender};
use rustc_hash::FxHashSet;
Expand Down Expand Up @@ -702,7 +702,7 @@ impl<'ctx, 'app> TraversalContext for TraversalOptions<'ctx, 'app> {
.workspace
.is_path_ignored(IsPathIgnoredParams {
biome_path: biome_path.clone(),
feature: self.execution.as_feature_name(),
features: self.execution.to_features(),
})
.unwrap_or_else(|err| {
self.push_diagnostic(err.into());
Expand All @@ -713,11 +713,7 @@ impl<'ctx, 'app> TraversalContext for TraversalOptions<'ctx, 'app> {

let file_features = self.workspace.file_features(SupportsFeatureParams {
path: biome_path.clone(),
feature: FeaturesBuilder::new()
.with_linter()
.with_formatter()
.with_organize_imports()
.build(),
feature: self.execution.to_features(),
ematipico marked this conversation as resolved.
Show resolved Hide resolved
});

let file_features = match file_features {
Expand Down
49 changes: 49 additions & 0 deletions crates/biome_cli/tests/commands/check.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2797,3 +2797,52 @@ fn use_literal_keys_should_emit_correct_ast_issue_266() {
result,
));
}

#[test]
fn should_show_diagnostics_for_formatter_when_linter_ignores_folder() {
ematipico marked this conversation as resolved.
Show resolved Hide resolved
let mut fs = MemoryFileSystem::default();
let mut console = BufferConsole::default();

let file_path = Path::new("build/file.js");
fs.insert(
file_path.into(),
r#"
value['optimizelyService'] = optimizelyService;
"#,
);

let biome_json = Path::new("biome.json");
fs.insert(
biome_json.into(),
r#"{
"$schema": "https://biomejs.dev/schemas/1.6.1/schema.json",
"organizeImports": {
"enabled": true
},
"linter": {
"ignore": ["build/**"],
"enabled": true,
"rules": {
"recommended": true
}
}
}
"#,
);

let result = run_cli(
DynRef::Borrowed(&mut fs),
&mut console,
Args::from([("check"), file_path.as_os_str().to_str().unwrap()].as_slice()),
);

assert!(result.is_err(), "run_cli returned {result:?}");

assert_cli_snapshot(SnapshotPayload::new(
module_path!(),
"should_show_diagnostics_for_formatter_when_linter_ignores_folder",
fs,
console,
result,
));
}
56 changes: 56 additions & 0 deletions crates/biome_cli/tests/commands/format.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3461,3 +3461,59 @@ fn format_empty_svelte_ts_files_write() {
result,
));
}

#[test]
fn should_fix_file_ignored_by_linter_inside_folder() {
ematipico marked this conversation as resolved.
Show resolved Hide resolved
let mut fs = MemoryFileSystem::default();
let mut console = BufferConsole::default();

let file_path = Path::new("build/file.js");
fs.insert(
file_path.into(),
r#"
value['optimizelyService'] = optimizelyService;
"#,
);

let biome_json = Path::new("biome.json");
fs.insert(
biome_json.into(),
r#"{
"$schema": "https://biomejs.dev/schemas/1.6.1/schema.json",
"organizeImports": {
"enabled": true
},
"linter": {
"ignore": ["**/build"],
"enabled": true,
"rules": {
"recommended": true
}
}
}
"#,
);

let result = run_cli(
DynRef::Borrowed(&mut fs),
&mut console,
Args::from(
[
("format"),
"--write",
file_path.as_os_str().to_str().unwrap(),
]
.as_slice(),
),
);

assert!(result.is_ok(), "run_cli returned {result:?}");

assert_cli_snapshot(SnapshotPayload::new(
module_path!(),
"should_fix_file_ignored_by_linter_inside_folder",
fs,
console,
result,
));
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
source: crates/biome_cli/tests/snap_test.rs
expression: content
---
## `biome.json`

```json
{
"$schema": "https://biomejs.dev/schemas/1.6.1/schema.json",
"organizeImports": {
"enabled": true
},
"linter": {
"ignore": ["build/**"],
"enabled": true,
"rules": {
"recommended": true
}
}
}
```

## `build/file.js`

```js

value['optimizelyService'] = optimizelyService;

```

# Termination Message

```block
check ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

× Some errors were emitted while running checks.



```

# Emitted Messages

```block
build/file.js format ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Formatter would have printed the following content:

1 │ -
2 │ - → value['optimizelyService']·=·optimizelyService;
3 │ - → →
1 │ + value["optimizelyService"]·=·optimizelyService;
2 │ +


```

```block
Checked 1 file in <TIME>. No fixes needed.
Found 2 errors.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
source: crates/biome_cli/tests/snap_test.rs
expression: content
---
## `biome.json`

```json
{
"$schema": "https://biomejs.dev/schemas/1.6.1/schema.json",
"organizeImports": {
"enabled": true
},
"linter": {
"ignore": ["**/build"],
"enabled": true,
"rules": {
"recommended": true
}
}
}
```

## `build/file.js`

```js
value["optimizelyService"] = optimizelyService;

```

# Emitted Messages

```block
Formatted 1 file in <TIME>. Fixed 1 file.
```
2 changes: 1 addition & 1 deletion crates/biome_service/src/workspace.rs
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,7 @@ impl RageEntry {
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct IsPathIgnoredParams {
pub biome_path: BiomePath,
pub feature: FeatureName,
pub features: Vec<FeatureName>,
}

pub trait Workspace: Send + Sync + RefUnwindSafe {
Expand Down
14 changes: 11 additions & 3 deletions crates/biome_service/src/workspace/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -243,14 +243,22 @@ impl WorkspaceServer {

/// Check whether a file is ignored in the top-level config `files.ignore`/`files.include`
/// or in the feature `ignore`/`include`
fn is_ignored(&self, path: &Path, feature: FeatureName) -> bool {
fn is_ignored(&self, path: &Path, features: Vec<FeatureName>) -> bool {
let file_name = path.file_name().and_then(|s| s.to_str());
let ignored_by_features = {
let mut ignored = false;
for feature in features {
// a path is ignored if it's ignored by all features
ignored &= self.is_ignored_by_feature_config(path, feature)
Copy link
Member Author

@ematipico ematipico Mar 21, 2024

Choose a reason for hiding this comment

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

I use a bitwise operation (bit AND) because a path is ignored only if ALL features ignore that path

}
ignored
};
// Never ignore Biome's config file regardless `include`/`ignore`
(file_name != Some(ConfigName::biome_json()) || file_name != Some(ConfigName::biome_jsonc())) &&
// Apply top-level `include`/`ignore`
(self.is_ignored_by_top_level_config(path) ||
// Apply feature-level `include`/`ignore`
self.is_ignored_by_feature_config(path, feature))
ignored_by_features)
}

/// Check whether a file is ignored in the top-level config `files.ignore`/`files.include`
Expand Down Expand Up @@ -363,7 +371,7 @@ impl Workspace for WorkspaceServer {
}
}
fn is_path_ignored(&self, params: IsPathIgnoredParams) -> Result<bool, WorkspaceError> {
Ok(self.is_ignored(params.biome_path.as_path(), params.feature))
Ok(self.is_ignored(params.biome_path.as_path(), params.features))
}
/// Update the global settings for this workspace
///
Expand Down
4 changes: 4 additions & 0 deletions website/src/content/docs/internals/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ our [guidelines for writing a good changelog entry](https://github.com/biomejs/b

### CLI

#### Bug fixes

- Fixes [#2131](https://github.com/biomejs/biome/issues/2131), where folders were incorrectly ignored when running the command `check`. Now folders are correctly ignored based on their command. Contributed by @ematipico

### Configuration

#### Bug fixes
Expand Down
Loading