fix: typescript-eslint v6 compatibility (#548)

ota-meshi · renovate[bot] · web-flow · commit 68e77240499b · 2023-07-20T13:36:31.000+09:00
Co-authored-by: renovate[bot] &lt;29139614+renovate[bot]@users.noreply.github.com&gt;
diff --git a/.changeset/sweet-avocados-share.md b/.changeset/sweet-avocados-share.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-svelte": patch
+---
+
+fix: typescript-eslint v6 compatibility
diff --git a/.github/workflows/NodeCI.yml b/.github/workflows/NodeCI.yml
@@ -77,9 +77,32 @@ jobs:
         run: |+
           pnpm rm @sveltejs/kit
           rm -rf node_modules
-      - name: Install ESLint ${{ matrix.eslint }}
+      - name: Install svelte@3
+        run: |+
+          pnpm install -D svelte@3 @typescript-eslint/parser@5 @typescript-eslint/eslint-plugin@5
+          rm -rf node_modules
+      - name: Install Packages
+        run: pnpm install
+      - name: Test
+        run: pnpm run test
+  test-for-typescript-eslint-v5:
+    name: Test for typescript-eslint v5
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [18]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+      - name: Setup Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install typescript-eslint v5
         run: |+
-          pnpm install -D svelte@3
+          pnpm install -D @typescript-eslint/parser@5 @typescript-eslint/eslint-plugin@5
           rm -rf node_modules
       - name: Install Packages
         run: pnpm install
diff --git a/package.json b/package.json
@@ -76,7 +76,7 @@
     "postcss-safe-parser": "^6.0.0",
     "postcss-selector-parser": "^6.0.11",
     "semver": "^7.5.3",
-    "svelte-eslint-parser": "^0.32.0"
+    "svelte-eslint-parser": "^0.32.2"
   },
   "devDependencies": {
     "@1stg/browserslist-config": "^1.2.3",
@@ -112,8 +112,8 @@
     "@types/prismjs": "^1.26.0",
     "@types/semver": "^7.5.0",
     "@types/stylus": "^0.48.38",
-    "@typescript-eslint/eslint-plugin": "^5.59.5",
-    "@typescript-eslint/parser": "^5.59.5",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
     "@typescript/vfs": "^1.4.0",
     "acorn": "^8.8.2",
     "assert": "^2.0.0",
@@ -158,7 +158,7 @@
     "prism-svelte": "^0.5.0",
     "prismjs": "^1.25.0",
     "rimraf": "^5.0.0",
-    "sass": "^1.51.0",
+    "sass": "^1.64.0",
     "source-map-js": "^1.0.2",
     "stylelint": "^15.0.0",
     "stylelint-config-standard": "^34.0.0",
@@ -168,7 +168,7 @@
     "svelte-i18n": "^3.6.0",
     "tslib": "^2.5.0",
     "type-coverage": "^2.22.0",
-    "typescript": "^5.0.0",
+    "typescript": "~5.0.0",
     "vite": "^4.0.0",
     "vite-plugin-svelte-md": "^0.1.7",
     "yaml": "^2.1.1"
diff --git a/src/rules/indent-helpers/ts.ts b/src/rules/indent-helpers/ts.ts
@@ -33,7 +33,7 @@ export function defineVisitor(context: IndentContext): NodeListener {
         count: 2,
         includeComments: false,
       })
-      const baseToken = sourceCode.getFirstToken(node.parent!)
+      const baseToken = sourceCode.getFirstToken(node.parent)
       offsets.setOffsetToken([colonOrArrowToken, secondToken], 1, baseToken)
 
       const before = sourceCode.getTokenBefore(colonOrArrowToken)
@@ -636,7 +636,7 @@ export function defineVisitor(context: IndentContext): NodeListener {
       if (firstToken.type === "Punctuator") {
         // method
         leftParenToken = firstToken
-        bodyBaseToken = sourceCode.getFirstToken(node.parent!)
+        bodyBaseToken = sourceCode.getFirstToken(node.parent)
       } else {
         let nextToken = sourceCode.getTokenAfter(firstToken)
         let nextTokenOffset = 0
@@ -823,12 +823,16 @@ export function defineVisitor(context: IndentContext): NodeListener {
         includeComments: false,
       })!
       offsets.setOffsetToken(leftParenToken, 1, firstToken)
-      const rightParenToken = sourceCode.getTokenAfter(node.parameter, {
+      const argument =
+        node.argument ||
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any -- typescript-eslint<v6 node
+        (node as any).parameter
+      const rightParenToken = sourceCode.getTokenAfter(argument, {
         filter: isClosingParenToken,
         includeComments: false,
       })!
       offsets.setOffsetElementList(
-        [node.parameter],
+        [argument],
         leftParenToken,
         rightParenToken,
         1,
@@ -954,7 +958,7 @@ export function defineVisitor(context: IndentContext): NodeListener {
       })
       offsets.setOffsetToken(secondToken, 0, atToken)
 
-      const parent = node.parent!
+      const parent = node.parent
       const { decorators } = parent as { decorators?: TSESTree.Decorator[] }
       if (!decorators || decorators.length === 0) {
         return
diff --git a/tests/fixtures/rules/indent/invalid/ts/ts-interface01-errors.yaml b/tests/fixtures/rules/indent/invalid/ts/ts-interface01-errors.yaml
@@ -74,15 +74,15 @@
   line: 21
   column: 1
   suggestions: null
-- message: Expected indentation of 6 spaces but found 0 spaces.
+- message: Expected indentation of 4 spaces but found 0 spaces.
   line: 22
   column: 1
   suggestions: null
 - message: Expected indentation of 6 spaces but found 0 spaces.
   line: 23
   column: 1
   suggestions: null
-- message: Expected indentation of 4 spaces but found 0 spaces.
+- message: Expected indentation of 6 spaces but found 0 spaces.
   line: 24
   column: 1
   suggestions: null
diff --git a/tests/fixtures/rules/indent/invalid/ts/ts-interface01-input.svelte b/tests/fixtures/rules/indent/invalid/ts/ts-interface01-input.svelte
@@ -17,12 +17,12 @@ string
 }
 class
 Impl
+extends
+E
 implements
 I2
 ,
 I
-extends
-E
 {
 public foo
 =
diff --git a/tests/fixtures/rules/indent/invalid/ts/ts-interface01-output.svelte b/tests/fixtures/rules/indent/invalid/ts/ts-interface01-output.svelte
@@ -17,12 +17,12 @@
   }
   class
     Impl
+    extends
+      E
     implements
       I2
       ,
       I
-    extends
-      E
   {
     public foo
       =
diff --git a/tests/fixtures/rules/indent/invalid/ts/ts-interface03-errors.yaml b/tests/fixtures/rules/indent/invalid/ts/ts-interface03-errors.yaml
@@ -14,6 +14,26 @@
   line: 6
   column: 1
   suggestions: null
+- message: Expected indentation of 4 spaces but found 0 spaces.
+  line: 7
+  column: 1
+  suggestions: null
+- message: Expected indentation of 6 spaces but found 0 spaces.
+  line: 8
+  column: 1
+  suggestions: null
+- message: Expected indentation of 8 spaces but found 0 spaces.
+  line: 9
+  column: 1
+  suggestions: null
+- message: Expected indentation of 10 spaces but found 0 spaces.
+  line: 10
+  column: 1
+  suggestions: null
+- message: Expected indentation of 8 spaces but found 0 spaces.
+  line: 11
+  column: 1
+  suggestions: null
 - message: Expected indentation of 2 spaces but found 0 spaces.
   line: 12
   column: 1
diff --git a/tests/fixtures/rules/indent/invalid/ts/ts-interface03-input.svelte b/tests/fixtures/rules/indent/invalid/ts/ts-interface03-input.svelte
@@ -4,7 +4,7 @@ interface Foo
 <
 T
 >
-implements // visitor key is not provided
+extends
 Bar
 <
 T
diff --git a/tests/fixtures/rules/indent/invalid/ts/ts-interface03-output.svelte b/tests/fixtures/rules/indent/invalid/ts/ts-interface03-output.svelte
@@ -4,11 +4,11 @@
     <
       T
     >
-implements // visitor key is not provided
-Bar
-<
-T
->
+    extends
+      Bar
+        <
+          T
+        >
   { }
 </script>
 
diff --git a/tests/src/rules/@typescript-eslint/original-tests/RuleTester.ts b/tests/src/rules/@typescript-eslint/original-tests/RuleTester.ts
diff --git a/tests/src/rules/@typescript-eslint/original-tests/no-unnecessary-condition.ts b/tests/src/rules/@typescript-eslint/original-tests/no-unnecessary-condition.ts
@@ -1,30 +1,51 @@
 // Original test cases
 // https://github.com/typescript-eslint/typescript-eslint/blob/78467fc1bde9bd2db1e08b3d19f151f4adaff8a9/packages/eslint-plugin/tests/rules/no-unnecessary-condition.test.ts
 /* eslint func-style: off, eslint-plugin/consistent-output: off -- respect original  */
-import type {
-  InvalidTestCase,
-  TestCaseError,
-} from "@typescript-eslint/utils/dist/ts-eslint"
 import * as path from "path"
+import { RuleTester } from "eslint"
 
 import rule from "../../../../../src/rules/@typescript-eslint/no-unnecessary-condition"
-import { getFixturesRootDir, noFormat, RuleTester } from "./RuleTester"
+
+function getFixturesRootDir(): string {
+  return path.join(__dirname, "fixtures")
+}
 
 const rootPath = getFixturesRootDir()
 
 const ruleTester = new RuleTester({
-  parser: "@typescript-eslint/parser",
+  parser: require.resolve("@typescript-eslint/parser"),
   parserOptions: {
     tsconfigRootDir: rootPath,
     project: "./tsconfig.json",
   },
 })
 
+function withFileName<
+  TestCase extends RuleTester.ValidTestCase | RuleTester.InvalidTestCase,
+>(list: (string | TestCase)[]): TestCase[] {
+  return list.map((e) => {
+    if (typeof e === "string") {
+      return { code: e, filename: path.join(rootPath, "file.ts") } as TestCase
+    }
+    if (e.filename) return e
+    return {
+      ...e,
+      filename: e.parserOptions?.tsconfigRootDir
+        ? path.join(e.parserOptions.tsconfigRootDir, "file.ts")
+        : path.join(rootPath, "file.ts"),
+    } as TestCase
+  })
+}
+
 const ruleError = (
   line: number,
   column: number,
   messageId: string,
-): TestCaseError<string> => ({
+): {
+  messageId: string
+  line: number
+  column: number
+} => ({
   messageId,
   line,
   column,
@@ -39,13 +60,13 @@ const t1 = b1 && b2;
 const unnecessaryConditionTest = (
   condition: string,
   messageId: string,
-): InvalidTestCase<string, any> => ({
+): RuleTester.InvalidTestCase => ({
   code: necessaryConditionTest(condition),
   errors: [ruleError(4, 12, messageId)],
 })
 
 ruleTester.run("no-unnecessary-conditionals", rule as any, {
-  valid: [
+  valid: withFileName([
     `
 declare const b1: boolean;
 declare const b2: boolean;
@@ -519,8 +540,8 @@ if (x) {
         tsconfigRootDir: path.join(rootPath, "unstrict"),
       },
     },
-  ],
-  invalid: [
+  ]),
+  invalid: withFileName([
     // Ensure that it's checking in all the right places
     {
       code: `
@@ -904,7 +925,7 @@ do {} while (true);
       ],
     },
     {
-      code: noFormat`
+      code: `
 let foo = { bar: true };
 foo?.bar;
 foo ?. bar;
@@ -954,7 +975,7 @@ foo
       ],
     },
     {
-      code: noFormat`
+      code: `
 let foo = () => {};
 foo?.();
 foo ?. ();
@@ -1004,7 +1025,7 @@ foo
       ],
     },
     {
-      code: noFormat`
+      code: `
 let foo = () => {};
 foo?.(bar);
 foo ?. (bar);
@@ -1540,5 +1561,5 @@ if (x) {
         },
       ],
     },
-  ],
+  ]),
 })
diff --git a/tests/src/rules/indent.ts b/tests/src/rules/indent.ts
diff --git a/tsconfig.json b/tsconfig.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"eslint-plugin-svelte": patch
 +---
++
 +fix: typescript-eslint v6 compatibility
Original file line number	Diff line number	Diff line change
`@@ -17,12 +17,12 @@ string`
`17`	`17`	`}`
`18`	`18`	`class`
`19`	`19`	`Impl`
	`20`	`+extends`
	`21`	`+E`
`20`	`22`	`implements`
`21`	`23`	`I2`
`22`	`24`	`,`
`23`	`25`	`I`
`24`		`-extends`
`25`		`-E`
`26`	`26`	`{`
`27`	`27`	`public foo`
`28`	`28`	`=`
Original file line number	Diff line number	Diff line change
`@@ -17,12 +17,12 @@`
`17`	`17`	`}`
`18`	`18`	`class`
`19`	`19`	`Impl`
	`20`	`+ extends`
	`21`	`+ E`
`20`	`22`	`implements`
`21`	`23`	`I2`
`22`	`24`	`,`
`23`	`25`	`I`
`24`		`- extends`
`25`		`- E`
`26`	`26`	`{`
`27`	`27`	`public foo`
`28`	`28`	`=`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ interface Foo`
`4`	`4`	`<`
`5`	`5`	`T`
`6`	`6`	`>`
`7`		`-implements // visitor key is not provided`
	`7`	`+extends`
`8`	`8`	`Bar`
`9`	`9`	`<`
`10`	`10`	`T`
Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,11 @@`
`4`	`4`	`<`
`5`	`5`	`T`
`6`	`6`	`>`
`7`		`-implements // visitor key is not provided`
`8`		`-Bar`
`9`		`-<`
`10`		`-T`
`11`		`->`
	`7`	`+ extends`
	`8`	`+ Bar`
	`9`	`+ <`
	`10`	`+ T`
	`11`	`+ >`
`12`	`12`	`{ }`
`13`	`13`	`</script>`
`14`	`14`