[DEV-18547] Feature - Support ESLint v9

.github/workflows/test.yml

@@ -0,0 +1,70 @@
+name: Smoke Test
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        branches:
+            - main
+
+jobs:
+    lint:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout the repository
+              uses: actions/checkout@v4
+
+            - name: Setup environment
+              uses: prezly/setup-github-actions@v1
+              with:
+                  pnpm: 9.7.0
+                  node: 20
+
+            - name: Install dependencies
+              run: pnpm install
+
+            - name: Run ESLint on should-fail
+              id: eslint_should_fail
+              run: |
+                  cd tests/should-fail
+                  pnpm lint
+                  lint_exit_code=$?
+                  echo "The exit code of pnpm lint for should-fail is: $lint_exit_code"
+                  echo "lint_exit_code=$lint_exit_code" >> $GITHUB_ENV
+              continue-on-error: true
+
+            - name: Evaluate ESLint result for should-fail
+              run: |
+                  if [ -n "$lint_exit_code" ]; then
+                      echo "ESLint for should-fail passed unexpectedly. Marking this as a failure."
+                      exit 1
+                  else
+                      echo "ESLint for should-fail failed as expected. Marking this as a success."
+                      exit 0
+                  fi
+              env:
+                  lint_exit_code: ${{ env.lint_exit_code }}
+
+            - name: Run ESLint on should-pass
+              id: eslint_should_pass
+              run: |
+                  cd tests/should-pass
+                  pnpm lint
+                  lint_exit_code=$?
+                  echo "The exit code of pnpm lint for should-pass is: $lint_exit_code"
+                  echo "lint_exit_code=$lint_exit_code" >> $GITHUB_ENV
+              continue-on-error: true
+
+            - name: Evaluate ESLint result for should-pass
+              run: |
+                  if [ "$lint_exit_code" -eq 0 ]; then
+                      echo "ESLint for should-pass passed as expected. Marking this as a success."
+                      exit 0
+                  else
+                      echo "ESLint for should-pass failed unexpectedly. Marking this as a failure."
+                      exit 1
+                  fi
+              env:
+                  lint_exit_code: ${{ env.lint_exit_code }}

lib/index.js

@@ -1,94 +1,130 @@
-const importOrderConfig = require("./rule-configs/import-order/base.js");
-const namingConventionConfig = require("./rule-configs/naming-convention/base.js");
+//@ts-check
+import importOrderConfig from "./rule-configs/import-order/base.js";
+import namingConventionConfig from "./rule-configs/naming-convention/base.js";
+import typescriptEslintPlugin from "@typescript-eslint/eslint-plugin";
+import prettierPlugin from "eslint-plugin-prettier";
+import sortExportAllPlugin from "eslint-plugin-sort-export-all";
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import eslintConfigPrettier from "eslint-config-prettier";
 
-module.exports = {
-    env: {
-        browser: true,
-        es2021: true,
-        node: true,
+//@ts-ignore -- Package provides no types.
+import reactRefresh from "eslint-plugin-react-refresh";
+//@ts-ignore -- Package provides no types.
+import importPlugin from "eslint-plugin-import";
+
+export default tseslint.config(
+    {
+        ignores: ["dist"],
     },
-    extends: ["airbnb-base", "airbnb-typescript/base", "prettier"],
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaFeatures: {
-            jsx: true,
+    {
+        extends: [js.configs.recommended, ...tseslint.configs.recommended],
+        files: ["**/*.{ts,tsx,js,jsx,mjs}"],
+        languageOptions: {
+            ecmaVersion: 2020,
+            parserOptions: {
+                projectService: true,
+            },
+            globals: {
+                ...globals.browser,
+                ...globals.node,
+            },
+        },
+        plugins: {
+            "react-refresh": reactRefresh,
+        },
+        rules: {
+            "react-refresh/only-export-components": [
+                "warn",
+                { allowConstantExport: true },
+            ],
         },
-        ecmaVersion: 12,
-        sourceType: "module",
-        project: ["./tsconfig.json"],
     },
-    plugins: [
-        "@typescript-eslint",
-        "prettier",
-        "import",
-        "sort-export-all",
-        "deprecation",
-    ],
-    rules: {
-        // Prettier handles indent, whitespace and empty lines
-        "prettier/prettier": 2,
+    {
+        plugins: {
+            "@typescript-eslint": typescriptEslintPlugin,
+            prettier: prettierPlugin,
+            import: importPlugin,
+            "sort-export-all": sortExportAllPlugin,
+        },
+        rules: {
+            // Prettier rules
+            "prettier/prettier": 2,
 
-        // Warn about deprecated methods and properties
-        "deprecation/deprecation": "warn",
+            // Warn about deprecated methods and properties
+            "@typescript-eslint/no-deprecated": "warn",
 
-        // Import rules
-        "sort-export-all/sort-export-all": [
-            "error",
-            "asc",
-            {
-                caseSensitive: false,
-                natural: false,
-            },
-        ],
-        "import/extensions": [
-            "error",
-            "never",
-            { svg: "always", json: "always", css: "always", scss: "always" },
-        ],
-        "import/order": ["error", importOrderConfig],
-        "import/prefer-default-export": "off",
-        "import/no-default-export": "error",
-        "import/no-extraneous-dependencies": "error",
-        "sort-imports": [
-            "error",
-            {
-                ignoreCase: true,
-                ignoreDeclarationSort: true,
-                ignoreMemberSort: false,
-                memberSyntaxSortOrder: ["none", "all", "multiple", "single"],
-            },
-        ],
+            // Import rules
+            "sort-export-all/sort-export-all": [
+                "error",
+                "asc",
+                {
+                    caseSensitive: false,
+                    natural: false,
+                },
+            ],
+            "import/extensions": [
+                "error",
+                "never",
+                {
+                    svg: "always",
+                    json: "always",
+                    css: "always",
+                    scss: "always",
+                },
+            ],
+            "import/order": ["error", importOrderConfig],
+            "import/prefer-default-export": "off",
+            "import/no-default-export": "error",
+            "import/no-extraneous-dependencies": "error",
+            "sort-imports": [
+                "error",
+                {
+                    ignoreCase: true,
+                    ignoreDeclarationSort: true,
+                    ignoreMemberSort: false,
+                    memberSyntaxSortOrder: [
+                        "none",
+                        "all",
+                        "multiple",
+                        "single",
+                    ],
+                },
+            ],
 
-        // General code-style rules
-        "@typescript-eslint/naming-convention": namingConventionConfig,
-        "id-blacklist": [
-            2,
-            "arr",
-            "cb",
-            "e",
-            "el",
-            "err",
-            "idx",
-            "num",
-            "str",
-            "tmp",
-            "val",
-        ],
-        "no-return-assign": ["error", "except-parens"],
-        "no-unused-vars": "off",
-        "@typescript-eslint/no-unused-vars": [
-            "error",
-            { argsIgnorePattern: "^_", ignoreRestSiblings: true },
-        ],
-        "@typescript-eslint/consistent-type-imports": "error",
-        "@typescript-eslint/no-import-type-side-effects": "error",
+            // General code-style rules
+            // @ts-ignore
+            "@typescript-eslint/naming-convention": namingConventionConfig,
+            "id-blacklist": [
+                2,
+                "arr",
+                "cb",
+                "e",
+                "el",
+                "err",
+                "idx",
+                "num",
+                "str",
+                "tmp",
+                "val",
+            ],
+            "no-return-assign": ["error", "except-parens"],
+            "no-unused-vars": "off",
+            "@typescript-eslint/no-unused-vars": [
+                "error",
+                { argsIgnorePattern: "^_", ignoreRestSiblings: true },
+            ],
+            "@typescript-eslint/consistent-type-imports": "error",
+            "@typescript-eslint/no-import-type-side-effects": "error",
 
-        "prefer-destructuring": "warn",
-        "no-nested-ternary": "warn",
+            "prefer-destructuring": "warn",
+            "no-nested-ternary": "warn",
 
-        "func-style": ["error", "declaration"],
+            "func-style": ["error", "declaration"],
 
-        // Extra rules
-        radix: "off",
+            radix: "off",
+        },
     },
-};
+    eslintConfigPrettier,
+);

lib/nextjs-tailwind.js

@@ -1,10 +1,12 @@
-const importOrderConfig = require("./rule-configs/import-order/next.js");
-const namingConventionConfig = require("./rule-configs/naming-convention/next-tailwind.js");
+import namingConventionConfig from "./rule-configs/naming-convention/next-tailwind.js";
+import nextJsConfig from "./nextjs.js";
 
-module.exports = {
-    extends: [require.resolve("./nextjs.js")],
-    rules: {
-        // General code-style rules
-        "@typescript-eslint/naming-convention": namingConventionConfig,
+export default [
+    ...nextJsConfig,
+    {
+        files: ["**/*.{ts,tsx,js,jsx}"],
+        rules: {
+            "@typescript-eslint/naming-convention": namingConventionConfig,
+        },
     },
-};
+];