fix(linter): false positive in `typescript/consistent-type-definition…

…s` (#7560) closes #7552
oxc-project · Dec 1, 2024 · 123b5b7 · 123b5b7
1 parent 6cc7a48
commit 123b5b7
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 2 deletions.
diff --git a/crates/oxc_linter/src/rules/typescript/consistent_type_definitions.rs b/crates/oxc_linter/src/rules/typescript/consistent_type_definitions.rs
@@ -78,7 +78,14 @@ impl Rule for ConsistentTypeDefinitions {
                 TSType::TSTypeLiteral(_)
                     if self.config == ConsistentTypeDefinitionsConfig::Interface =>
                 {
-                    let start = if decl.declare { decl.span.start + 8 } else { decl.span.start };
+                    let start = if decl.declare {
+                        let base_start = decl.span.start + 7;
+                        ctx.source_range(Span::new(base_start, decl.span.end))
+                            .find("type")
+                            .map_or(base_start + 1, |v| u32::try_from(v).unwrap_or(0) + base_start)
+                    } else {
+                        decl.span.start
+                    };
 
                     let name_span_start = &decl.id.span.start;
                     let mut name_span_end = &decl.id.span.end;
@@ -172,7 +179,14 @@ impl Rule for ConsistentTypeDefinitions {
             AstKind::TSInterfaceDeclaration(decl)
                 if self.config == ConsistentTypeDefinitionsConfig::Type =>
             {
-                let start = if decl.declare { decl.span.start + 8 } else { decl.span.start };
+                let start = if decl.declare {
+                    let base_start = decl.span.start + 7;
+                    ctx.source_range(Span::new(base_start, decl.span.end))
+                        .find("interface")
+                        .map_or(base_start + 1, |v| u32::try_from(v).unwrap_or(0) + base_start)
+                } else {
+                    decl.span.start
+                };
 
                 let name_span_start = &decl.id.span.start;
                 let mut name_span_end = &decl.id.span.end;
@@ -359,6 +373,11 @@ fn test() {
 			      ",
             Some(serde_json::json!(["type"])),
         ),
+        // Issue: <https://github.com/oxc-project/oxc/issues/7552>
+        ("declaretype S={}", Some(serde_json::json!(["interface"]))),
+        ("declareinterface S {}", Some(serde_json::json!(["type"]))),
+        ("export declaretype S={}", Some(serde_json::json!(["interface"]))),
+        ("export declareinterface S {}", Some(serde_json::json!(["type"]))),
     ];
 
     let fix = vec![
@@ -499,6 +518,19 @@ export declare type Test = {
             ",
             Some(serde_json::json!(["type"])),
         ),
+        // Issue: <https://github.com/oxc-project/oxc/issues/7552>
+        ("declaretype S={}", "declareinterface S {}", Some(serde_json::json!(["interface"]))),
+        ("declareinterface S {}", "declaretype S = {}", Some(serde_json::json!(["type"]))),
+        (
+            "export declaretype S={}",
+            "export declareinterface S {}",
+            Some(serde_json::json!(["interface"])),
+        ),
+        (
+            "export declareinterface S {}",
+            "export declaretype S = {}",
+            Some(serde_json::json!(["type"])),
+        ),
     ];
 
     Tester::new(ConsistentTypeDefinitions::NAME, ConsistentTypeDefinitions::CATEGORY, pass, fail)

diff --git a/crates/oxc_linter/src/snapshots/typescript_consistent_type_definitions.snap b/crates/oxc_linter/src/snapshots/typescript_consistent_type_definitions.snap
@@ -147,3 +147,31 @@ snapshot_kind: text
  3 │               foo: string;
    ╰────
   help: Use an `type` instead of a `interface`
+
+  ⚠ typescript-eslint(consistent-type-definitions): Use an `interface` instead of a `type`
+   ╭─[consistent_type_definitions.tsx:1:10]
+ 1 │ declaretype S={}
+   ·        ────
+   ╰────
+  help: Use an `interface` instead of a `type`
+
+  ⚠ typescript-eslint(consistent-type-definitions): Use an `type` instead of a `interface`
+   ╭─[consistent_type_definitions.tsx:1:10]
+ 1 │ declareinterface S {}
+   ·        ─────────
+   ╰────
+  help: Use an `type` instead of a `interface`
+
+  ⚠ typescript-eslint(consistent-type-definitions): Use an `interface` instead of a `type`
+   ╭─[consistent_type_definitions.tsx:1:17]
+ 1 │ export declaretype S={}
+   ·               ────
+   ╰────
+  help: Use an `interface` instead of a `type`
+
+  ⚠ typescript-eslint(consistent-type-definitions): Use an `type` instead of a `interface`
+   ╭─[consistent_type_definitions.tsx:1:17]
+ 1 │ export declareinterface S {}
+   ·               ─────────
+   ╰────
+  help: Use an `type` instead of a `interface`