feat: remove support for rome-ignore (#4252)

biomejs · Oct 23, 2024 · 0def717 · 0def717
1 parent 19abdcf
commit 0def717
Show file tree

Hide file tree

Showing 70 changed files with 301 additions and 650 deletions.
diff --git a/.changeset/remove_support_for_rome_ignore_suppression_comment.md b/.changeset/remove_support_for_rome_ignore_suppression_comment.md
@@ -0,0 +1,7 @@
+---
+cli: major
+---
+
+# Remove support for `rome-ignore` suppression comment
+
+Use the `biome-ignore` suppression comment instead.
diff --git a/.changeset/remove_support_for_romejson.md b/.changeset/remove_support_for_romejson.md
@@ -0,0 +1,5 @@
+---
+cli: major
+---
+
+# Remove support for `rome.json`
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/biome_analyze/src/lib.rs b/crates/biome_analyze/src/lib.rs
@@ -45,16 +45,13 @@ pub use crate::signals::{
 };
 pub use crate::syntax::{Ast, SyntaxVisitor};
 pub use crate::visitor::{NodeVisitor, Visitor, VisitorContext, VisitorFinishContext};
-pub use suppression_action::{ApplySuppression, SuppressionAction};
-
 use biome_console::markup;
-use biome_diagnostics::{
-    category, Applicability, Diagnostic, DiagnosticExt, DiagnosticTags, Severity,
-};
+use biome_diagnostics::{category, Applicability, Diagnostic, DiagnosticExt, DiagnosticTags};
 use biome_rowan::{
-    AstNode, BatchMutation, Direction, Language, SyntaxElement, SyntaxToken, TextLen, TextRange,
-    TextSize, TokenAtOffset, TriviaPiece, TriviaPieceKind, WalkEvent,
+    AstNode, BatchMutation, Direction, Language, SyntaxElement, SyntaxToken, TextRange, TextSize,
+    TokenAtOffset, TriviaPieceKind, WalkEvent,
 };
+pub use suppression_action::{ApplySuppression, SuppressionAction};
 
 /// The analyzer is the main entry point into the `biome_analyze` infrastructure.
 /// Its role is to run a collection of [Visitor]s over a syntax tree, with each
@@ -474,27 +471,11 @@ where
                 }
             };
 
-            if matches!(kind, SuppressionKind::Deprecated) {
-                let signal = DiagnosticSignal::new(move || {
-                    SuppressionDiagnostic::new(
-                        category!("suppressions/deprecatedSuppressionComment"),
-                        range,
-                        "// rome-ignore is deprecated, use // biome-ignore instead",
-                    )
-                    .with_tags(DiagnosticTags::DEPRECATED_CODE)
-                    .with_severity(Severity::Information)
-                })
-                .with_action(move || create_suppression_comment_action(token));
-
-                (self.emit_signal)(&signal)?;
-            }
-
             let (rule, instance) = match kind {
                 SuppressionKind::Everything => (None, None),
                 SuppressionKind::Rule(rule) => (Some(rule), None),
                 SuppressionKind::RuleInstance(rule, instance) => (Some(rule), Some(instance)),
                 SuppressionKind::MaybeLegacy(rule) => (Some(rule), None),
-                SuppressionKind::Deprecated => (None, None),
             };
 
             if let Some(rule) = rule {
@@ -637,55 +618,6 @@ where
     }
 }
 
-fn create_suppression_comment_action<L: Language>(
-    token: &SyntaxToken<L>,
-) -> Option<AnalyzerAction<L>> {
-    let first_node = token.parent()?;
-    let mut new_leading_trivia = vec![];
-    let mut token_text = String::new();
-    let mut new_trailing_trivia = vec![];
-    let mut mutation = BatchMutation::new(first_node);
-
-    for piece in token.leading_trivia().pieces() {
-        if !piece.is_comments() {
-            new_leading_trivia.push(TriviaPiece::new(piece.kind(), piece.text_len()));
-            token_text.push_str(piece.text());
-        }
-
-        if piece.text().contains("rome-ignore") {
-            let new_text = piece.text().replace("rome-ignore", "biome-ignore");
-            new_leading_trivia.push(TriviaPiece::new(piece.kind(), new_text.text_len()));
-            token_text.push_str(&new_text);
-        }
-    }
-
-    token_text.push_str(token.text_trimmed());
-
-    for piece in token.trailing_trivia().pieces() {
-        new_trailing_trivia.push(TriviaPiece::new(piece.kind(), piece.text_len()));
-        token_text.push_str(piece.text());
-    }
-
-    let new_token = SyntaxToken::new_detached(
-        token.kind(),
-        &token_text,
-        new_leading_trivia,
-        new_trailing_trivia,
-    );
-
-    mutation.replace_token_discard_trivia(token.clone(), new_token);
-    Some(AnalyzerAction {
-        mutation,
-        applicability: Applicability::MaybeIncorrect,
-        category: ActionCategory::QuickFix,
-        message: markup! {
-            "Use // biome-ignore instead"
-        }
-        .to_owned(),
-        rule_name: None,
-    })
-}
-
 fn range_match(filter: Option<TextRange>, range: TextRange) -> bool {
     filter.map_or(true, |filter| filter.intersect(range).is_some())
 }
@@ -717,8 +649,6 @@ pub enum SuppressionKind<'a> {
     RuleInstance(&'a str, &'a str),
     /// A suppression using the legacy syntax to disable a specific rule eg. `// biome-ignore lint(style/useWhile)`
     MaybeLegacy(&'a str),
-    /// `rome-ignore` is legacy
-    Deprecated,
 }
 
 fn update_suppression<L: Language>(
@@ -782,7 +712,7 @@ pub struct SuppressionCommentEmitterPayload<'a, L: Language> {
     pub token_offset: TokenAtOffset<SyntaxToken<L>>,
     /// A [BatchMutation] where the consumer can apply the suppression comment
     pub mutation: &'a mut BatchMutation<L>,
-    /// A string equals to "rome-ignore: lint(<RULE_GROUP>/<RULE_NAME>)"
+    /// A string equals to "biome-ignore: lint(<RULE_GROUP>/<RULE_NAME>)"
     pub suppression_text: &'a str,
     /// The original range of the diagnostic where the rule was triggered
     pub diagnostic_text_range: &'a TextRange,

diff --git a/crates/biome_cli/src/commands/mod.rs b/crates/biome_cli/src/commands/mod.rs
@@ -1,6 +1,6 @@
 use crate::changed::{get_changed_files, get_staged_files};
 use crate::cli_options::{cli_options, CliOptions, CliReporter, ColorsArg};
-use crate::diagnostics::{DeprecatedArgument, DeprecatedConfigurationFile};
+use crate::diagnostics::DeprecatedArgument;
 use crate::execute::Stdin;
 use crate::logging::LoggingKind;
 use crate::{
@@ -22,7 +22,7 @@ use biome_configuration::{
 };
 use biome_configuration::{BiomeDiagnostic, PartialConfiguration};
 use biome_console::{markup, Console, ConsoleExt};
-use biome_diagnostics::{Diagnostic, PrintDiagnostic};
+use biome_diagnostics::PrintDiagnostic;
 use biome_fs::{BiomePath, FileSystem};
 use biome_service::configuration::{
     load_configuration, load_editorconfig, LoadedConfiguration, PartialConfigurationExt,
@@ -622,21 +622,6 @@ pub(crate) fn validate_configuration_diagnostics(
     console: &mut dyn Console,
     verbose: bool,
 ) -> Result<(), CliDiagnostic> {
-    if let Some(file_path) = loaded_configuration
-        .file_path
-        .as_ref()
-        .and_then(|f| f.file_name())
-        .and_then(|f| f.to_str())
-    {
-        if file_path == "rome.json" {
-            let diagnostic = DeprecatedConfigurationFile::new(file_path);
-            if diagnostic.tags().is_verbose() && verbose {
-                console.error(markup! {{PrintDiagnostic::verbose(&diagnostic)}})
-            } else {
-                console.error(markup! {{PrintDiagnostic::simple(&diagnostic)}})
-            }
-        }
-    }
     let diagnostics = loaded_configuration.as_diagnostics_iter();
     for diagnostic in diagnostics {
         if diagnostic.tags().is_verbose() && verbose {

diff --git a/crates/biome_cli/src/diagnostics.rs b/crates/biome_cli/src/diagnostics.rs
@@ -475,26 +475,6 @@ impl Termination for CliDiagnostic {
     }
 }
 
-#[derive(Debug, Diagnostic)]
-#[diagnostic(
-category = "internalError/fs",
-    severity = Warning,
-    message(
-        description = "The configuration file {path} is deprecated. Use biome.json instead.",
-        message("The configuration file "<Emphasis>{self.path}</Emphasis>" is deprecated. Use "<Emphasis>"biome.json"</Emphasis>" instead."),
-    )
-)]
-pub struct DeprecatedConfigurationFile {
-    #[location(resource)]
-    pub path: String,
-}
-
-impl DeprecatedConfigurationFile {
-    pub fn new(path: impl Into<String>) -> Self {
-        Self { path: path.into() }
-    }
-}
-
 #[derive(Debug, Default, Diagnostic)]
 #[diagnostic(
     severity = Error,

diff --git a/crates/biome_cli/tests/commands/check.rs b/crates/biome_cli/tests/commands/check.rs
@@ -1091,7 +1091,7 @@ fn fs_files_ignore_symlink() {
         check_windows_symlink!(symlink_dir(&testcase2_path, symlink_testcase2_path));
     }
 
-    let config_path = root_path.join("rome.json");
+    let config_path = root_path.join("biome.json");
     let mut config_file = File::create(config_path).unwrap();
     config_file
         .write_all(CONFIG_IGNORE_SYMLINK.as_bytes())
@@ -1383,7 +1383,7 @@ fn deprecated_suppression_comment() {
     let file_path = Path::new("file.js");
     fs.insert(
         file_path.into(),
-        *b"// rome-ignore lint(suspicious/noDoubleEquals): test
+        *b"// biome-ignore lint(suspicious/noDoubleEquals): test
 a == b;",
     );
 
@@ -1530,7 +1530,7 @@ fn suppression_syntax_error() {
     let mut console = BufferConsole::default();
 
     let file_path = Path::new("check.js");
-    fs.insert(file_path.into(), *b"// rome-ignore(:\n");
+    fs.insert(file_path.into(), *b"// biome-ignore(:\n");
 
     let result = run_cli(
         DynRef::Borrowed(&mut fs),

diff --git a/crates/biome_cli/tests/commands/format.rs b/crates/biome_cli/tests/commands/format.rs
@@ -395,7 +395,7 @@ fn custom_config_file_path() {
     let mut fs = MemoryFileSystem::default();
     let mut console = BufferConsole::default();
 
-    let config_path = Path::new("/test/rome.json");
+    let config_path = Path::new("/test/biome.json");
     fs.insert(config_path.into(), CONFIG_FORMAT.as_bytes());
 
     let file_path = Path::new("file.js");

diff --git a/crates/biome_cli/tests/commands/lint.rs b/crates/biome_cli/tests/commands/lint.rs
@@ -1118,7 +1118,7 @@ fn fs_files_ignore_symlink() {
         check_windows_symlink!(symlink_dir(&testcase2_path, symlink_testcase2_path));
     }
 
-    let config_path = root_path.join("rome.json");
+    let config_path = root_path.join("biome.json");
     let mut config_file = File::create(config_path).unwrap();
     config_file
         .write_all(CONFIG_IGNORE_SYMLINK.as_bytes())
@@ -1564,7 +1564,7 @@ fn deprecated_suppression_comment() {
     let file_path = Path::new("file.js");
     fs.insert(
         file_path.into(),
-        *b"// rome-ignore lint(suspicious/noDoubleEquals): test
+        *b"// biome-ignore lint(suspicious/noDoubleEquals): test
 a == b;",
     );
 
@@ -1678,7 +1678,7 @@ fn suppression_syntax_error() {
     let mut console = BufferConsole::default();
 
     let file_path = Path::new("check.js");
-    fs.insert(file_path.into(), *b"// rome-ignore(:\n");
+    fs.insert(file_path.into(), *b"// biome-ignore(:\n");
 
     let result = run_cli(
         DynRef::Borrowed(&mut fs),

diff --git a/crates/biome_cli/tests/commands/migrate.rs b/crates/biome_cli/tests/commands/migrate.rs
@@ -79,60 +79,6 @@ fn missing_configuration_file() {
     ));
 }
 
-#[test]
-fn emit_diagnostic_for_rome_json() {
-    let mut fs = MemoryFileSystem::default();
-    let mut console = BufferConsole::default();
-
-    let configuration = r#"{ "linter": { "enabled": true } }"#;
-
-    let configuration_path = Path::new("rome.json");
-    fs.insert(configuration_path.into(), configuration.as_bytes());
-
-    let result = run_cli(
-        DynRef::Borrowed(&mut fs),
-        &mut console,
-        Args::from([("migrate")].as_slice()),
-    );
-
-    assert!(result.is_ok(), "run_cli returned {result:?}");
-
-    assert_cli_snapshot(SnapshotPayload::new(
-        module_path!(),
-        "emit_diagnostic_for_rome_json",
-        fs,
-        console,
-        result,
-    ));
-}
-
-#[test]
-fn should_create_biome_json_file() {
-    let mut fs = MemoryFileSystem::default();
-    let mut console = BufferConsole::default();
-
-    let configuration = r#"{ "linter": { "enabled": true } }"#;
-
-    let configuration_path = Path::new("rome.json");
-    fs.insert(configuration_path.into(), configuration.as_bytes());
-
-    let result = run_cli(
-        DynRef::Borrowed(&mut fs),
-        &mut console,
-        Args::from([("migrate"), "--write"].as_slice()),
-    );
-
-    assert!(result.is_ok(), "run_cli returned {result:?}");
-
-    assert_cli_snapshot(SnapshotPayload::new(
-        module_path!(),
-        "should_create_biome_json_file",
-        fs,
-        console,
-        result,
-    ));
-}
-
 #[test]
 fn should_emit_incompatible_arguments_error() {
     let mut fs = MemoryFileSystem::default();