feat: support static analyzer with version 260.31.0

haifeng-li-at-salesforce · haifeng-li-at-salesforce · commit b25d749fdeae · 2025-11-04T14:07:46.000-08:00
diff --git a/README.md b/README.md
@@ -33,13 +33,32 @@ ESLint version-specific configuration examples are provided below. Here are some
 
 The default configurations are now in the flat config format supported by ESLint 9 and beyond. Here's how to include the `recommended` config in your flat config:
 
+```javascript
+// eslint.config.js
+const { defineConfig } = require("eslint/config");
+const lwcGraphAnalyzerPlugin = require("@salesforce/eslint-plugin-lwc-graph-analyzer");
+
+module.exports = defineConfig([
+    {
+        plugins: {
+            "@salesforce/lwc-graph-analyzer": lwcGraphAnalyzerPlugin,
+        },
+        extends: [lwcGraphAnalyzerPlugin.configs.recommended],
+    },
+]);
+```
+
 ```javascript
 // eslint.config.mjs
 import js from '@eslint/js';
 import lwcGraphAnalyzerPlugin from '@salesforce/eslint-plugin-lwc-graph-analyzer';
 
 export default [
-    { plugins: { '@salesforce/lwc-graph-analyzer': lwcGraphAnalyzerPlugin } },
+    { 
+        plugins: { 
+            '@salesforce/lwc-graph-analyzer': lwcGraphAnalyzerPlugin 
+        }
+    },
     js.configs.recommended,
     lwcGraphAnalyzerPlugin.configs.recommended
 ];
diff --git a/package.json b/package.json
@@ -1,100 +1,100 @@
 {
-  "name": "@salesforce/eslint-plugin-lwc-graph-analyzer",
-  "version": "1.0.0",
-  "description": "ESLint plugin to analyze data graph in a LWC component",
-  "contributors": [
-    {
-      "name": "Andrew Huffman",
-      "url": "https://github.com/AndrewHuffman"
+    "name": "@salesforce/eslint-plugin-lwc-graph-analyzer",
+    "version": "1.1.0",
+    "description": "ESLint plugin to analyze data graph in a LWC component",
+    "contributors": [
+        {
+            "name": "Andrew Huffman",
+            "url": "https://github.com/AndrewHuffman"
+        },
+        {
+            "name": "Kevin Hawkins",
+            "url": "https://github.com/khawkins"
+        },
+        {
+            "name": "Meisam Seyed Aliroteh",
+            "url": "https://github.com/maliroteh-sf"
+        },
+        {
+            "name": "Takashi Arai",
+            "url": "https://github.com/sfdctaka"
+        },
+        {
+            "name": "Dustin Breese",
+            "url": "https://github.com/dbreese"
+        }
+    ],
+    "homepage": "https://github.com/salesforce/eslint-plugin-lwc-graph-analyzer",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce/eslint-plugin-lwc-graph-analyzer.git"
     },
-    {
-      "name": "Kevin Hawkins",
-      "url": "https://github.com/khawkins"
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "directories": {
+        "lib": "lib",
+        "rules": "lib/rules",
+        "test": "test"
     },
-    {
-      "name": "Meisam Seyed Aliroteh",
-      "url": "https://github.com/maliroteh-sf"
+    "files": [
+        "lib/**/*",
+        "!**/test/**"
+    ],
+    "devDependencies": {
+        "@eslint/js": "^9.30.1",
+        "@typescript-eslint/parser": "^8.35.1",
+        "chai": "^4.5.0",
+        "eslint": "^9.28.0",
+        "eslint-plugin-eslint-plugin": "^6.5.0",
+        "eslint-plugin-n": "^17.20.0",
+        "husky": "^9.1.7",
+        "jest": "^29.7.0",
+        "jest-chain": "^1.1.6",
+        "jest-extended": "^4.0.2",
+        "jest-junit": "^16.0.0",
+        "jest-sonar-reporter": "^2.0.0",
+        "prettier": "^3.6.2",
+        "typescript": "^5.8.3",
+        "typescript-eslint": "^8.35.1"
     },
-    {
-      "name": "Takashi Arai",
-      "url": "https://github.com/sfdctaka"
+    "dependencies": {
+        "@babel/core": "^7.28.0",
+        "@babel/eslint-parser": "^7.28.0",
+        "@komaci/static-analyzer": "^260.31.0",
+        "@lwc/errors": "^8.21.1",
+        "@lwc/metadata": "^12.0.0",
+        "@lwc/sfdc-compiler-utils": "^12.0.0",
+        "@lwc/template-compiler": "^8.21.1",
+        "@types/eslint": "^9.6.1"
     },
-    {
-      "name": "Dustin Breese",
-      "url": "https://github.com/dbreese"
+    "scripts": {
+        "format": "prettier --list-different \"**/*.js\"",
+        "format:fix": "prettier --write \"**/*.{js,json}\"",
+        "lint": "eslint",
+        "test": "yarn jest --coverage",
+        "prepare": "husky"
+    },
+    "jestSonar": {
+        "sonar56x": true,
+        "reportPath": "reports/coverage",
+        "reportFile": "sonar-report.xml",
+        "indent": 4
+    },
+    "prettier": {
+        "printWidth": 100,
+        "tabWidth": 4,
+        "singleQuote": true,
+        "trailingComma": "none"
+    },
+    "engines": {
+        "node": ">=20"
+    },
+    "peerDependencies": {
+        "eslint": ">=7"
+    },
+    "volta": {
+        "node": "20.18.0",
+        "yarn": "1.22.22"
     }
-  ],
-  "homepage": "https://github.com/salesforce/eslint-plugin-lwc-graph-analyzer",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/salesforce/eslint-plugin-lwc-graph-analyzer.git"
-  },
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "directories": {
-    "lib": "lib",
-    "rules": "lib/rules",
-    "test": "test"
-  },
-  "files": [
-    "lib/**/*",
-    "!**/test/**"
-  ],
-  "devDependencies": {
-    "@eslint/js": "^9.30.1",
-    "@typescript-eslint/parser": "^8.35.1",
-    "chai": "^4.5.0",
-    "eslint": "^9.28.0",
-    "eslint-plugin-eslint-plugin": "^6.5.0",
-    "eslint-plugin-n": "^17.20.0",
-    "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "jest-chain": "^1.1.6",
-    "jest-extended": "^4.0.2",
-    "jest-junit": "^16.0.0",
-    "jest-sonar-reporter": "^2.0.0",
-    "prettier": "^3.6.2",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.35.1"
-  },
-  "dependencies": {
-    "@babel/core": "^7.28.0",
-    "@babel/eslint-parser": "^7.28.0",
-    "@komaci/static-analyzer": "^252.1.0",
-    "@lwc/errors": "~3.5.0",
-    "@lwc/metadata": "3.5.0-0",
-    "@lwc/sfdc-compiler-utils": "3.5.0-0",
-    "@lwc/template-compiler": "~3.5.0",
-    "@types/eslint": "^9.6.1"
-  },
-  "scripts": {
-    "format": "prettier --list-different \"**/*.js\"",
-    "format:fix": "prettier --write \"**/*.{js,json}\"",
-    "lint": "eslint",
-    "test": "yarn jest --coverage",
-    "prepare": "husky"
-  },
-  "jestSonar": {
-    "sonar56x": true,
-    "reportPath": "reports/coverage",
-    "reportFile": "sonar-report.xml",
-    "indent": 4
-  },
-  "prettier": {
-    "printWidth": 100,
-    "tabWidth": 4,
-    "singleQuote": true,
-    "trailingComma": "none"
-  },
-  "engines": {
-    "node": ">=20"
-  },
-  "peerDependencies": {
-    "eslint": ">=7"
-  },
-  "volta": {
-    "node": "20.18.0",
-    "yarn": "1.22.22"
-  }
 }
diff --git a/test/lib/rules/artifacts-combined-files/.DS_Store b/test/lib/rules/artifacts-combined-files/.DS_Store
diff --git a/test/lib/rules/artifacts-combined-files/fileUpload/test.js b/test/lib/rules/artifacts-combined-files/fileUpload/test.js
@@ -27,6 +27,7 @@ export default class FileUpload extends LightningElement {
 
     /* eslint-disable */
     get fileName() {
+        // This getter voilates the rule no-getter-contains-more-than-return-statement since it is referenced in the template html
         const file = this.files && this.files[0];
         if (file) {
             return file.name;
@@ -35,17 +36,16 @@ export default class FileUpload extends LightningElement {
     }
     /* eslint-enable */
 
-    /* eslint-disable @salesforce/lwc-graph-analyzer/no-getter-contains-more-than-return-statement */
+    // No longer voilating the rule no-getter-contains-more-than-return-statement
     get fileName1() {
         const file = this.files && this.files[0];
         if (file) {
             return file.name;
         }
         return undefined;
     }
-    /* eslint-enable @salesforce/lwc-graph-analyzer/no-getter-contains-more-than-return-statement */
 
-    // eslint-disable-next-line
+    // No longer voilating the rule no-getter-contains-more-than-return-statement
     get fileName2() {
         const file = this.files && this.files[0];
         if (file) {
@@ -54,7 +54,7 @@ export default class FileUpload extends LightningElement {
         return undefined;
     }
 
-    // eslint-disable-next-line @salesforce/lwc-graph-analyzer/no-getter-contains-more-than-return-statement
+    // No longer voilating the rule no-getter-contains-more-than-return-statement
     get fileName3() {
         const file = this.files && this.files[0];
         if (file) {
@@ -64,7 +64,8 @@ export default class FileUpload extends LightningElement {
     }
 
     // prettier-ignore
-    get fileName4() { // eslint-disable-line
+    // No longer voilating the rule no-getter-contains-more-than-return-statement
+    get fileName4() { 
         const file = this.files && this.files[0];
         if (file) {
             return file.name;
@@ -73,7 +74,7 @@ export default class FileUpload extends LightningElement {
     }
 
     // prettier-ignore
-    get fileName5() { // eslint-disable-line @salesforce/lwc-graph-analyzer/no-getter-contains-more-than-return-statement
+    get fileName5() {
         const file = this.files && this.files[0];
         if (file) {
             return file.name;
diff --git a/test/lib/rules/artifacts-combined-files/helper.js b/test/lib/rules/artifacts-combined-files/helper.js
@@ -54,7 +54,11 @@ function lintBundle(rulePath, target) {
     const srcCode = readFileSync(testPath).toString();
 
     const linter = new Linter();
-    return linter.verify(srcCode, config, { filename: testPath, filterCodeBlock });
+    return linter.verify(srcCode, config, {
+        filename: testPath,
+        filterCodeBlock,
+        reportUnusedDisableDirectives: false
+    });
 }
 
 /**
@@ -76,7 +80,8 @@ function lintProgrammaticBundle(rulePath, target) {
     const linter = new Linter();
     return linter.verify(srcCode, config, {
         filename: testPath,
-        filterCodeBlock
+        filterCodeBlock,
+        reportUnusedDisableDirectives: false
     });
 }
 
diff --git a/test/lib/rules/no-expression-contains-module-level-variable-ref.js b/test/lib/rules/no-expression-contains-module-level-variable-ref.js
@@ -36,6 +36,9 @@ ruleTester.run(
                     testFunction(val){
                         return val;
                     }
+
+                    @wire(findContacts, { searchKey: '$searchKey' })
+                    contacts;
                 }`,
                 filename: 'lwc-code.js',
                 errors: [
diff --git a/test/lib/rules/no-getter-contains-more-than-return-statement.js b/test/lib/rules/no-getter-contains-more-than-return-statement.js
@@ -36,9 +36,7 @@ ruleTester.run(
                     }
                 
                     @wire(getRecord, { recordId: '$config' })
-                    record(value) {
-                        console.log(value);
-                    }
+                    record1;
                 
                     @wire(getRecord, { recordId: '$myObjLiteral.prop2' })
                     record2;
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,7 @@ ruleTester.run(`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`@wire(getRecord, { recordId: '$config' })`
`39`		`- record(value) {`
`40`		`- console.log(value);`
`41`		`- }`
	`39`	`+ record1;`
`42`	`40`
`43`	`41`	`@wire(getRecord, { recordId: '$myObjLiteral.prop2' })`
`44`	`42`	`record2;`