feat(linter): expose type errors via tsgolint

Author: camc314

apps/oxlint/fixtures/tsgolint_type_error/.oxlintrc.json

@@ -0,0 +1,50 @@
+{
+  "categories": {
+    "correctness": "off"
+  },
+  "rules": {
+    "typescript/await-thenable": "error",
+    "typescript/no-array-delete": "error",
+    "typescript/no-base-to-string": "error",
+    "typescript/no-confusing-void-expression": "error",
+    "typescript/no-deprecated": "error",
+    "typescript/no-duplicate-type-constituents": "error",
+    "typescript/no-floating-promises": "error",
+    "typescript/no-for-in-array": "error",
+    "typescript/no-implied-eval": "error",
+    "typescript/no-meaningless-void-operator": "error",
+    "typescript/no-misused-spread": "error",
+    "typescript/no-mixed-enums": "error",
+    "typescript/no-redundant-type-constituents": "error",
+    "typescript/no-unnecessary-boolean-literal-compare": "error",
+    "typescript/no-unnecessary-template-expression": "error",
+    "typescript/no-unnecessary-type-arguments": "error",
+    "typescript/no-unnecessary-type-assertion": "error",
+    "typescript/no-unsafe-argument": "error",
+    "typescript/no-unsafe-assignment": "error",
+    "typescript/no-unsafe-call": "error",
+    "typescript/no-unsafe-enum-comparison": "error",
+    "typescript/no-unsafe-member-access": "error",
+    "typescript/no-unsafe-return": "error",
+    "typescript/no-unsafe-type-assertion": "error",
+    "typescript/no-unsafe-unary-minus": "error",
+    "typescript/non-nullable-type-assertion-style": "error",
+    "typescript/only-throw-error": "error",
+    "typescript/prefer-includes": "error",
+    "typescript/prefer-promise-reject-errors": "error",
+    "typescript/prefer-reduce-type-parameter": "error",
+    "typescript/prefer-return-this-type": "error",
+    "typescript/promise-function-async": "error",
+    "typescript/related-getter-setter-pairs": "error",
+    "typescript/require-array-sort-compare": "error",
+    "typescript/require-await": "error",
+    "typescript/restrict-plus-operands": "error",
+    "typescript/restrict-template-expressions": "error",
+    "typescript/return-await": "error",
+    "typescript/strict-boolean-expressions": "error",
+    "typescript/switch-exhaustiveness-check": "error",
+    "typescript/unbound-method": "error",
+    "typescript/use-unknown-in-catch-callback-variable": "error",
+    "no-debugger": "error"
+  }
+}

apps/oxlint/fixtures/tsgolint_type_error/index.js

@@ -0,0 +1,2 @@
+"use strict";
+const foo = "42";

apps/oxlint/fixtures/tsgolint_type_error/index.ts

@@ -0,0 +1 @@
+const foo: number = "42";

apps/oxlint/fixtures/tsgolint_type_error/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "lib": ["ES2024"],
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}

apps/oxlint/src/command/lint.rs

@@ -54,6 +54,10 @@ pub struct LintCommand {
     #[bpaf(switch, hide_usage)]
     pub type_aware: bool,
 
+    /// Enable experimental type checking (includes TypeScript compiler diagnostics)
+    #[bpaf(switch, hide_usage)]
+    pub experimental_type_check: bool,
+
     #[bpaf(external)]
     pub inline_config_options: InlineConfigOptions,
 
@@ -618,6 +622,14 @@ mod lint_options {
         let options = get_lint_options(".");
         assert!(!options.type_aware);
     }
+
+    #[test]
+    fn experimental_type_check() {
+        let options = get_lint_options("--experimental-type-check");
+        assert!(options.experimental_type_check);
+        let options = get_lint_options(".");
+        assert!(!options.experimental_type_check);
+    }
 }
 
 #[cfg(test)]

apps/oxlint/src/lint.rs

@@ -380,6 +380,7 @@ impl CliRunner {
         // TODO: Add a warning message if `tsgolint` cannot be found, but type-aware rules are enabled
         let lint_runner = match LintRunner::builder(options, linter)
             .with_type_aware(self.options.type_aware)
+            .with_experimental_type_check(self.options.experimental_type_check)
             .with_silent(misc_options.silent)
             .with_fix_kind(fix_options.fix_kind())
             .build()
@@ -1361,6 +1362,13 @@ mod test {
         Tester::new().with_cwd("fixtures/tsgolint".into()).test_and_snapshot(args);
     }
 
+    #[test]
+    #[cfg(not(target_endian = "big"))]
+    fn test_tsgolint_type_error() {
+        let args = &["--type-aware", "--experimental-type-check"];
+        Tester::new().with_cwd("fixtures/tsgolint_type_error".into()).test_and_snapshot(args);
+    }
+
     #[test]
     #[cfg(not(target_endian = "big"))]
     fn test_tsgolint_no_typescript_files() {

apps/oxlint/src/snapshots/fixtures__tsgolint_type_error_--type-aware [email protected]

@@ -0,0 +1,19 @@
+---
+source: apps/oxlint/src/tester.rs
+---
+########## 
+arguments: --type-aware --experimental-type-check
+working directory: fixtures/tsgolint_type_error
+----------
+
+  x typescript(TS2322): Type 'string' is not assignable to type 'number'.
+   ,-[index.ts:1:7]
+ 1 | const foo: number = "42";
+   :       ^^^
+   `----
+
+Found 0 warnings and 1 error.
+Finished in <variable>ms on 2 files using 1 threads.
+----------
+CLI result: LintFoundErrors
+----------

apps/oxlint/src/snapshots/[email protected]

@@ -0,0 +1,12 @@
+---
+source: apps/oxlint/src/tester.rs
+---
+########## 
+arguments: --type-aware
+working directory: fixtures/tsgolint_type_error
+----------
+Found 0 warnings and 0 errors.
+Finished in <variable>ms on 2 files using 1 threads.
+----------
+CLI result: LintSucceeded
+----------

crates/oxc_linter/src/lint_runner.rs

@@ -126,6 +126,7 @@ impl Default for DirectivesStore {
 pub struct LintRunnerBuilder {
     regular_linter: Linter,
     type_aware_enabled: bool,
+    experimental_type_check: bool,
     lint_service_options: LintServiceOptions,
     silent: bool,
     fix_kind: FixKind,
@@ -136,6 +137,7 @@ impl LintRunnerBuilder {
         Self {
             regular_linter: linter,
             type_aware_enabled: false,
+            experimental_type_check: false,
             lint_service_options,
             silent: false,
             fix_kind: FixKind::None,
@@ -148,6 +150,12 @@ impl LintRunnerBuilder {
         self
     }
 
+    #[must_use]
+    pub fn with_experimental_type_check(mut self, enabled: bool) -> Self {
+        self.experimental_type_check = enabled;
+        self
+    }
+
     #[must_use]
     pub fn with_silent(mut self, silent: bool) -> Self {
         self.silent = silent;
@@ -171,7 +179,11 @@ impl LintRunnerBuilder {
                 self.regular_linter.config.clone(),
                 self.fix_kind,
             ) {
-                Ok(state) => Some(state.with_silent(self.silent)),
+                Ok(state) => Some(
+                    state
+                        .with_silent(self.silent)
+                        .with_experimental_type_check(self.experimental_type_check),
+                ),
                 Err(e) => return Err(e),
             }
         } else {

crates/oxc_linter/src/tsgolint.rs

@@ -32,6 +32,8 @@ pub struct TsGoLintState {
     fix: bool,
     /// If `true`, request that suggestions be returned from `tsgolint`.
     fix_suggestions: bool,
+    /// If `true`, include TypeScript compiler syntactic and semantic diagnostics.
+    experimental_type_check: bool,
 }
 
 impl TsGoLintState {
@@ -46,6 +48,7 @@ impl TsGoLintState {
             silent: false,
             fix: fix_kind.contains(FixKind::Fix),
             fix_suggestions: fix_kind.contains(FixKind::Suggestion),
+            experimental_type_check: false,
         }
     }
 
@@ -67,6 +70,7 @@ impl TsGoLintState {
             silent: false,
             fix: fix_kind.contains(FixKind::Fix),
             fix_suggestions: fix_kind.contains(FixKind::Suggestion),
+            experimental_type_check: false,
         })
     }
 
@@ -80,6 +84,15 @@ impl TsGoLintState {
         self
     }
 
+    /// Set to `true` to include TypeScript compiler syntactic and semantic diagnostics.
+    ///
+    /// Default is `false`.
+    #[must_use]
+    pub fn with_experimental_type_check(mut self, yes: bool) -> Self {
+        self.experimental_type_check = yes;
+        self
+    }
+
     /// # Panics
     /// - when `stdin` of subprocess cannot be opened
     /// - when `stdout` of subprocess cannot be opened
@@ -548,6 +561,8 @@ impl TsGoLintState {
                 })
                 .collect(),
             source_overrides,
+            report_syntactic: self.experimental_type_check,
+            report_semantic: self.experimental_type_check,
         }
     }
 }
@@ -573,6 +588,8 @@ pub struct Payload {
     pub version: i32,
     pub configs: Vec<Config>,
     pub source_overrides: Option<FxHashMap<String, String>>,
+    pub report_syntactic: bool,
+    pub report_semantic: bool,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]