fix(utils): correct types to align with @types/eslint v9 (typescript-eslint#9657)

bradzacher · web-flow · commit b40648f4a3a1 · 2024-08-05T18:27:49.000-04:00
diff --git a/packages/integration-tests/fixtures/flat-config-types-@types__eslint-v8/package.json b/packages/integration-tests/fixtures/flat-config-types-@types__eslint-v8/package.json
@@ -7,7 +7,7 @@
     "@eslint/js": "latest",
     "@types/eslint": "^8",
     "eslint": "latest",
-    "@stylistic/eslint-plugin": "2.3.0",
+    "@stylistic/eslint-plugin": "latest",
     "eslint-plugin-deprecation": "latest",
     "eslint-plugin-jest": "latest"
   }
diff --git a/packages/integration-tests/fixtures/flat-config-types-@types__eslint-v9/package.json b/packages/integration-tests/fixtures/flat-config-types-@types__eslint-v9/package.json
@@ -7,7 +7,7 @@
     "@eslint/js": "latest",
     "@types/eslint": "^9",
     "eslint": "latest",
-    "@stylistic/eslint-plugin": "2.3.0",
+    "@stylistic/eslint-plugin": "latest",
     "eslint-plugin-deprecation": "latest",
     "eslint-plugin-jest": "latest"
   }
diff --git a/packages/integration-tests/tests/flat-config-types-@types__eslint-v8.test.ts b/packages/integration-tests/tests/flat-config-types-@types__eslint-v8.test.ts
@@ -15,9 +15,10 @@ for (const additionalFlags of [
     out => {
       const lines = out.split('\n').filter(
         line =>
+          line &&
           // error TS18028: Private identifiers are only available when targeting ECMAScript 2015 and higher.
           // this is fine for us to ignore in this context
-          line && !line.includes('error TS18028'),
+          !line.includes('error TS18028'),
       );
 
       // The types should not error (e.g. https://github.com/eslint-stylistic/eslint-stylistic/issues/276)
diff --git a/packages/integration-tests/tests/flat-config-types-@types__eslint-v9.test.ts b/packages/integration-tests/tests/flat-config-types-@types__eslint-v9.test.ts
@@ -18,9 +18,7 @@ for (const additionalFlags of [
           line &&
           // error TS18028: Private identifiers are only available when targeting ECMAScript 2015 and higher.
           // this is fine for us to ignore in this context
-          !line.includes('error TS18028') &&
-          // currently expected errors from @stylistic/eslint-plugin as it doesn't support ESLint v9 types yet
-          !line.startsWith('node_modules/@stylistic/eslint-plugin/'),
+          !line.includes('error TS18028'),
       );
 
       // The types should not error (e.g. https://github.com/eslint-stylistic/eslint-stylistic/issues/276)
diff --git a/packages/utils/src/ts-eslint/Config.ts b/packages/utils/src/ts-eslint/Config.ts
@@ -16,8 +16,18 @@ export namespace SharedConfig {
   export type RuleEntry = RuleLevel | RuleLevelAndOptions;
   export type RulesRecord = Partial<Record<string, RuleEntry>>;
 
-  export type GlobalVariableOptionBase = 'off' | 'readonly' | 'writable';
-  export type GlobalVariableOption = GlobalVariableOptionBase | boolean;
+  export type GlobalVariableOptionBase =
+    | 'off'
+    | 'readonly'
+    | 'writable'
+    | /** @deprecated use `'writable'` */ 'writeable'
+    | /** @deprecated use `'readonly'` */ 'readable';
+  export type GlobalVariableOptionBoolean =
+    | /** @deprecated use `'writable'` */ true
+    | /** @deprecated use `'readonly'` */ false;
+  export type GlobalVariableOption =
+    | GlobalVariableOptionBase
+    | GlobalVariableOptionBoolean;
 
   export interface GlobalsConfig {
     [name: string]: GlobalVariableOption;
@@ -199,7 +209,7 @@ export namespace FlatConfig {
      * Set to `"latest"` for the most recent supported version.
      * @default "latest"
      */
-    ecmaVersion?: EcmaVersion;
+    ecmaVersion?: EcmaVersion | undefined;
     /**
      * An object specifying additional objects that should be added to the global scope during linting.
      */
@@ -212,7 +222,7 @@ export namespace FlatConfig {
      * require('espree')
      * ```
      */
-    parser?: Parser;
+    parser?: Parser | undefined;
     /**
      * An object specifying additional options that are passed directly to the parser.
      * The available options are parser-dependent.
@@ -229,7 +239,7 @@ export namespace FlatConfig {
      * "commonjs"
      * ```
      */
-    sourceType?: SourceType;
+    sourceType?: SourceType | undefined;
   }
 
   // it's not a json schema so it's nowhere near as nice to read and convert...

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`"@eslint/js": "latest",`
`8`	`8`	`"@types/eslint": "^8",`
`9`	`9`	`"eslint": "latest",`
`10`		`- "@stylistic/eslint-plugin": "2.3.0",`
	`10`	`+ "@stylistic/eslint-plugin": "latest",`
`11`	`11`	`"eslint-plugin-deprecation": "latest",`
`12`	`12`	`"eslint-plugin-jest": "latest"`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`"@eslint/js": "latest",`
`8`	`8`	`"@types/eslint": "^9",`
`9`	`9`	`"eslint": "latest",`
`10`		`- "@stylistic/eslint-plugin": "2.3.0",`
	`10`	`+ "@stylistic/eslint-plugin": "latest",`
`11`	`11`	`"eslint-plugin-deprecation": "latest",`
`12`	`12`	`"eslint-plugin-jest": "latest"`
`13`	`13`	`}`