chore: make organize imports opt-in only

rome · ematipico · Mar 28, 2023 · Dec 7, 2022 · Mar 5, 2023 · Mar 6, 2023
commit 7967014868ae0c49ab005ce571963111a77dda83
diff --git a/crates/rome_cli/tests/commands/check.rs b/crates/rome_cli/tests/commands/check.rs
@@ -1257,6 +1257,10 @@ fn organize_imports() {
     let mut fs = MemoryFileSystem::default();
     let mut console = BufferConsole::default();
 
+    let config = r#"{ "organizeImports": { "enabled": true } }"#;
+    let file_path = Path::new("rome.json");
+    fs.insert(file_path.into(), config.as_bytes());
+
     let file_path = Path::new("check.js");
     let content = r#"
 import { lorem, foom, bar } from "foo";

diff --git a/crates/rome_cli/tests/configs.rs b/crates/rome_cli/tests/configs.rs
@@ -10,7 +10,7 @@ pub const CONFIG_FORMAT: &str = r#"{
 
 pub const CONFIG_INIT_DEFAULT: &str = r#"{
 	"organizeImports": {
-	 	 "enabled": true
+	 	 "enabled": false
 	},
 	"linter": {
 		"enabled": true,
@@ -24,7 +24,7 @@ pub const CONFIG_INIT_DEFAULT: &str = r#"{
 pub const CONFIG_INIT_DEFAULT_WHEN_INSTALLED: &str = r#"{
 	"$schema": "./node_modules/rome/configuration_schema.json",
     "organizeImports": {
-	 	 "enabled": true
+	 	 "enabled": false
 	},
 	"linter": {
 		"enabled": true,

diff --git a/crates/rome_cli/tests/snapshots/main_commands_check/organize_imports.snap b/crates/rome_cli/tests/snapshots/main_commands_check/organize_imports.snap
@@ -2,6 +2,12 @@
 source: crates/rome_cli/tests/snap_test.rs
 expression: content
 ---
+## `rome.json`
+
+```json
+{ "organizeImports": { "enabled": true } }
+```
+
 ## `check.js`
 
 ```js

diff --git a/crates/rome_cli/tests/snapshots/main_commands_init/creates_config_file.snap b/crates/rome_cli/tests/snapshots/main_commands_init/creates_config_file.snap
@@ -7,7 +7,7 @@ expression: content
 ```json
 {
 	"organizeImports": {
-		"enabled": true
+		"enabled": false
 	},
 	"linter": {
 		"enabled": true,

diff --git a/...shots/main_commands_init/creates_config_file_when_rome_installed_via_package_manager.snap b/...shots/main_commands_init/creates_config_file_when_rome_installed_via_package_manager.snap
@@ -8,7 +8,7 @@ expression: content
 {
 	"$schema": "./node_modules/rome/configuration_schema.json",
 	"organizeImports": {
-		"enabled": true
+		"enabled": false
 	},
 	"linter": {
 		"enabled": true,

diff --git a/crates/rome_service/src/configuration/mod.rs b/crates/rome_service/src/configuration/mod.rs
@@ -76,7 +76,7 @@ impl Default for Configuration {
                 enabled: true,
                 ..LinterConfiguration::default()
             }),
-            organize_imports: Some(OrganizeImports { enabled: true }),
+            organize_imports: Some(OrganizeImports { enabled: false }),
             formatter: None,
             javascript: None,
             schema: None,

diff --git a/website/src/pages/configuration.mdx b/website/src/pages/configuration.mdx
@@ -260,11 +260,11 @@ How many characters can be written on a single line.
 
 ## `organizeImports`
 
-### `organizeImports.enabled`
+### `organizeImports.enabled` (experimental)
 
 Enables Rome's sort imports.
 
-> Default: `true`
+> Default: `false`
 
 ## `javascript`
 

diff --git a/website/src/pages/guides/getting-started.mdx b/website/src/pages/guides/getting-started.mdx
@@ -87,7 +87,7 @@ Install our official [Rome VS Code extension](https://marketplace.visualstudio.c
 
 To make Rome the default formatter open a supported file (JavaScript or TypeScript) and:
 
-* open the *Command Palette* (View or Command/Ctrl + Shift + P)
+* open the *Command Palette* (View or <kbd>Ctrl</kbd>/<kbd title="Cmd">⌘</kbd>+<kbd title="Shift">⇧</kbd>+<kbd>P</kbd>)
 * select  *Format Document With...*
 * select *Configure Default Formatter*
 * select *Rome*.