Update eslint config

google · Sep 8, 2024 · f5c9767 · f5c9767
1 parent d356d98
commit f5c9767
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 37 deletions.
diff --git a/eslint.config.js b/eslint.config.js
@@ -4,17 +4,27 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import pluginJs from '@eslint/js';
+import eslint from '@eslint/js';
 import noOnlyTests from 'eslint-plugin-no-only-tests';
 import tseslint from 'typescript-eslint';
 
+/**
+ * We want to be able to lint non-TypeScript files. If we don't guard our
+ * TypeScript rules with a "files" constraint, eslint will try to lint all files
+ * using the TypeScript parser, which will fail for projects outside a
+ * TypeScript project.
+ */
+const inTypeScriptProjects = (configs) =>
+  configs.map((config) => ({
+    ...config,
+    files: ['src/**/*.ts', 'vscode-extension/src/**/*.ts'],
+  }));
+
 export default [
   {
+    // List all visible files:
+    //   npx eslint --debug 2>&1 | grep "eslint:eslint Lint" | cut -f 4- -d" " | sort
     ignores: [
-      '**/*.js',
-      '**/*.cjs',
-      '**/*.mjs',
-      '**/*.d.ts',
       '**/.wireit/',
       '**/node_modules/',
       'lib/',
@@ -23,37 +33,35 @@ export default [
       'vscode-extension/built/',
     ],
   },
-  {
-    files: ['**/*.ts'],
-    languageOptions: {
-      parser: tseslint.parser,
-      parserOptions: {
-        project: ['./tsconfig.json', './vscode-extension/tsconfig.json'],
+  eslint.configs.recommended,
+  ...inTypeScriptProjects([
+    ...tseslint.configs.strictTypeChecked,
+    {
+      languageOptions: {
+        parserOptions: {
+          projectService: true,
+          tsconfigRootDir: import.meta.dirname,
+        },
+      },
+      plugins: {
+        'no-only-tests': noOnlyTests,
+      },
+      rules: {
+        'no-only-tests/no-only-tests': 'error',
+        '@typescript-eslint/no-unused-vars': [
+          'error',
+          {argsIgnorePattern: '^_', varsIgnorePattern: '^_'},
+        ],
+        '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/no-useless-constructor': 'off',
+        '@typescript-eslint/only-throw-error': 'off',
+        '@typescript-eslint/no-confusing-void-expression': 'off',
+        '@typescript-eslint/restrict-template-expressions': 'off',
+        '@typescript-eslint/no-unnecessary-condition': 'off',
+        '@typescript-eslint/no-unnecessary-type-arguments': 'off',
+        '@typescript-eslint/no-unnecessary-template-expression': 'off',
+        '@typescript-eslint/use-unknown-in-catch-callback-variable': 'off',
       },
     },
-    plugins: {
-      '@typescript-eslint': tseslint.plugin,
-      'no-only-tests': noOnlyTests,
-    },
-  },
-  pluginJs.configs.recommended,
-  ...tseslint.configs.strictTypeChecked,
-  {
-    rules: {
-      'no-only-tests/no-only-tests': 'error',
-      '@typescript-eslint/no-unused-vars': [
-        'error',
-        {argsIgnorePattern: '^_', varsIgnorePattern: '^_'},
-      ],
-      '@typescript-eslint/no-non-null-assertion': 'off',
-      '@typescript-eslint/no-useless-constructor': 'off',
-      '@typescript-eslint/only-throw-error': 'off',
-      '@typescript-eslint/no-confusing-void-expression': 'off',
-      '@typescript-eslint/restrict-template-expressions': 'off',
-      '@typescript-eslint/no-unnecessary-condition': 'off',
-      '@typescript-eslint/no-unnecessary-type-arguments': 'off',
-      '@typescript-eslint/no-unnecessary-template-expression': 'off',
-      '@typescript-eslint/use-unknown-in-catch-callback-variable': 'off',
-    },
-  },
+  ]),
 ];
diff --git a/package.json b/package.json
@@ -118,7 +118,9 @@
       "#comment": "Need to build first so that the vscode-extension lint can see our types.",
       "command": "eslint --color --cache --cache-location .eslintcache .",
       "files": [
-        "eslint.config.js"
+        "eslint.config.js",
+        "bin/*.js",
+        "website/*.{js,cjs}"
       ],
       "output": []
     },