feat(cli): enhance init command (#7753)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: ematipico

.changeset/busy-pens-send.md

@@ -0,0 +1,26 @@
+---
+"@biomejs/biome": minor
+---
+
+Enhanced the `init` command. The `init` command now checks if the existing project contains known ignore files and known generated folders.
+
+If Biome finds `.gitignore` or `.ignore` files, it will add the following configuration to `biome.json`:
+```diff
+{
++  "vcs": {
++    "enabled": true,
++    "clientKind": "git",
++    "useIgnoreFile": true
++  }
+}
+```
+
+If Biome finds a `dist/` folder, it will exclude it automatically using the double-exclude syntax:
+
+```diff
+{
++  "files": {
++    "includes": ["**", "!!**/dist"]
++  }
+}
+```

crates/biome_cli/src/commands/init.rs

@@ -1,27 +1,102 @@
 use crate::{CliDiagnostic, CliSession};
-use biome_configuration::Configuration;
+use biome_configuration::vcs::{GIT_IGNORE_FILE_NAME, IGNORE_FILE_NAME, VcsConfiguration};
+use biome_configuration::{Configuration, FilesConfiguration};
+use biome_console::fmt::{Display, Formatter};
 use biome_console::{ConsoleExt, markup};
+use biome_diagnostics::{Category, Diagnostic, PrintDiagnostic, Severity, category};
 use biome_fs::ConfigName;
 use biome_service::configuration::create_config;
 
 pub(crate) fn init(session: CliSession, emit_jsonc: bool) -> Result<(), CliDiagnostic> {
     let fs = session.app.workspace.fs();
-    create_config(fs, Configuration::init(), emit_jsonc)?;
+    let working_directory = fs.working_directory().unwrap_or_default();
+    let mut config = Configuration::init();
+    let mut vcs_enabled = false;
+    let mut dist_enabled = false;
+    if fs.path_exists(&working_directory.join(IGNORE_FILE_NAME))
+        || fs.path_exists(&working_directory.join(GIT_IGNORE_FILE_NAME))
+    {
+        vcs_enabled = true;
+        config.vcs = Some(VcsConfiguration::new_git_ignore());
+    }
+
+    if fs.path_exists(&working_directory.join("dist")) {
+        dist_enabled = true;
+        config.files = Some(FilesConfiguration {
+            includes: Some(vec![
+                "**".parse::<biome_glob::NormalizedGlob>().unwrap(),
+                "!!**/dist".parse::<biome_glob::NormalizedGlob>().unwrap(),
+            ]),
+            ignore_unknown: None,
+            max_size: None,
+            experimental_scanner_ignores: None,
+        })
+    }
+
+    create_config(fs, config, emit_jsonc)?;
     let file_created = if emit_jsonc {
         ConfigName::biome_jsonc()
     } else {
         ConfigName::biome_json()
     };
-    session.app.console.log(markup! {
-"
-Welcome to Biome! Let's get you started...
+    let diagnostic = InitDiagnostic {
+        dist_enabled,
+        vcs_enabled,
+        file_created,
+    };
+    session
+        .app
+        .console
+        .log(markup! {{PrintDiagnostic::simple(&diagnostic)}});
+
+    Ok(())
+}
+
+#[derive(Debug)]
+struct InitDiagnostic {
+    dist_enabled: bool,
+    vcs_enabled: bool,
+    file_created: &'static str,
+}
+
+impl Diagnostic for InitDiagnostic {
+    fn category(&self) -> Option<&'static Category> {
+        Some(category!("init"))
+    }
+
+    fn severity(&self) -> Severity {
+        Severity::Information
+    }
+
+    fn message(&self, fmt: &mut Formatter<'_>) -> std::io::Result<()> {
+        fmt.write_markup(markup! {
+            {self}
+        })
+    }
+}
+
+impl Display for InitDiagnostic {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::io::Result<()> {
+        f.write_markup(markup! {"Welcome to Biome! Let's get you started...
 
 "<Info><Emphasis>"Files created "</Emphasis></Info>"
 
-  "<Dim>"- "</Dim><Emphasis>{file_created}</Emphasis>"
-    Your project configuration. See "<Hyperlink href="https://biomejs.dev/reference/configuration">"https://biomejs.dev/reference/configuration"</Hyperlink>"
+  "<Dim>"- "</Dim><Emphasis>{self.file_created}</Emphasis>"
+    Your project configuration. See "<Hyperlink href="https://biomejs.dev/reference/configuration">"https://biomejs.dev/reference/configuration"</Hyperlink>})?;
 
-"<Info><Emphasis>"Next Steps "</Emphasis></Info>"
+        if self.vcs_enabled {
+            f.write_markup(markup!{
+                "\n\nFound an ignore file. Biome enabled "<Hyperlink href="https://biomejs.dev/guides/integrate-in-vcs">"VCS integration."</Hyperlink>
+            })?;
+        }
+
+        if self.dist_enabled {
+            f.write_markup(markup!{
+                "\n\nFound a "<Emphasis>"dist/"</Emphasis>" folder. Biome ignored it "<Hyperlink href="https://biomejs.dev/reference/configuration/#interaction-with-the-scanner">"using the double-exclude syntax."</Hyperlink>
+            })?;
+        }
+
+        f.write_markup(markup! {<Info><Emphasis>"\n\nNext Steps "</Emphasis></Info>"
 
   "<Dim>"1."</Dim>" "<Emphasis>"Setup an editor extension"</Emphasis>"
      Get live errors as you type and format when you save.
@@ -42,6 +117,8 @@ Welcome to Biome! Let's get you started...
      Ask questions and contribute on GitHub: "<Hyperlink href="https://github.com/biomejs/biome">"https://github.com/biomejs/biome"</Hyperlink>"
      Seek for help on Discord: "<Hyperlink href="https://biomejs.dev/chat">"https://biomejs.dev/chat"</Hyperlink>"
 "
-    });
-    Ok(())
+    })?;
+
+        Ok(())
+    }
 }

crates/biome_cli/tests/commands/format.rs

@@ -3429,7 +3429,7 @@ fn html_enabled_by_default() {
         Args::from(["format", "--write", file_path.as_str()].as_slice()),
     );
 
-    assert!(result.is_ok(), "run_cli returned {result:?}");
+    assert!(result.is_err(), "run_cli returned {result:?}");
 
     assert_cli_snapshot(SnapshotPayload::new(
         module_path!(),

crates/biome_cli/tests/commands/init.rs

@@ -40,6 +40,26 @@ fn creates_config_file() {
     ));
 }
 
+#[test]
+fn enables_vcs_and_ignore_dist() {
+    let fs = MemoryFileSystem::default();
+    let mut console = BufferConsole::default();
+
+    fs.insert(".gitignore".into(), "".as_bytes());
+    fs.insert("dist".into(), "".as_bytes());
+
+    let (fs, result) = run_cli(fs, &mut console, Args::from(["init"].as_slice()));
+    assert!(result.is_ok(), "run_cli returned {result:?}");
+
+    assert_cli_snapshot(SnapshotPayload::new(
+        module_path!(),
+        "enables_vcs_and_ignore_dist",
+        fs,
+        console,
+        result,
+    ));
+}
+
 #[test]
 fn creates_config_jsonc_file() {
     let fs = MemoryFileSystem::default();

crates/biome_cli/tests/snapshots/main_commands_format/html_enabled_by_default.snap

@@ -5,12 +5,28 @@ expression: redactor(content)
 ## `file.html`
 
 ```html
-<!DOCTYPE html>
+<!DOCTYPE HTML>
+```
+
+# Termination Message
+
+```block
+format ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  × No files were processed in the specified paths.
+  
+  i Check your biome.json or biome.jsonc to ensure the paths are not ignored by the configuration.
+  
+  i These paths were provided but ignored:
+  
+  - file.html
+  
+
 
 ```
 
 # Emitted Messages
 
 ```block
-Formatted 1 file in <TIME>. Fixed 1 file.
+Formatted 0 files in <TIME>. No fixes applied.
 ```

crates/biome_cli/tests/snapshots/main_commands_init/creates_config_file.snap

@@ -44,33 +44,36 @@ expression: redactor(content)
 # Emitted Messages
 
 ```block
+init ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-Welcome to Biome! Let's get you started...
-
-Files created 
-
-  - biome.json
-    Your project configuration. See https://biomejs.dev/reference/configuration
-
-Next Steps 
-
-  1. Setup an editor extension
-     Get live errors as you type and format when you save.
-     Learn more at https://biomejs.dev/guides/editors/first-party-extensions/
-
-  2. Try a command
-     biome check  checks formatting, import sorting, and lint rules.
-     biome --help displays the available commands.
-
-  3. Migrate from ESLint and Prettier
-     biome migrate eslint   migrates your ESLint configuration to Biome.
-     biome migrate prettier migrates your Prettier configuration to Biome.
-
-  4. Read the documentation
-     Find guides and documentation at https://biomejs.dev/guides/getting-started/
-
-  5. Get involved with the community
-     Ask questions and contribute on GitHub: https://github.com/biomejs/biome
-     Seek for help on Discord: https://biomejs.dev/chat
+  i Welcome to Biome! Let's get you started...
+    
+    Files created 
+    
+      - biome.json
+        Your project configuration. See https://biomejs.dev/reference/configuration
+    
+    Next Steps 
+    
+      1. Setup an editor extension
+         Get live errors as you type and format when you save.
+         Learn more at https://biomejs.dev/guides/editors/first-party-extensions/
+    
+      2. Try a command
+         biome check  checks formatting, import sorting, and lint rules.
+         biome --help displays the available commands.
+    
+      3. Migrate from ESLint and Prettier
+         biome migrate eslint   migrates your ESLint configuration to Biome.
+         biome migrate prettier migrates your Prettier configuration to Biome.
+    
+      4. Read the documentation
+         Find guides and documentation at https://biomejs.dev/guides/getting-started/
+    
+      5. Get involved with the community
+         Ask questions and contribute on GitHub: https://github.com/biomejs/biome
+         Seek for help on Discord: https://biomejs.dev/chat
+  
+  
 
 ```

crates/biome_cli/tests/snapshots/main_commands_init/creates_config_file_when_biome_installed_via_package_manager.snap

@@ -50,33 +50,36 @@ expression: redactor(content)
 # Emitted Messages
 
 ```block
+init ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-Welcome to Biome! Let's get you started...
-
-Files created 
-
-  - biome.json
-    Your project configuration. See https://biomejs.dev/reference/configuration
-
-Next Steps 
-
-  1. Setup an editor extension
-     Get live errors as you type and format when you save.
-     Learn more at https://biomejs.dev/guides/editors/first-party-extensions/
-
-  2. Try a command
-     biome check  checks formatting, import sorting, and lint rules.
-     biome --help displays the available commands.
-
-  3. Migrate from ESLint and Prettier
-     biome migrate eslint   migrates your ESLint configuration to Biome.
-     biome migrate prettier migrates your Prettier configuration to Biome.
-
-  4. Read the documentation
-     Find guides and documentation at https://biomejs.dev/guides/getting-started/
-
-  5. Get involved with the community
-     Ask questions and contribute on GitHub: https://github.com/biomejs/biome
-     Seek for help on Discord: https://biomejs.dev/chat
+  i Welcome to Biome! Let's get you started...
+    
+    Files created 
+    
+      - biome.json
+        Your project configuration. See https://biomejs.dev/reference/configuration
+    
+    Next Steps 
+    
+      1. Setup an editor extension
+         Get live errors as you type and format when you save.
+         Learn more at https://biomejs.dev/guides/editors/first-party-extensions/
+    
+      2. Try a command
+         biome check  checks formatting, import sorting, and lint rules.
+         biome --help displays the available commands.
+    
+      3. Migrate from ESLint and Prettier
+         biome migrate eslint   migrates your ESLint configuration to Biome.
+         biome migrate prettier migrates your Prettier configuration to Biome.
+    
+      4. Read the documentation
+         Find guides and documentation at https://biomejs.dev/guides/getting-started/
+    
+      5. Get involved with the community
+         Ask questions and contribute on GitHub: https://github.com/biomejs/biome
+         Seek for help on Discord: https://biomejs.dev/chat
+  
+  
 
 ```