TINY-11728: Upgrade to latest typescript eslint packages (#51)

ltrouton · web-flow · commit e13a758efff2 · 2025-01-21T16:08:35.000+10:00
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,7 +1,9 @@
+/* eslint-env node */
 module.exports = {
   'extends': './dist/test/module/ESLintConfig.js',
   "parserOptions": {
-      "project": "tsconfig.json",
-      "sourceType": "module"
-  }
-}
+    "projectService": true,
+    "tsconfigRootDir": __dirname,
+  },
+  root: true,
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## Unreleased
 
 ### Changed
+- Upgraded to `typescript` from v4 to v5
+- Upgraded `@typescript-eslint` packages from v5 to v8
+- Upgaded `eslint@^8.40.0` to `eslint@^8.57.0` to work with latest `@typescript-eslint` packages
+- Switched `eslint` and `@typescript-eslint` styling rules to use recommended `@stylistic` package
+- Enabled `no-duplicate-imports` rule in place of removed `@typescript-eslint/no-duplicate-imports` rule 
 - Re-enabled `@typescript-eslint/no-floating-promises` rule
 - Disabled `@typescript-eslint/require-await`, which caused some builds to fail inconsistently and doesn't seem particularly valuable
 
diff --git a/package.json b/package.json
@@ -7,24 +7,25 @@
   "repository": "git@github.com:tinymce/eslint-plugin.git",
   "license": "Apache-2.0",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.59.5",
-    "@typescript-eslint/parser": "^5.59.5",
-    "eslint": "^8.40.0",
+    "@stylistic/eslint-plugin": "^2.12.1",
+    "@typescript-eslint/eslint-plugin": "^8.19.1",
+    "@typescript-eslint/parser": "^8.19.1",
+    "eslint": "^8.57.0",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-mocha": "^10.1.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "resolve": "^1.17.0",
-    "typescript": "^4.9.5"
+    "resolve": "^1.22.10",
+    "typescript": "^5.7.2"
   },
   "devDependencies": {
     "@tinymce/beehive-flow": "^0.19.0",
-    "@types/eslint": "^8.37.0",
-    "@types/estree": "^1.0.1",
-    "@types/node": "^20.1.3",
-    "@types/resolve": "^1.17.1",
-    "@typescript-eslint/typescript-estree": "^5.59.5",
-    "jest": "^27.3.1",
-    "ts-jest": "^27.0.7"
+    "@types/eslint": "^8.56.0",
+    "@types/estree": "^1.0.6",
+    "@types/node": "^22.10.5",
+    "@types/resolve": "^1.20.6",
+    "@typescript-eslint/typescript-estree": "^8.19.1",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5"
   },
   "files": [
     "dist/main",
diff --git a/src/main/ts/configs/Editor.ts b/src/main/ts/configs/Editor.ts
@@ -13,7 +13,7 @@ export const editor: Linter.Config = {
     '@tinymce/prefer-mcagar-tiny-dom': 'error',
 
     '@typescript-eslint/explicit-module-boundary-types': [ 'error', { allowArgumentsExplicitlyTypedAsAny: true }],
-    '@typescript-eslint/comma-dangle': [ 'error', {
+    '@stylistic/comma-dangle': [ 'error', {
       arrays: 'only-multiline',
       objects: 'only-multiline',
       imports: 'never',
@@ -37,10 +37,10 @@ export const editor: Linter.Config = {
       }
     }],
 
-    // Disabled since we're using the typescript-eslint rule
+    // Disabled since we're using the stylistic rule
     'comma-dangle': 'off',
   },
   settings: {
     'import/internal-regex': '^(ephox|tinymce|tiny-premium)/.*'
   }
-};
+};
diff --git a/src/main/ts/configs/Standard.ts b/src/main/ts/configs/Standard.ts
@@ -2,11 +2,16 @@ import { Linter } from 'eslint';
 
 export const base: Linter.Config = {
   extends: [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:@typescript-eslint/recommended-requiring-type-checking'
+    // TODO: Look at enabling recommended eslint options
+    // 'eslint:recommended',
+    'plugin:@typescript-eslint/recommended-type-checked',
+    // TODO: Look at enabling recommended typescript stylistic options
+    // 'plugin:@typescript-eslint/stylistic-type-checked',
   ],
+  parser: '@typescript-eslint/parser',
   plugins: [
     '@typescript-eslint',
+    '@stylistic',
     'import',
     'mocha',
     'prefer-arrow',
@@ -16,21 +21,21 @@ export const base: Linter.Config = {
     '@typescript-eslint/await-thenable': 'error',
     '@typescript-eslint/ban-ts-comment': 'error',
     '@typescript-eslint/ban-types': 'off',
-    '@typescript-eslint/brace-style': 'error',
-    '@typescript-eslint/comma-spacing': 'error',
+    '@stylistic/brace-style': 'error',
+    '@stylistic/comma-spacing': 'error',
     '@typescript-eslint/consistent-type-assertions': 'error',
     '@typescript-eslint/consistent-type-definitions': 'error',
     '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/explicit-member-accessibility': [ 'error', { accessibility: 'explicit' }],
     '@typescript-eslint/explicit-module-boundary-types': 'off',
-    '@typescript-eslint/func-call-spacing': 'error',
-    '@typescript-eslint/indent': [ 'error', 2, {
+    '@stylistic/func-call-spacing': 'error',
+    '@stylistic/indent': [ 'error', 2, {
       FunctionDeclaration: { parameters: 'first' },
       FunctionExpression: { parameters: 'first' },
       SwitchCase: 1
     }],
-    '@typescript-eslint/keyword-spacing': 'error',
-    '@typescript-eslint/member-delimiter-style': [ 'error', {
+    '@stylistic/keyword-spacing': 'error',
+    '@stylistic/member-delimiter-style': [ 'error', {
       multiline: { delimiter: 'semi', requireLast: true },
       singleline: { delimiter: 'semi', requireLast: false }
     }],
@@ -42,40 +47,48 @@ export const base: Linter.Config = {
         format: [ 'PascalCase' ]
       }
     ],
-    '@typescript-eslint/no-duplicate-imports': 'error',
     '@typescript-eslint/no-empty-interface': 'off',
     '@typescript-eslint/no-for-in-array': 'error',
     '@typescript-eslint/no-implied-eval': 'error',
     '@typescript-eslint/no-inferrable-types': [ 'error', { ignoreParameters: true, ignoreProperties: true }],
     '@typescript-eslint/no-namespace': 'error',
-    '@typescript-eslint/no-parameter-properties': 'error',
+    '@typescript-eslint/parameter-properties': 'error',
     '@typescript-eslint/no-shadow': [ 'error', { hoist: 'all' }],
     '@typescript-eslint/no-unused-vars': [ 'warn', {
       vars: 'all',
       args: 'after-used',
+      argsIgnorePattern: '^_',
+      caughtErrors: 'all',
+      caughtErrorsIgnorePattern: '^_',
+      destructuredArrayIgnorePattern: '^_',
       ignoreRestSiblings: true,
-      argsIgnorePattern: '^_'
     }],
-    '@typescript-eslint/object-curly-spacing': [ 'error', 'always', { objectsInObjects: false }],
+    '@stylistic/object-curly-spacing': [ 'error', 'always', { objectsInObjects: false }],
     '@typescript-eslint/prefer-for-of': 'error',
     '@typescript-eslint/prefer-function-type': 'error',
-    '@typescript-eslint/quotes': [ 'error', 'single', { allowTemplateLiterals: true }],
+    '@stylistic/quotes': [ 'error', 'single', { allowTemplateLiterals: true }],
     '@typescript-eslint/require-await': 'off',
     '@typescript-eslint/restrict-plus-operands': 'off',
     '@typescript-eslint/restrict-template-expressions': 'off',
-    '@typescript-eslint/semi': [ 'error', 'always' ],
-    '@typescript-eslint/space-before-blocks': 'error',
-    '@typescript-eslint/space-before-function-paren': [ 'error', { anonymous: 'always', named: 'never' }],
-    '@typescript-eslint/space-infix-ops': 'error',
-    '@typescript-eslint/switch-exhaustiveness-check': 'error',
-    '@typescript-eslint/type-annotation-spacing': 'error',
+    '@stylistic/semi': [ 'error', 'always' ],
+    '@stylistic/space-before-blocks': 'error',
+    '@stylistic/space-before-function-paren': [ 'error', { anonymous: 'always', named: 'never' }],
+    '@stylistic/space-infix-ops': 'error',
+    '@stylistic/type-annotation-spacing': 'error',
     '@typescript-eslint/unified-signatures': 'error',
     '@typescript-eslint/no-floating-promises': [
       'error',
       {
         ignoreVoid: false
       }
     ],
+    // TODO: Look at setting all exhaustive-check options to false to be stricter
+    '@typescript-eslint/switch-exhaustiveness-check': [
+      'error',
+      {
+        considerDefaultExhaustiveForUnions: true
+      }
+    ],
 
     // TODO: Enable once we no longer support IE 11
     '@typescript-eslint/prefer-includes': 'off',
@@ -92,30 +105,34 @@ export const base: Linter.Config = {
     '@typescript-eslint/no-use-before-define': 'off',
     '@typescript-eslint/prefer-as-const': 'off',
     '@typescript-eslint/strict-boolean-expressions': 'off', // Needs StrictNullChecks
+    '@typescript-eslint/no-empty-object-type': 'off',
+    '@typescript-eslint/no-unsafe-function-type': 'off',
+    '@typescript-eslint/prefer-promise-reject-errors': 'off',
+    '@typescript-eslint/no-base-to-string': 'off',
 
-    'array-bracket-spacing': [ 'error', 'always', { objectsInArrays: false, arraysInArrays: false }],
+    '@stylistic/array-bracket-spacing': [ 'error', 'always', { objectsInArrays: false, arraysInArrays: false }],
     'arrow-body-style': 'error',
-    'arrow-parens': [ 'error', 'always' ],
-    'arrow-spacing': 'error',
-    'comma-dangle': 'off',
+    '@stylistic/arrow-parens': [ 'error', 'always' ],
+    '@stylistic/arrow-spacing': 'error',
+    '@stylistic/comma-dangle': 'off',
     'complexity': 'off',
-    'computed-property-spacing': 'error',
+    '@stylistic/computed-property-spacing': 'error',
     'constructor-super': 'error',
     'curly': 'error',
-    'dot-location': [ 'error', 'property' ],
+    '@stylistic/dot-location': [ 'error', 'property' ],
     'dot-notation': 'error',
-    'eol-last': 'off',
+    '@stylistic/eol-last': 'off',
     'eqeqeq': [ 'error', 'smart' ],
     'guard-for-in': 'error',
     'id-blacklist': 'error',
     'id-match': 'error',
     'import/order': 'off',
-    'key-spacing': [ 'error', { beforeColon: false, afterColon: true, mode: 'strict' }],
+    '@stylistic/key-spacing': [ 'error', { beforeColon: false, afterColon: true, mode: 'strict' }],
     'max-classes-per-file': [ 'error', 1 ],
     'max-len': [ 'warn', 160 ],
     'mocha/no-exclusive-tests': 'error',
     'mocha/no-identical-title': 'error',
-    'new-parens': 'error',
+    '@stylistic/new-parens': 'error',
     'no-bitwise': 'error',
     'no-caller': 'error',
     'no-cond-assign': 'error',
@@ -125,45 +142,41 @@ export const base: Linter.Config = {
     'no-eval': 'error',
     'no-fallthrough': 'error',
     'no-invalid-this': 'off',
-    'no-multi-spaces': [ 'error', { ignoreEOLComments: true }],
-    'no-multiple-empty-lines': [ 'error', { max: 1 }],
+    '@stylistic/no-multi-spaces': [ 'error', { ignoreEOLComments: true }],
+    '@stylistic/no-multiple-empty-lines': [ 'error', { max: 1 }],
     'no-nested-ternary': 'error',
     'no-new-wrappers': 'error',
     'no-throw-literal': 'error',
-    'no-trailing-spaces': 'error',
+    '@stylistic/no-trailing-spaces': 'error',
     'no-undef-init': 'error',
     'no-underscore-dangle': 'error',
     'no-unsafe-finally': 'error',
-    'no-unused-expressions': [ 'error', { allowTernary: true }],
+    '@typescript-eslint/no-unused-expressions': [ 'error', { allowTernary: true }],
     'no-unused-labels': 'error',
-    'no-whitespace-before-property': 'error',
+    '@stylistic/no-whitespace-before-property': 'error',
     'object-shorthand': 'error',
     'one-var': [ 'error', 'never' ],
     'prefer-arrow-callback': 'off', // Covered by prefer-arrow-functions
     'prefer-arrow/prefer-arrow-functions': 'error',
-    'quote-props': [ 'error', 'consistent-as-needed' ],
+    '@stylistic/quote-props': [ 'error', 'consistent-as-needed' ],
     'radix': 'error',
-    'rest-spread-spacing': 'error',
-    'semi-spacing': 'error',
-    'spaced-comment': 'error',
-    'space-unary-ops': 'error',
-    'switch-colon-spacing': 'error',
-    'template-curly-spacing': 'error',
+    '@stylistic/rest-spread-spacing': 'error',
+    '@stylistic/semi-spacing': 'error',
+    '@stylistic/spaced-comment': 'error',
+    '@stylistic/space-unary-ops': 'error',
+    '@stylistic/switch-colon-spacing': 'error',
+    '@stylistic/template-curly-spacing': 'error',
     'use-isnan': 'error',
     'valid-typeof': 'off',  // Disabled as it's handled by TypeScript
 
     // Disabled since we're using the equivalent typescript-eslint rule
-    'brace-style': 'off',
-    'comma-spacing': 'off',
-    'func-call-spacing': 'off',
-    'indent': 'off',
-    'keyword-spacing': 'off',
-    'no-duplicate-imports': 'off',
     'no-shadow': 'off',
-    'object-curly-spacing': 'off',
-    'space-before-blocks': 'off',
-    'space-before-function-paren': 'off',
-    'space-infix-ops': 'off',
+
+    'import/no-duplicates': 'off',
+    'no-duplicate-imports': 'error',
+    // Continue using default max-len option to avoid changing too many files that
+    // have max-len ignore comments
+    '@stylistic/max-len': 'off'
   }
 };
 
diff --git a/src/main/ts/rules/NoEnumsInExportSpecifier.ts b/src/main/ts/rules/NoEnumsInExportSpecifier.ts
@@ -20,12 +20,12 @@ export const noEnumsInExportSpecifier: Rule.RuleModule = {
       },
       ExportSpecifier: (node) => {
         if (node.type === 'ExportSpecifier') {
-          const name = node.local.name;
-          if (enumNames.hasOwnProperty(name) && enumNames[name]) {
+          const name = node.local.type === 'Identifier' ? node.local.name : undefined;
+          if (name && Object.prototype.hasOwnProperty.call(enumNames, name) && enumNames[name]) {
             context.report({ node, messageId: 'noEnumsInExportSpecifier' });
           }
         }
       }
     };
   }
-};
+};
diff --git a/src/main/ts/rules/PreferFun.ts b/src/main/ts/rules/PreferFun.ts
@@ -83,9 +83,8 @@ const isIdentity = (func: FuncExpression, expr: Expression) => {
 };
 
 const hasTypeParameters = (func: FuncExpression): boolean => {
-  const tsFunc = func as TSESTree.CallExpression | TSESTree.ArrowFunctionExpression | TSESTree.FunctionExpression;
-  const params = tsFunc.typeParameters;
-  if (params !== undefined && params.type === 'TSTypeParameterDeclaration') {
+  const params = (func as TSESTree.ArrowFunctionExpression | TSESTree.FunctionExpression).typeParameters;
+  if (params?.type === TSESTree.AST_NODE_TYPES.TSTypeParameterDeclaration) {
     return params.params.length > 0;
   } else {
     return false;
@@ -205,4 +204,4 @@ export const preferFun: Rule.RuleModule = {
       };
     }
   }
-};
+};
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -20,12 +20,12 @@ export const noEnumsInExportSpecifier: Rule.RuleModule = {`
`20`	`20`	`},`
`21`	`21`	`ExportSpecifier: (node) => {`
`22`	`22`	`if (node.type === 'ExportSpecifier') {`
`23`		`- const name = node.local.name;`
`24`		`- if (enumNames.hasOwnProperty(name) && enumNames[name]) {`
	`23`	`+ const name = node.local.type === 'Identifier' ? node.local.name : undefined;`
	`24`	`+ if (name && Object.prototype.hasOwnProperty.call(enumNames, name) && enumNames[name]) {`
`25`	`25`	`context.report({ node, messageId: 'noEnumsInExportSpecifier' });`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`	`};`
`30`	`30`	`}`
`31`		`-};`
	`31`	`+};`