feat: udpate eslint 8.0 to 9.0

Author: haifeng-li-at-salesforce

CONTRIBUTING.md

@@ -72,23 +72,33 @@ Issues labelled `good first contribution`.
 
 # Release Process
 
-### Branching Strategy:
+## Branching Strategy
 
 -   **Main Branch**: Ongoing development and new features are submitted to the `main` branch.
 
--   **Release Branches**: We'll utilize dedicated branches for managing releases.
+-   **Release Branch**: The `release` branch will represent the latest released/releasable code.
 
-    -   **Major Release:**
-        -   Create a new branch named `release-<major version>` (e.g., `release-2` for a `2.0` release) from `main` to manage the release process.
-        -   Update the `.releaserc.json` file: Locate the `branches` property and specify the newly created release branch name (e.g., `release-2`).
-    -   **Minor/Patch Release:**
-        -   We will use existing major release branches (e.g. `release-2`) for subsequent minor and patch releases (e.g. `2.0.1`, `2.1.2`, etc.).
-        -   Once changes are verified and merged into the release branch, they will be merged back to `main`.
+## Preparing for a New Release
 
--   **Trigger Release Manually:**
-    -   Navigate to the `Actions` tab in GitHub repository.
-    -   Select the `release` workflow from the left sidebar.
-    -   Click the `Run workflow` button to initiate the release process.
+-   Code from `main` will be contributed to the `release` branch through a PR. Once reviewed,
+    it will be merged and ready to cut a new release.
+-   This process should be followed for major (`x+1.0.0`) and minor (`x.y+1.0`)
+    releases with new feature sets.
+
+## Preparing a Patch to an Existing Release
+
+-   For patches to an existing release (`x.y.z+1`), PRs will be submitted directly against
+    the `release` branch. Once reviewed, PRs will be merged and ready to cut a new release.
+-   This process will only apply to bug fixes on the `release` branch.
+
+## Cutting a Release
+
+-   This project leverages [`semantic-release`](https://github.com/semantic-release/semantic-release#readme)
+    to automatically determine SemVer versioning and publish the package to npmjs.com.
+-   To trigger a release:
+    -   Navigate to the `Actions` tab in the GitHub repository
+    -   Select the `release` workflow from the left sidebar
+    -   Click the `Run workflow` button to initiate the release process
 
 # Code of Conduct
 

README.md

@@ -18,10 +18,27 @@ $ npm install --save-dev @salesforce/eslint-plugin-lwc-mobile
 
 ## Configuration
 
-Here's an example snippet of a `.eslintrc.json` configuration file, that will configure the `eslint-plugin-lwc-mobile` plugin. Extending the `plugin:@salesforce/lwc-mobile/recommended` ESLint configuration will enable static analysis on all `.js` files used in your Lightning web components.
+### ESLint >= 9
+
+The default configurations are now in the flat config format supported by ESLint 9 and beyond. To include `recommendedConfigs ` in your flat config, spread it into your configuration array. Note that `recommendedConfigs` is a collection of preset configs and must be expanded accordingly.:
+
+```javascript
+// eslint.config.mjs
+import js from '@eslint/js';
+import lwcMobilePlugin from "@salesforce/eslint-plugin-lwc-mobile";
+
+export default [
+    { plugins: { "@salesforce/lwc-mobile": lwcMobilePlugin } },
+    js.configs.recommended,
+    ...lwcMobilePlugin.recommendedConfigs,
+];
+```
+
+### ESLint < 9
+Configurations for legacy ESLint have moved to `-legacy` extensions. Here's an example snippet of a `.eslintrc.json` configuration file, that will configure the `eslint-plugin-lwc-mobile` plugin. Extending the `plugin:@salesforce/lwc-mobile/recommended-legacy` ESLint configuration will enable static analysis on all `.js` files used in your Lightning web components.
 
 ```json
 {
-    "extends": ["eslint:recommended", "plugin:@salesforce/lwc-mobile/recommended"]
+    "extends": ["eslint:recommended", "plugin:@salesforce/lwc-mobile/recommended-legacy"]
 }
 ```

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/eslint-plugin-lwc-mobile",
-    "version": "0.0.1",
+    "version": "1.0.0",
     "description": "ESLint plugin for LWC mobility",
     "contributors": [
         {
@@ -31,7 +31,7 @@
         "url": "https://github.com/salesforce/eslint-plugin-lwc-mobile"
     },
     "scripts": {
-        "clean": "npx rimraf dist reports",
+        "clean": "npx rimraf dist reports tsconfig.tsbuildinfo",
         "build": "npm run clean && tsc",
         "format": "prettier --list-different \"**/*.{ts,js}\"",
         "format:fix": "prettier --write \"**/*.{ts,js,json}\"",
@@ -59,41 +59,39 @@
         "/dist"
     ],
     "dependencies": {
-        "@graphql-eslint/eslint-plugin": "^3.20.1"
+        "@babel/core": "^7.27.4",
+        "@babel/eslint-parser": "^7.27.5",
+        "@graphql-eslint/eslint-plugin": "^3.20.1",
+        "@types/eslint": "^9.6.1",
+        "typescript-eslint": "^8.17.0"
     },
     "devDependencies": {
-        "@commitlint/cli": "^19.5.0",
-        "@commitlint/config-conventional": "^19.5.0",
-        "@eslint/js": "^9.14.0",
+        "@commitlint/cli": "^19.7.1",
+        "@commitlint/config-conventional": "^19.7.1",
+        "@eslint/js": "^9.21.0",
         "@jest/globals": "^29.7.0",
         "@semantic-release/changelog": "^6.0.3",
         "@semantic-release/exec": "^6.0.3",
         "@semantic-release/git": "^10.0.1",
         "@semantic-release/npm": "^12.0.1",
-        "@types/eslint": "^8.56.10",
         "@types/estree": "^1.0.6",
         "@types/jest": "^29.5.14",
-        "@typescript-eslint/eslint-plugin": "^7.8.0",
-        "@typescript-eslint/parser": "^7.18.0",
-        "@typescript-eslint/rule-tester": "^7.8.0",
-        "@typescript-eslint/utils": "^7.8.0",
         "conventional-changelog-conventionalcommits": "^8.0.0",
-        "eslint": "^8.57.0",
-        "eslint-plugin-eslint-plugin": "^6.3.1",
+        "eslint": "^9.28.0",
+        "eslint-plugin-eslint-plugin": "^6.4.0",
         "eslint-plugin-node": "^11.1.0",
-        "husky": "^9.1.6",
+        "husky": "^9.1.7",
         "jest": "^29.7.0",
         "jest-chain": "^1.1.6",
         "jest-extended": "^4.0.1",
         "jest-junit": "^16.0.0",
         "jest-mock-extended": "^3.0.7",
         "jest-sonar-reporter": "^2.0.0",
-        "prettier": "^3.3.3",
-        "semantic-release": "^24.2.0",
-        "ts-jest": "^29.2.5",
+        "prettier": "^3.5.2",
+        "semantic-release": "^24.2.3",
+        "ts-jest": "^29.2.6",
         "ts-node": "^10.9.2",
-        "typescript": "^5.6.3",
-        "typescript-eslint": "^7.8.0"
+        "typescript": "^5.8.2"
     },
     "peerDependencies": {
         "eslint": ">=7"

package.json

@@ -4,8 +4,8 @@
  * SPDX-License-Identifier: MIT
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
-import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';
+import { Linter } from 'eslint';
 
 export = {
     plugins: ['@salesforce/lwc-mobile', '@graphql-eslint']
-} satisfies ClassicConfig.Config;
+} satisfies Linter.BaseConfig;

src/configs/base.ts src/configs/base-legacy.tssrc/configs/base.ts renamed to src/configs/base-legacy.ts

@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+import { Linter } from 'eslint';
+import { APEX_IMPORT_RULE_ID } from '../rules/apex/apex-import.js';
+import { NO_MUTATION_SUPPORTED_RULE_ID } from '../rules/graphql/no-mutation-supported';
+import { NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID } from '../rules/graphql/no-aggregate-query-supported';
+import { UNSUPPORTED_SCOPE_RULE_ID } from '../rules/graphql/unsupported-scope.js';
+import { NO_FISCAL_DATE_FILTER_SUPPORTED_RULE_ID } from '../rules/graphql/no-fiscal-date-filtering-supported.js';
+import { NO_SEMI_ANTI_JOIN_SUPPORTED_RULE_ID } from '../rules/graphql/no-semi-anti-join-supported';
+import { NO_MORE_THAN_1_PARENT_RECORD_RULE_ID } from '../rules/graphql/no-more-than-1-parent-record.js';
+import { NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID } from '../rules/graphql/no-more-than-3-child-entities.js';
+import { NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID } from '../rules/graphql/no-more-than-3-root-entities.js';
+import { NO_MORE_THAN_100_FIELDS_RULE_ID } from '../rules/graphql/no-more-than-100-fields.js';
+import { createScopedModuleRuleName } from '../util/rule-helpers.js';
+
+export = {
+    extends: ['./configs/base-legacy'],
+    parser: '@babel/eslint-parser',
+    parserOptions: {
+        requireConfigFile: false,
+        babelOptions: {
+            parserOpts: {
+                plugins: [['decorators', { decoratorsBeforeExport: false }]]
+            }
+        },
+        ecmaVersion: 'latest',
+        sourceType: 'module'
+    },
+    rules: {
+        [createScopedModuleRuleName(APEX_IMPORT_RULE_ID)]: 'warn'
+    },
+    overrides: [
+        {
+            files: ['*.js'],
+            processor: '@graphql-eslint/graphql'
+        },
+        {
+            files: ['*.graphql'],
+            parser: '@graphql-eslint/eslint-plugin',
+
+            parserOptions: {
+                skipGraphQLConfig: true
+            },
+            rules: {
+                [createScopedModuleRuleName(NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID)]: 'warn',
+                [createScopedModuleRuleName(NO_FISCAL_DATE_FILTER_SUPPORTED_RULE_ID)]: 'warn',
+                [createScopedModuleRuleName(NO_MUTATION_SUPPORTED_RULE_ID)]: 'warn',
+                [createScopedModuleRuleName(NO_SEMI_ANTI_JOIN_SUPPORTED_RULE_ID)]: 'warn',
+                [createScopedModuleRuleName(NO_MORE_THAN_1_PARENT_RECORD_RULE_ID)]: 'warn',
+                [createScopedModuleRuleName(NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID)]: 'warn',
+                [createScopedModuleRuleName(NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID)]: 'warn',
+                [createScopedModuleRuleName(NO_MORE_THAN_100_FIELDS_RULE_ID)]: 'warn',
+                [createScopedModuleRuleName(UNSUPPORTED_SCOPE_RULE_ID)]: 'warn'
+            }
+        }
+    ]
+} satisfies Linter.BaseConfig;

src/configs/recommended-legacy.ts

@@ -4,7 +4,9 @@
  * SPDX-License-Identifier: MIT
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
-import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';
+
+import { Linter } from 'eslint';
+
 import { APEX_IMPORT_RULE_ID } from '../rules/apex/apex-import.js';
 import { NO_MUTATION_SUPPORTED_RULE_ID } from '../rules/graphql/no-mutation-supported';
 import { NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID } from '../rules/graphql/no-aggregate-query-supported';
@@ -16,35 +18,51 @@ import { NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID } from '../rules/graphql/no-more-
 import { NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID } from '../rules/graphql/no-more-than-3-root-entities.js';
 import { NO_MORE_THAN_100_FIELDS_RULE_ID } from '../rules/graphql/no-more-than-100-fields.js';
 import { createScopedModuleRuleName } from '../util/rule-helpers.js';
+import { parseForESLint as parseForESLintGraphQL } from '@graphql-eslint/eslint-plugin';
+import { parseForESLint as parseForESLintBabel, parse } from '@babel/eslint-parser';
+import { processors } from '@graphql-eslint/eslint-plugin';
 
-export = {
-    extends: ['./configs/base'],
-    rules: {
-        [createScopedModuleRuleName(APEX_IMPORT_RULE_ID)]: 'warn'
-    },
-    overrides: [
-        {
-            files: ['*.js'],
-            processor: '@graphql-eslint/graphql'
+const configs: Linter.Config[] = [
+    {
+        files: ['*.js', '**/*.js'],
+        languageOptions: {
+            parser: { parseForESLint: parseForESLintBabel, parse },
+            parserOptions: {
+                requireConfigFile: false,
+                babelOptions: {
+                    parserOpts: {
+                        plugins: [['decorators', { decoratorsBeforeExport: false }]]
+                    }
+                },
+                ecmaVersion: 'latest',
+                sourceType: 'module'
+            }
         },
-        {
-            files: ['*.graphql'],
-            parser: '@graphql-eslint/eslint-plugin',
-
+        processor: processors.graphql,
+        rules: {
+            [createScopedModuleRuleName(APEX_IMPORT_RULE_ID)]: 'warn'
+        }
+    },
+    {
+        files: ['*.graphql', '**/*.graphql'],
+        languageOptions: {
+            parser: { parseForESLint: parseForESLintGraphQL },
             parserOptions: {
                 skipGraphQLConfig: true
-            },
-            rules: {
-                [createScopedModuleRuleName(NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID)]: 'warn',
-                [createScopedModuleRuleName(NO_FISCAL_DATE_FILTER_SUPPORTED_RULE_ID)]: 'warn',
-                [createScopedModuleRuleName(NO_MUTATION_SUPPORTED_RULE_ID)]: 'warn',
-                [createScopedModuleRuleName(NO_SEMI_ANTI_JOIN_SUPPORTED_RULE_ID)]: 'warn',
-                [createScopedModuleRuleName(NO_MORE_THAN_1_PARENT_RECORD_RULE_ID)]: 'warn',
-                [createScopedModuleRuleName(NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID)]: 'warn',
-                [createScopedModuleRuleName(NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID)]: 'warn',
-                [createScopedModuleRuleName(NO_MORE_THAN_100_FIELDS_RULE_ID)]: 'warn',
-                [createScopedModuleRuleName(UNSUPPORTED_SCOPE_RULE_ID)]: 'warn'
             }
+        },
+        rules: {
+            [createScopedModuleRuleName(NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID)]: 'warn',
+            [createScopedModuleRuleName(NO_FISCAL_DATE_FILTER_SUPPORTED_RULE_ID)]: 'warn',
+            [createScopedModuleRuleName(NO_MUTATION_SUPPORTED_RULE_ID)]: 'warn',
+            [createScopedModuleRuleName(NO_SEMI_ANTI_JOIN_SUPPORTED_RULE_ID)]: 'warn',
+            [createScopedModuleRuleName(NO_MORE_THAN_1_PARENT_RECORD_RULE_ID)]: 'warn',
+            [createScopedModuleRuleName(NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID)]: 'warn',
+            [createScopedModuleRuleName(NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID)]: 'warn',
+            [createScopedModuleRuleName(NO_MORE_THAN_100_FIELDS_RULE_ID)]: 'warn',
+            [createScopedModuleRuleName(UNSUPPORTED_SCOPE_RULE_ID)]: 'warn'
         }
-    ]
-} satisfies ClassicConfig.Config;
+    }
+];
+
+export = configs;

src/configs/recommended.ts

@@ -1,10 +1,11 @@
 # apex-import
 
-Using Apex in LWC Offline-enabled mobile apps requires additional considerations to ensure proper functioning in offline scenarios.
+Using Apex in LWC Offline-enabled mobile apps requires additional considerations to ensure proper functioning in offline scenarios. Consider using GraphQL for mobile offline use cases.
 
-When a client device is offline, Apex-based features can read data that was cached while online, but changes (writing data) can’t be saved back to the server. Nor can a change via Apex methods be enqueued as a draft into the Offline Queue. A Lightning web component that uses Apex must be prepared to handle a network connection error as a normal response, for both reading and writing operations.
-
-See [Use Apex While Mobile and Offline](https://developer.salesforce.com/docs/atlas.en-us.mobile_offline.meta/mobile_offline/apex.htm) for more details.
+GraphQL is a flexible, powerful query language for accessing record and other data. You can think of GraphQL as SQL for your API, the query language for relational databases.
 
+Developers like GraphQL for modern web applications because, in contrast to many REST and CRUD-oriented APIs, GraphQL allows for expressive queries, with features like filtering and scopes, ordering and aggregation, pagination, and relationship traversal to related records. A single query can retrieve many records, and even records of multiple types. Using fewer queries reduces the number of server requests required to load data, which can improve performance. A GraphQL query can specify precisely and only the fields required for a given component, reducing the amount of data that needs to be transmitted before a page can render.
 
+For mobile developers building apps that work while offline, however, there is only one implementation that matters: Offline GraphQL.
 
+See [Use GraphQL While Mobile and Offline](https://developer.salesforce.com/docs/atlas.en-us.mobile_offline.meta/mobile_offline/apex.htm) and [GraphQL Wire Adapter for LWC](https://developer.salesforce.com/docs/platform/graphql/guide/graphql-wire-lwc.html) for more details.