TINY-11824: Upgrade plugin to support eslint V9 and flat config (#52)

* TINY-11824: Upgrade eslint-plugin to be compatible with eslint v9

Author: hamza0867

.eslintrc.js

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+### Added
+- Support for eslint V9
+
+### Removed
+- Support for eslint V8
+
 ## 2.4.0 - 2025-01-22
 
 ### Changed

CHANGELOG.md

@@ -0,0 +1,16 @@
+import base from './dist/test/module/ESLintConfig.mjs';
+import tseslint from 'typescript-eslint';
+
+const config = tseslint.config(
+  base,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      }
+    },
+  }
+);
+
+export default config;

eslint.config.mjs

@@ -1,25 +1,33 @@
 {
   "name": "@tinymce/eslint-plugin",
-  "version": "2.4.1-rc",
+  "version": "3.0.0-rc",
   "description": "Plugin for ESLint containing Tiny Technologies Inc. standard linting rules",
   "author": "Tiny Technologies Inc.",
-  "main": "dist/main/ts/api/Main.js",
+  "main": "dist/main/ts/api/Main.mjs",
   "repository": "git@github.com:tinymce/eslint-plugin.git",
   "license": "Apache-2.0",
   "dependencies": {
-    "@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",
+    "@stylistic/eslint-plugin": "^4.2.0",
+    "@typescript-eslint/eslint-plugin": "^8.26.1",
+    "@typescript-eslint/parser": "^8.26.1",
+    "@typescript-eslint/rule-tester": "^8.26.1",
+    "@typescript-eslint/utils": "^8.26.1",
+    "eslint": "^9.22.0",
+    "eslint-plugin-import-x": "^4.8.0",
     "eslint-plugin-mocha": "^10.1.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-prefer-arrow-functions": "^3.6.2",
     "resolve": "^1.22.10",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.26.1"
+  },
+  "peerDependencies": {
+    "eslint": "^9.22.0"
   },
   "devDependencies": {
     "@tinymce/beehive-flow": "^0.19.0",
     "@types/eslint": "^8.56.0",
+    "@types/eslint-plugin-mocha": "^10.4.0",
     "@types/estree": "^1.0.6",
     "@types/node": "^22.10.5",
     "@types/resolve": "^1.20.6",
@@ -39,6 +47,6 @@
     "prepublishOnly": "tsc"
   },
   "engines": {
-    "node": ">=9.0.0"
+    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
   }
 }

package.json

@@ -0,0 +1,117 @@
+import { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+import { base } from '../configs/Standard.mjs';
+import { noDirectEditorEvents } from '../rules/NoDirectEditorEvents.js';
+import { noDirectEditorOptions } from '../rules/NoDirectEditorOptions.js';
+import { noDirectImports } from '../rules/NoDirectImports.js';
+import { noEnumsInExportSpecifier } from '../rules/NoEnumsInExportSpecifier.js';
+import { noImplicitDomGlobals } from '../rules/NoImplicitDomGlobals.js';
+import { noMainModuleImports } from '../rules/NoMainModuleImports.js';
+import { noPathAliasImports } from '../rules/NoPathAliasImports.js';
+import { noPublicApiModuleImports } from '../rules/NoPublicApiModuleImports.js';
+import { preferFun } from '../rules/PreferFun.js';
+import { preferMcAgarTinyAssertions } from '../rules/PreferMcAgarTinyAssertions.js';
+import { preferMcAgarTinyDom } from '../rules/PreferMcAgarTinyDom.js';
+
+import tseslint from 'typescript-eslint';
+
+const rules = {
+  'no-direct-editor-events': noDirectEditorEvents,
+  'no-direct-editor-options': noDirectEditorOptions,
+  'no-direct-imports': noDirectImports,
+  'no-enums-in-export-specifier': noEnumsInExportSpecifier,
+  'no-main-module-imports': noMainModuleImports,
+  'no-path-alias-imports': noPathAliasImports,
+  'no-publicapi-module-imports': noPublicApiModuleImports,
+  'no-implicit-dom-globals': noImplicitDomGlobals,
+  'prefer-fun': preferFun,
+  'prefer-mcagar-tiny-assertions': preferMcAgarTinyAssertions,
+  'prefer-mcagar-tiny-dom': preferMcAgarTinyDom
+};
+
+const configs: FlatConfig.SharedConfigs = {
+  get standard() {
+    return standard;
+  },
+  get editor() {
+    return editor;
+  }
+};
+
+const plugin: FlatConfig.Plugin = {
+  rules,
+  configs,
+  meta: {
+    name: '@tinymce/eslint-plugin',
+    version: '2.4.1-rc'
+  }
+};
+
+const standard = tseslint.config(
+  base,
+  {
+    plugins: {
+      '@tinymce': plugin
+    },
+    rules: {
+      '@tinymce/no-direct-editor-events': 'off',
+      '@tinymce/no-direct-editor-options': 'off',
+      '@tinymce/no-direct-imports': 'error',
+      '@tinymce/no-enums-in-export-specifier': 'error',
+      '@tinymce/no-main-module-imports': 'error',
+      '@tinymce/no-path-alias-imports': 'error',
+      '@tinymce/no-publicapi-module-imports': 'error',
+      '@tinymce/no-unimported-promise': 'off',
+      '@tinymce/no-implicit-dom-globals': 'error',
+      '@tinymce/prefer-fun': 'error',
+      '@tinymce/prefer-mcagar-tiny-assertions': 'off',
+      '@tinymce/prefer-mcagar-tiny-dom': 'off',
+    }
+  });
+
+const editor = tseslint.config(
+  standard,
+  {
+    rules: {
+
+      '@tinymce/no-direct-editor-events': 'error',
+      '@tinymce/no-direct-editor-options': 'error',
+      '@tinymce/prefer-mcagar-tiny-assertions': 'error',
+      '@tinymce/prefer-mcagar-tiny-dom': 'error',
+
+      '@typescript-eslint/explicit-module-boundary-types': [ 'error', { allowArgumentsExplicitlyTypedAsAny: true }],
+      '@stylistic/comma-dangle': [ 'error', {
+        arrays: 'only-multiline',
+        objects: 'only-multiline',
+        imports: 'never',
+        exports: 'never',
+        functions: 'never',
+        enums: 'never',
+        generics: 'never',
+        tuples: 'never'
+      }],
+      'arrow-body-style': 'off', // Disabled as it causes readability issues in more complex cases
+      'import-x/order': [ 'error', {
+        'newlines-between': 'always',
+        'groups': [
+          [ 'builtin', 'external' ],
+          'internal',
+          'parent',
+          'sibling',
+          'index'
+        ],
+        'alphabetize': {
+          order: 'asc',
+          caseInsensitive: true
+        }
+      }],
+
+      // Disabled since we're using the stylistic rule
+      'comma-dangle': 'off',
+    },
+    settings: {
+      'import-x/internal-regex': '^(ephox|tinymce|tiny-premium)/.*'
+    }
+  }
+);
+
+export default plugin;