Skip to content

Commit 38862e6

Browse files
ematipicoarendjr
ematipico
and
arendjr
authored
fix(cli): don't use temporary file in stdin (#6461)
Co-authored-by: arendjr <[email protected]>
1 parent c939e54 commit 38862e6

5 files changed

Lines changed: 165 additions & 20 deletions

File tree

‎.changeset/late-flies-glow.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"@biomejs/biome": patch
3+
---
4+
5+
Fixed [#6419](https://github.com/biomejs/biome/issues/6419), a regression where stdin mode would create a temporary new file instead of using the one provided by the user. This was an intended regression.
6+
7+
Now Biome will use the file path passed via `--std-file-path`, and apply the configuration that matches it.

‎crates/biome_cli/src/execute/std_in.rs‎

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//!
33
use crate::diagnostics::StdinDiagnostic;
44
use crate::execute::Execution;
5-
use crate::{CliDiagnostic, CliSession, TEMPORARY_INTERNAL_FILE_NAME, TraversalMode};
5+
use crate::{CliDiagnostic, CliSession, TraversalMode};
66
use biome_analyze::RuleCategoriesBuilder;
77
use biome_console::{ConsoleExt, markup};
88
use biome_diagnostics::Diagnostic;
@@ -15,7 +15,6 @@ use biome_service::workspace::{
1515
ChangeFileParams, CloseFileParams, DropPatternParams, FeaturesBuilder, FileContent,
1616
FixFileParams, FormatFileParams, OpenFileParams, SupportsFeatureParams,
1717
};
18-
use camino::Utf8PathBuf;
1918
use std::borrow::Cow;
2019

2120
pub(crate) fn run<'a>(
@@ -30,12 +29,9 @@ pub(crate) fn run<'a>(
3029
let console = &mut *session.app.console;
3130
let mut version = 0;
3231

33-
let std_in_file = biome_path
34-
.extension()
35-
.map(|ext| {
36-
BiomePath::new(Utf8PathBuf::from(TEMPORARY_INTERNAL_FILE_NAME).with_extension(ext))
37-
})
38-
.ok_or_else(|| CliDiagnostic::from(StdinDiagnostic::new_no_extension()))?;
32+
if biome_path.extension().is_none() {
33+
return Err(CliDiagnostic::from(StdinDiagnostic::new_no_extension()));
34+
}
3935

4036
if mode.is_format() {
4137
let file_features = workspace.file_features(SupportsFeatureParams {
@@ -58,14 +54,14 @@ pub(crate) fn run<'a>(
5854
if file_features.supports_format() {
5955
workspace.open_file(OpenFileParams {
6056
project_key,
61-
path: std_in_file.clone(),
57+
path: biome_path.clone(),
6258
content: FileContent::from_client(content),
6359
document_file_source: None,
6460
persist_node_cache: false,
6561
})?;
6662
let printed = workspace.format_file(FormatFileParams {
6763
project_key,
68-
path: std_in_file.clone(),
64+
path: biome_path.clone(),
6965
})?;
7066

7167
let code = printed.into_code();
@@ -80,7 +76,7 @@ pub(crate) fn run<'a>(
8076
});
8177
workspace.close_file(CloseFileParams {
8278
project_key,
83-
path: std_in_file.clone(),
79+
path: biome_path.clone(),
8480
})?;
8581
} else {
8682
console.append(markup! {
@@ -96,7 +92,7 @@ pub(crate) fn run<'a>(
9692

9793
workspace.open_file(OpenFileParams {
9894
project_key,
99-
path: std_in_file.clone(),
95+
path: biome_path.clone(),
10096
content: FileContent::from_client(content),
10197
document_file_source: None,
10298
persist_node_cache: false,
@@ -147,7 +143,7 @@ pub(crate) fn run<'a>(
147143
let fix_file_result = workspace.fix_file(FixFileParams {
148144
project_key,
149145
fix_file_mode: *fix_file_mode,
150-
path: std_in_file.clone(),
146+
path: biome_path.clone(),
151147
should_format: mode.is_check() && file_features.supports_format(),
152148
only: only.clone(),
153149
skip: skip.clone(),
@@ -167,7 +163,7 @@ pub(crate) fn run<'a>(
167163
workspace.change_file(ChangeFileParams {
168164
project_key,
169165
content: output.clone(),
170-
path: std_in_file.clone(),
166+
path: biome_path.clone(),
171167
version,
172168
})?;
173169
new_content = Cow::Owned(output);
@@ -178,7 +174,7 @@ pub(crate) fn run<'a>(
178174
if file_features.supports_format() && mode.is_check() {
179175
let printed = workspace.format_file(FormatFileParams {
180176
project_key,
181-
path: std_in_file.clone(),
177+
path: biome_path.clone(),
182178
})?;
183179
let code = printed.into_code();
184180
let output = match biome_path.extension() {
@@ -212,7 +208,7 @@ pub(crate) fn run<'a>(
212208
}
213209
workspace.close_file(CloseFileParams {
214210
project_key,
215-
path: std_in_file.clone(),
211+
path: biome_path.clone(),
216212
})?;
217213
} else if let TraversalMode::Search { pattern, .. } = mode.traversal_mode() {
218214
// Make sure patterns are always cleaned up at the end of execution.

‎crates/biome_cli/src/lib.rs‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,6 @@ pub(crate) const VERSION: &str = match option_env!("BIOME_VERSION") {
4343
None => env!("CARGO_PKG_VERSION"),
4444
};
4545

46-
/// File name that is temporarily used when running the workspace internally.
47-
/// When using this file, make sure to close it via [Workspace::close_file].
48-
pub const TEMPORARY_INTERNAL_FILE_NAME: &str = "__BIOME_INTERNAL_FILE__";
49-
5046
/// JSON file that is temporarily to handle internal files via [Workspace].
5147
/// When using this file, make sure to close it via [Workspace::close_file].
5248
pub const TEMPORARY_INTERNAL_REPORTER_FILE: &str = "__BIOME_INTERNAL_FILE__.json";

‎crates/biome_cli/tests/commands/check.rs‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1780,6 +1780,96 @@ fn check_stdin_write_successfully() {
17801780
));
17811781
}
17821782

1783+
#[test]
1784+
fn check_stdin_applies_the_config_based_on_path() {
1785+
let mut fs = MemoryFileSystem::default();
1786+
let mut console = BufferConsole::default();
1787+
1788+
fs.insert(
1789+
"biome.json".into(),
1790+
r#"{
1791+
"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
1792+
"linter": {
1793+
"enabled": true,
1794+
"rules": {
1795+
"recommended": true
1796+
}
1797+
},
1798+
"formatter": {
1799+
"indentStyle": "space"
1800+
},
1801+
"javascript": {
1802+
"formatter": {
1803+
"quoteStyle": "single",
1804+
"semicolons": "asNeeded",
1805+
"arrowParentheses": "always",
1806+
"trailingCommas": "es5"
1807+
}
1808+
},
1809+
"overrides": [
1810+
{
1811+
"includes": ["apps/test/**"],
1812+
"javascript": {
1813+
"formatter": {
1814+
"lineWidth": 100
1815+
}
1816+
}
1817+
}
1818+
]
1819+
}
1820+
"#
1821+
.as_bytes(),
1822+
);
1823+
1824+
console.in_buffer.push(
1825+
r#"const _t = [
1826+
colors.l3BackgroundTertiary,
1827+
colors.l3BackgroundPositive,
1828+
colors.l3BackgroundTertiary,
1829+
]
1830+
"#
1831+
.to_string(),
1832+
);
1833+
1834+
let (fs, result) = run_cli(
1835+
fs,
1836+
&mut console,
1837+
Args::from(
1838+
[
1839+
"check",
1840+
"--write",
1841+
"--stdin-file-path",
1842+
"apps/test/index.tsx",
1843+
]
1844+
.as_slice(),
1845+
),
1846+
);
1847+
1848+
assert!(result.is_ok(), "run_cli returned {result:?}");
1849+
1850+
let message = console
1851+
.out_buffer
1852+
.first()
1853+
.expect("Console should have written a message");
1854+
1855+
let content = markup_to_string(markup! {
1856+
{message.content}
1857+
});
1858+
1859+
assert_eq!(
1860+
content,
1861+
"const _t = [colors.l3BackgroundTertiary, colors.l3BackgroundPositive, colors.l3BackgroundTertiary]\n"
1862+
);
1863+
1864+
assert_cli_snapshot(SnapshotPayload::new(
1865+
module_path!(),
1866+
"check_stdin_applies_the_config_based_on_path",
1867+
fs,
1868+
console,
1869+
result,
1870+
));
1871+
}
1872+
17831873
#[test]
17841874
fn check_stdin_write_unsafe_successfully() {
17851875
let fs = MemoryFileSystem::default();

‎crates/biome_cli/tests/snapshots/main_commands_check/check_stdin_applies_the_config_based_on_path.snap‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
source: crates/biome_cli/tests/snap_test.rs
3+
expression: redactor(content)
4+
---
5+
## `biome.json`
6+
7+
```json
8+
{
9+
"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
10+
"linter": {
11+
"enabled": true,
12+
"rules": {
13+
"recommended": true
14+
}
15+
},
16+
"formatter": {
17+
"indentStyle": "space"
18+
},
19+
"javascript": {
20+
"formatter": {
21+
"quoteStyle": "single",
22+
"semicolons": "asNeeded",
23+
"arrowParentheses": "always",
24+
"trailingCommas": "es5"
25+
}
26+
},
27+
"overrides": [
28+
{
29+
"includes": ["apps/test/**"],
30+
"javascript": {
31+
"formatter": {
32+
"lineWidth": 100
33+
}
34+
}
35+
}
36+
]
37+
}
38+
```
39+
40+
# Input messages
41+
42+
```block
43+
const _t = [
44+
colors.l3BackgroundTertiary,
45+
colors.l3BackgroundPositive,
46+
colors.l3BackgroundTertiary,
47+
]
48+
49+
```
50+
51+
# Emitted Messages
52+
53+
```block
54+
const _t = [colors.l3BackgroundTertiary, colors.l3BackgroundPositive, colors.l3BackgroundTertiary]
55+
56+
```

0 commit comments

Comments
 (0)