lint: use .gitignore to decide eslint ignore patterns

TODO: extract the eslint invocation to scripts/lint.ts so that it's not duplicated in the "lintfix" task.
Bit-Quill · Jul 12, 2024 · 702808d · 702808d
1 parent 3636963
commit 702808d
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 34 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+# Note: also used for `eslint --ignore-path`.
+
 out
 dist
 node_modules
@@ -27,15 +29,15 @@ packages/core/src/shared/telemetry/vscodeTelemetry.json
 .test-reports
 
 # Auto generated type definitions
-packages/core/src/shared/telemetry/clienttelemetry.d.ts
-packages/core/src/codewhisperer/client/codewhispererclient.d.ts
-packages/core/src/codewhisperer/client/codewhispereruserclient.d.ts
-packages/core/src/amazonqFeatureDev/client/featuredevproxyclient.d.ts
-packages/core/src/auth/sso/oidcclientpkce.d.ts
+**/src/shared/telemetry/clienttelemetry.d.ts
+**/src/codewhisperer/client/codewhispererclient.d.ts
+**/src/codewhisperer/client/codewhispereruserclient.d.ts
+**/src/amazonqFeatureDev/client/featuredevproxyclient.d.ts
+**/src/auth/sso/oidcclientpkce.d.ts
 
 # Generated by tests
-packages/core/src/testFixtures/**/bin
-packages/core/src/testFixtures/**/obj
+**/src/testFixtures/**/bin
+**/src/testFixtures/**/obj
 
 # Generated by copyFiles.ts
 packages/*/LICENSE

diff --git a/package.json b/package.json
@@ -33,7 +33,7 @@
         "newChange": "echo 'Must specify subproject/workspace with -w packages/<subproject>' && false",
         "createRelease": "echo 'Must specify subproject/workspace with -w packages/<subproject>' && false",
         "lint": "npm run lint -w packages/ --if-present",
-        "lintfix": "eslint -c .eslintrc.js --fix --ext .ts packages plugins && npm run formatfix",
+        "lintfix": "eslint -c .eslintrc.js --ignore-path .gitignore --ignore-pattern '**/*.json' --ignore-pattern '**/*.gen.ts' --ignore-pattern '**/types/*.d.ts' --ignore-pattern '**/src/testFixtures/**' --ignore-pattern '**/resources/js/graphStateMachine.js' --fix --ext .ts packages plugins",
         "clean": "npm run clean -w packages/ -w plugins/",
         "reset": "npm run clean && ts-node ./scripts/clean.ts node_modules && npm install",
         "generateNonCodeFiles": "npm run generateNonCodeFiles -w packages/ --if-present"

diff --git a/packages/core/src/testLint/eslint.test.ts b/packages/core/src/testLint/eslint.test.ts
@@ -15,8 +15,20 @@ describe('eslint', function () {
                 '../../node_modules/.bin/eslint',
                 '-c',
                 '../../.eslintrc.js',
+                // Note: eslint currently does not support multiple  --ignore-path args.
+                // Use --ignore-pattern as a workaround.
                 '--ignore-path',
-                '../../.eslintignore',
+                '../../.gitignore',
+                '--ignore-pattern',
+                '**/*.json',
+                '--ignore-pattern',
+                '**/*.gen.ts',
+                '--ignore-pattern',
+                '**/types/*.d.ts',
+                '--ignore-pattern',
+                '**/src/testFixtures/**',
+                '--ignore-pattern',
+                '**/resources/js/graphStateMachine.js',
                 '--ext',
                 '.ts',
                 '.',
@@ -25,6 +37,6 @@ describe('eslint', function () {
                 throws: false,
             }
         )
-        assert.strictEqual(result.status, 0, result.stdout.toString())
+        assert.strictEqual(result.status, 0, result.output.toString())
     })
 })