feat: foudations for migration from prettier (#1545)

biomejs · Jan 13, 2024 · 029ec57 · 029ec57
1 parent cf3434c
commit 029ec57
Show file tree

Hide file tree

Showing 9 changed files with 521 additions and 24 deletions.
diff --git a/crates/biome_cli/Cargo.toml b/crates/biome_cli/Cargo.toml
@@ -26,6 +26,7 @@ biome_diagnostics    = { workspace = true }
 biome_flags          = { workspace = true }
 biome_formatter      = { workspace = true }
 biome_fs             = { workspace = true }
+biome_js_formatter   = { workspace = true }
 biome_json_formatter = { workspace = true }
 biome_json_parser    = { workspace = true }
 biome_json_syntax    = { workspace = true }

diff --git a/crates/biome_cli/src/commands/migrate.rs b/crates/biome_cli/src/commands/migrate.rs
@@ -11,6 +11,7 @@ pub(crate) fn migrate(
     session: CliSession,
     cli_options: CliOptions,
     write: bool,
+    prettier: bool,
 ) -> Result<(), CliDiagnostic> {
     let base_path = match cli_options.config_path.as_ref() {
         None => ConfigurationBasePath::default(),
@@ -30,6 +31,7 @@ pub(crate) fn migrate(
                 write,
                 configuration_file_path: path,
                 configuration_directory_path: directory_path,
+                prettier,
             }),
             session,
             &cli_options,

diff --git a/crates/biome_cli/src/commands/mod.rs b/crates/biome_cli/src/commands/mod.rs
@@ -248,12 +248,19 @@ pub enum BiomeCommand {
     ),
     /// It updates the configuration when there are breaking changes
     #[bpaf(command)]
-    Migrate(
-        #[bpaf(external(cli_options), hide_usage)] CliOptions,
+    Migrate {
+        /// It attempts to find the files `.prettierrc`/`prettier.json` and `.prettierignore`, and map
+        /// Prettier's configuration into `biome.json`
+        #[bpaf(long("prettier"), switch, hide, hide_usage)]
+        prettier: bool,
+
+        #[bpaf(external, hide_usage)]
+        cli_options: CliOptions,
+
         /// Writes the new configuration file to disk
         #[bpaf(long("write"), switch)]
-        bool,
-    ),
+        write: bool,
+    },
 
     /// A command to retrieve the documentation of various aspects of the CLI.
     ///
@@ -294,7 +301,7 @@ impl BiomeCommand {
             | BiomeCommand::Lint { cli_options, .. }
             | BiomeCommand::Ci { cli_options, .. }
             | BiomeCommand::Format { cli_options, .. }
-            | BiomeCommand::Migrate(cli_options, _) => cli_options.colors.as_ref(),
+            | BiomeCommand::Migrate { cli_options, .. } => cli_options.colors.as_ref(),
             BiomeCommand::LspProxy(_)
             | BiomeCommand::Start(_)
             | BiomeCommand::Stop
@@ -313,7 +320,7 @@ impl BiomeCommand {
             | BiomeCommand::Lint { cli_options, .. }
             | BiomeCommand::Ci { cli_options, .. }
             | BiomeCommand::Format { cli_options, .. }
-            | BiomeCommand::Migrate(cli_options, _) => cli_options.use_server,
+            | BiomeCommand::Migrate { cli_options, .. } => cli_options.use_server,
             BiomeCommand::Init
             | BiomeCommand::Start(_)
             | BiomeCommand::Stop
@@ -334,7 +341,7 @@ impl BiomeCommand {
             | BiomeCommand::Lint { cli_options, .. }
             | BiomeCommand::Format { cli_options, .. }
             | BiomeCommand::Ci { cli_options, .. }
-            | BiomeCommand::Migrate(cli_options, _) => cli_options.verbose,
+            | BiomeCommand::Migrate { cli_options, .. } => cli_options.verbose,
             BiomeCommand::Version(_)
             | BiomeCommand::Rage(..)
             | BiomeCommand::Start(_)
@@ -353,7 +360,7 @@ impl BiomeCommand {
             | BiomeCommand::Lint { cli_options, .. }
             | BiomeCommand::Format { cli_options, .. }
             | BiomeCommand::Ci { cli_options, .. }
-            | BiomeCommand::Migrate(cli_options, _) => cli_options.log_level.clone(),
+            | BiomeCommand::Migrate { cli_options, .. } => cli_options.log_level.clone(),
             BiomeCommand::Version(_)
             | BiomeCommand::LspProxy(_)
             | BiomeCommand::Rage(..)
@@ -371,7 +378,7 @@ impl BiomeCommand {
             | BiomeCommand::Lint { cli_options, .. }
             | BiomeCommand::Format { cli_options, .. }
             | BiomeCommand::Ci { cli_options, .. }
-            | BiomeCommand::Migrate(cli_options, _) => cli_options.log_kind.clone(),
+            | BiomeCommand::Migrate { cli_options, .. } => cli_options.log_kind.clone(),
             BiomeCommand::Version(_)
             | BiomeCommand::Rage(..)
             | BiomeCommand::LspProxy(_)

diff --git a/crates/biome_cli/src/execute/migrate.rs b/crates/biome_cli/src/execute/migrate.rs
@@ -1,3 +1,5 @@
+mod prettier;
+
 use crate::execute::diagnostics::{ContentDiffAdvice, MigrateDiffDiagnostic};
 use crate::{CliDiagnostic, CliSession};
 use biome_console::{markup, ConsoleExt};
@@ -14,13 +16,26 @@ use std::borrow::Cow;
 use std::ffi::OsStr;
 use std::path::PathBuf;
 
-pub(crate) fn run(
-    session: CliSession,
-    write: bool,
-    configuration_file_path: PathBuf,
-    configuration_directory_path: PathBuf,
-    verbose: bool,
-) -> Result<(), CliDiagnostic> {
+pub(crate) struct MigratePayload<'a> {
+    pub(crate) session: CliSession<'a>,
+    pub(crate) write: bool,
+    pub(crate) configuration_file_path: PathBuf,
+    pub(crate) configuration_directory_path: PathBuf,
+    pub(crate) verbose: bool,
+    #[allow(unused)]
+    pub(crate) prettier: bool,
+}
+
+pub(crate) fn run(migrate_payload: MigratePayload) -> Result<(), CliDiagnostic> {
+    let MigratePayload {
+        session,
+        write,
+        configuration_file_path,
+        configuration_directory_path,
+        verbose,
+        // we will use it later
+        prettier: _,
+    } = migrate_payload;
     let fs = &*session.app.fs;
     let has_deprecated_configuration =
         configuration_file_path.file_name() == Some(OsStr::new("rome.json"));