fix(cli): correct type for enforce-assist

Author: ematipico

crates/biome_cli/src/commands/mod.rs

@@ -110,35 +110,35 @@ pub enum BiomeCommand {
     /// Runs formatter, linter and import sorting to the requested files.
     #[bpaf(command)]
     Check {
-        /// Writes safe fixes, formatting and import sorting
+        /// Apply  safe fixes, formatting and import sorting
         #[bpaf(long("write"), switch)]
         write: bool,
 
-        /// Allow to do unsafe fixes, should be used with `--write` or `--fix`
+        /// Apply unsafe fixes. Should be used with `--write` or `--fix`
         #[bpaf(long("unsafe"), switch)]
         unsafe_: bool,
 
         /// Alias for `--write`, writes safe fixes, formatting and import sorting
         #[bpaf(long("fix"), switch, hide_usage)]
         fix: bool,
 
-        /// Allow to enable or disable the formatter check.
+        /// Allow enabling or disable the formatter check.
         #[bpaf(
             long("formatter-enabled"),
             argument("true|false"),
             optional,
             hide_usage
         )]
         formatter_enabled: Option<FormatterEnabled>,
-        /// Allow to enable or disable the linter check.
+        /// Allow enabling or disable the linter check.
         #[bpaf(long("linter-enabled"), argument("true|false"), optional, hide_usage)]
         linter_enabled: Option<LinterEnabled>,
 
-        /// Allow to enable or disable the assist.
+        /// Allow enabling or disable the assist.
         #[bpaf(long("assist-enabled"), argument("true|false"), optional)]
         assist_enabled: Option<AssistEnabled>,
 
-        /// Allows to enforce assist, and make the CLI fail if some actions aren't applied. Defaults to `true`.
+        /// Allows enforcing assist, and make the CLI fail if some actions aren't applied. Defaults to `true`.
         #[bpaf(long("enforce-assist"), argument("true|false"), fallback(true))]
         enforce_assist: bool,
 
@@ -150,7 +150,10 @@ pub enum BiomeCommand {
         ///
         /// The file doesn't need to exist on disk, what matters is the extension of the file. Based on the extension, Biome knows how to check the code.
         ///
-        /// Example: `echo 'let a;' | biome check --stdin-file-path=file.js`
+        /// Example:
+        /// ```shell
+        /// echo 'let a;' | biome check --stdin-file-path=file.js --write
+        /// ```
         #[bpaf(long("stdin-file-path"), argument("PATH"), hide_usage)]
         stdin_file_path: Option<String>,
 
@@ -180,15 +183,15 @@ pub enum BiomeCommand {
         #[bpaf(long("write"), switch)]
         write: bool,
 
-        /// Allow to do unsafe fixes, should be used with `--write` or `--fix`
+        /// Apply unsafe fixes. Should be used with `--write` or `--fix`
         #[bpaf(long("unsafe"), switch)]
         unsafe_: bool,
 
         /// Alias for `--write`, writes safe fixes
         #[bpaf(long("fix"), switch, hide_usage)]
         fix: bool,
 
-        /// Fixes lint rule violations with a comment a suppression instead of using a rule code action (fix)
+        /// Fixes lint rule violations with comment suppressions instead of using a rule code action (fix)
         #[bpaf(long("suppress"))]
         suppress: bool,
 
@@ -239,7 +242,10 @@ pub enum BiomeCommand {
         ///
         /// The file doesn't need to exist on disk, what matters is the extension of the file. Based on the extension, Biome knows how to lint the code.
         ///
-        /// Example: `echo 'let a;' | biome lint --stdin-file-path=file.js`
+        /// Example:
+        /// ```shell
+        /// echo 'let a;' | biome lint --stdin-file-path=file.js --write
+        /// ```
         #[bpaf(long("stdin-file-path"), argument("PATH"), hide_usage)]
         stdin_file_path: Option<String>,
         /// When set to true, only the files that have been staged (the ones prepared to be committed)
@@ -288,18 +294,21 @@ pub enum BiomeCommand {
         ///
         /// The file doesn't need to exist on disk, what matters is the extension of the file. Based on the extension, Biome knows how to format the code.
         ///
-        /// Example: `echo 'let a;' | biome format --stdin-file-path=file.js`
+        /// Example:
+        /// ```shell
+        /// echo 'let a;' | biome format --stdin-file-path=file.js --write
+        /// ```
         #[bpaf(long("stdin-file-path"), argument("PATH"), hide_usage)]
         stdin_file_path: Option<String>,
 
         #[bpaf(external, hide_usage)]
         cli_options: CliOptions,
 
-        /// Writes formatted files to file system.
+        /// Writes formatted files to a file system.
         #[bpaf(long("write"), switch)]
         write: bool,
 
-        /// Alias of `--write`, writes formatted files to file system.
+        /// Alias of `--write`, writes formatted files to a file system.
         #[bpaf(long("fix"), switch, hide_usage)]
         fix: bool,
 
@@ -314,7 +323,7 @@ pub enum BiomeCommand {
         changed: bool,
 
         /// Use this to specify the base branch to compare against when you're using the --changed
-        /// flag and the `defaultBranch` is not set in your biome.json
+        /// flag, and the `defaultBranch` is not set in your biome.json
         #[bpaf(long("since"), argument("REF"))]
         since: Option<String>,
 
@@ -327,19 +336,19 @@ pub enum BiomeCommand {
     /// Files won't be modified, the command is a read-only operation.
     #[bpaf(command)]
     Ci {
-        /// Allow to enable or disable the formatter check.
+        /// Allow enabling or disable the formatter check.
         #[bpaf(long("formatter-enabled"), argument("true|false"), optional)]
         formatter_enabled: Option<FormatterEnabled>,
-        /// Allow to enable or disable the linter check.
+        /// Allow enabling or disable the linter check.
         #[bpaf(long("linter-enabled"), argument("true|false"), optional)]
         linter_enabled: Option<LinterEnabled>,
 
-        /// Allow to enable or disable the assist.
+        /// Allow enabling or disable the assist.
         #[bpaf(long("assist-enabled"), argument("true|false"), optional)]
         assist_enabled: Option<AssistEnabled>,
 
-        /// Allows to enforce assist, and make the CLI fail if some actions aren't applied. Defaults to `true`.
-        #[bpaf(long("enforce-assist"), switch, fallback(true))]
+        /// Allows enforcing assist, and make the CLI fail if some actions aren't applied. Defaults to `true`.
+        #[bpaf(long("enforce-assist"), argument("true|false"), fallback(true))]
         enforce_assist: bool,
 
         #[bpaf(external(configuration), hide_usage, optional)]
@@ -453,7 +462,10 @@ pub enum BiomeCommand {
         /// extension of the file. Based on the extension, Biome knows how to
         /// parse the code.
         ///
-        /// Example: `echo 'let a;' | biome search '`let $var`' --stdin-file-path=file.js`
+        /// Example:
+        /// ```shell
+        /// echo 'let a;' | biome search '`let $var`' --stdin-file-path=file.js
+        /// ```
         #[bpaf(long("stdin-file-path"), argument("PATH"), hide_usage)]
         stdin_file_path: Option<String>,
 
@@ -463,7 +475,7 @@ pub enum BiomeCommand {
         /// target, so we currently do not support writing queries that apply
         /// to multiple languages at once.
         ///
-        /// If none given, the default language is JavaScript.
+        /// When none, the default language is JavaScript.
         #[bpaf(long("language"), short('l'))]
         language: Option<GritTargetLanguage>,
 
@@ -502,7 +514,7 @@ pub enum BiomeCommand {
 
     #[bpaf(command("__run_server"), hide)]
     RunServer {
-        /// Allows to change the prefix applied to the file name of the logs.
+        /// Allows changing the prefix applied to the file name of the logs.
         #[bpaf(
             env("BIOME_LOG_PREFIX_NAME"),
             long("log-prefix-name"),
@@ -512,7 +524,7 @@ pub enum BiomeCommand {
             display_fallback
         )]
         log_prefix_name: String,
-        /// Allows to change the folder where logs are stored.
+        /// Allows changing the folder where logs are stored.
         #[bpaf(
             env("BIOME_LOG_PATH"),
             long("log-path"),

crates/biome_cli/tests/cases/assist.rs

@@ -93,6 +93,50 @@ fn assist_emit_diagnostic_and_blocks() {
     ));
 }
 
+#[test]
+fn assist_emit_diagnostic_and_blocks_ci() {
+    let mut fs = MemoryFileSystem::default();
+    let mut console = BufferConsole::default();
+
+    let config = Utf8Path::new("biome.json");
+    fs.insert(
+        config.into(),
+        r#"{
+            "assist": {
+                "enabled": true,
+                "actions": {
+                  "source": {
+                    "useSortedKeys": "on"
+                  }
+                }
+            },
+            "formatter": { "enabled": false }
+        }"#
+        .as_bytes(),
+    );
+    let file = Utf8Path::new("file.json");
+    fs.insert(
+        file.into(),
+        r#"{ "zod": true, "lorem": "ipsum", "foo": "bar" }"#.as_bytes(),
+    );
+
+    let (fs, result) = run_cli(
+        fs,
+        &mut console,
+        Args::from(["ci", file.as_str()].as_slice()),
+    );
+
+    assert!(result.is_err(), "run_cli returned {result:?}");
+
+    assert_cli_snapshot(SnapshotPayload::new(
+        module_path!(),
+        "assist_emit_diagnostic_and_blocks_ci",
+        fs,
+        console,
+        result,
+    ));
+}
+
 #[test]
 fn assist_writes() {
     let mut fs = MemoryFileSystem::default();

crates/biome_cli/tests/snapshots/main_cases_assist/assist_emit_diagnostic_and_blocks_ci.snap

@@ -0,0 +1,59 @@
+---
+source: crates/biome_cli/tests/snap_test.rs
+expression: redactor(content)
+---
+## `biome.json`
+
+```json
+{
+  "assist": {
+    "enabled": true,
+    "actions": {
+      "source": {
+        "useSortedKeys": "on"
+      }
+    }
+  },
+  "formatter": { "enabled": false }
+}
+```
+
+## `file.json`
+
+```json
+{ "zod": true, "lorem": "ipsum", "foo": "bar" }
+```
+
+# Termination Message
+
+```block
+ci ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  × Some errors were emitted while running checks.
+
+
+
+```
+
+# Emitted Messages
+
+```block
+file.json:1:1 assist/source/useSortedKeys  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  × The keys are not sorted.
+
+  > 1 │ { "zod": true, "lorem": "ipsum", "foo": "bar" }
+      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+  i Safe fix: They keys of the current object can be sorted.
+
+  - {·"zod":·true,·"lorem":·"ipsum",·"foo":·"bar"·}
+  + {·"foo":·"bar"·,"lorem":·"ipsum","zod":·true·}
+
+
+```
+
+```block
+Checked 1 file in <TIME>. No fixes applied.
+Found 1 error.
+```

crates/biome_cli/tests/snapshots/main_cases_reporter_github/reports_diagnostics_github_ci_command.snap

@@ -36,20 +36,12 @@ let f;
 ci ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
   × Some errors were emitted while running checks.
-  
 
 
-```
-
-# Emitted Messages
 
-```block
-::notice title=assist/source/organizeImports,file=index.ts,line=1,endLine=1,col=1,endColumn=21::The imports and exports are not sorted.
 ```
 
-```block
-::notice title=assist/source/organizeImports,file=main.ts,line=1,endLine=1,col=1,endColumn=21::The imports and exports are not sorted.
-```
+# Emitted Messages
 
 ```block
 ::warning title=lint/correctness/noUnusedImports,file=index.ts,line=1,endLine=1,col=8,endColumn=12::This import is unused.
@@ -83,6 +75,10 @@ ci ━━━━━━━━━━━━━━━━━━━━━━━━━
 ::warning title=lint/correctness/noUnusedVariables,file=main.ts,line=9,endLine=9,col=7,endColumn=8::This variable is unused.
 ```
 
+```block
+::error title=assist/source/organizeImports,file=index.ts,line=1,endLine=1,col=1,endColumn=21::The imports and exports are not sorted.
+```
+
 ```block
 ::error title=lint/suspicious/noDoubleEquals,file=index.ts,line=4,endLine=4,col=3,endColumn=5::Using == may be unsafe if you are relying on type coercion.
 ```
@@ -111,6 +107,10 @@ ci ━━━━━━━━━━━━━━━━━━━━━━━━━
 ::error title=format,file=index.ts,line=1,endLine=1,col=2,endColumn=2::File content differs from formatting output
 ```
 
+```block
+::error title=assist/source/organizeImports,file=main.ts,line=1,endLine=1,col=1,endColumn=21::The imports and exports are not sorted.
+```
+
 ```block
 ::error title=lint/suspicious/noDoubleEquals,file=main.ts,line=4,endLine=4,col=3,endColumn=5::Using == may be unsafe if you are relying on type coercion.
 ```