JS-236 Add eslint-plugin-sonarjs compatibility with ESLint 9 (#4758)

.cirrus.yml

@@ -65,7 +65,8 @@ npmrc_script_definition: &NPMRC_SCRIPT_DEFINITION
   npmrc_script:
     - cp .cirrus/npmrc $CIRRUS_WORKING_DIR/.npmrc
     - cp .cirrus/npmrc $CIRRUS_WORKING_DIR/packages/jsts/src/rules/.npmrc
-    - cp .cirrus/npmrc $CIRRUS_WORKING_DIR/its/eslint-plugin-sonarjs/.npmrc
+    - cp .cirrus/npmrc $CIRRUS_WORKING_DIR/its/eslint8-plugin-sonarjs/.npmrc
+    - cp .cirrus/npmrc $CIRRUS_WORKING_DIR/its/eslint9-plugin-sonarjs/.npmrc
 
 win_ssd_and_clone:
   &WIN_SSD_AND_CLONE # copy&paste from https://github.com/SonarSource/sonar-cpp/blob/a8c6f1e45a12393508682a013ac7ee35eb92bece/.cirrus.yml#L45
@@ -306,8 +307,13 @@ eslint_plugin_test_task:
     - source set_maven_build_version $BUILD_NUMBER
     - cd packages/jsts/src/rules
     - npm run build
-    - cd ../../../../its/eslint-plugin-sonarjs
+    - cd ../../../../its/eslint8-plugin-sonarjs
     - npm run build
+    - npx tsc --noEmit # check typings for tseslint.config.ts
+    - npm run test
+    - cd ../eslint9-plugin-sonarjs
+    - npm run build
+    - npx tsc --noEmit # check typings for tseslint.config.ts
     - npm run test
 
 css_ruling_task:

.gitignore

@@ -46,4 +46,5 @@ Desktop.ini
 
 # eslint-plugin-sonarjs
 eslint-plugin-sonarjs-*.tgz
-its/eslint-plugin-sonarjs/package-lock.json
+its/eslint8-plugin-sonarjs/package-lock.json
+its/eslint9-plugin-sonarjs/package-lock.json

its/eslint-plugin-sonarjs/index.test.js → its/eslint8-plugin-sonarjs/index.test.js

@@ -8,6 +8,7 @@ test('should work with CommonJS config', async t => {
     encoding: 'utf-8',
   });
   const output = result.stdout;
+  console.log(output);
   const errorLines = output.split('\n').filter(line => line.includes('error'));
   assert(errorLines.length > 4);
 });
@@ -18,6 +19,18 @@ test('should work with ECMAScript modules config', async t => {
     encoding: 'utf-8',
   });
   const output = result.stdout;
+  console.log(output);
+  const errorLines = output.split('\n').filter(line => line.includes('error'));
+  assert(errorLines.length > 4);
+});
+
+test('should work with TSESLint config', async t => {
+  const result = spawn.sync('npx', ['eslint', '-c', 'tseslint.config.mjs', 'file.js'], {
+    cwd: __dirname,
+    encoding: 'utf-8',
+  });
+  const output = result.stdout;
+  console.log(output);
   const errorLines = output.split('\n').filter(line => line.includes('error'));
   assert(errorLines.length > 4);
 });

its/eslint-plugin-sonarjs/package.json → its/eslint8-plugin-sonarjs/package.json

@@ -1,12 +1,14 @@
 {
-  "name": "eslint-plugin-sonarjs-tests",
+  "name": "eslint8-plugin-sonarjs-tests",
   "description": "Test suite for eslint-plugin-sonarjs",
   "scripts": {
     "build": "npm install && cp ../../packages/jsts/src/rules/lib/eslint-plugin-sonarjs-* ./plugin.tgz && npm i ./plugin.tgz --no-save && rm -f plugin.tgz",
     "test": "node index.test.js"
   },
   "devDependencies": {
     "cross-spawn": "7.0.3",
-    "eslint": "8.57.0"
+    "eslint": "8.57.0",
+    "typescript": "5.5.4",
+    "typescript-eslint": "7.16.1"
   }
 }

its/eslint8-plugin-sonarjs/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "target": "es6",
+    "allowJs": true,
+    "moduleResolution": "NodeNext"
+  },
+  "files": ["tseslint.config.mjs"]
+}

its/eslint8-plugin-sonarjs/tseslint.config.mjs

@@ -0,0 +1,8 @@
+// @ts-check
+
+import plugin from 'eslint-plugin-sonarjs';
+import tseslint from 'typescript-eslint';
+
+console.log(`Loaded ${Object.keys(plugin.configs.recommended.rules).length} rules`);
+
+export default tseslint.config(plugin.configs.recommended);

its/eslint9-plugin-sonarjs/eslint.config.cjs

@@ -0,0 +1,12 @@
+const plugin = require('eslint-plugin-sonarjs');
+
+console.log(`Loaded ${Object.keys(plugin.configs.recommended.rules).length} rules`);
+
+module.exports = [
+  {
+    files: ['./*.js'],
+    languageOptions: { sourceType: 'commonjs' },
+  },
+  plugin.configs.recommended,
+  { rules: { 'sonarjs/accessor-pairs': 'error' } },
+];

its/eslint9-plugin-sonarjs/eslint.config.mjs

@@ -0,0 +1,12 @@
+import plugin from 'eslint-plugin-sonarjs';
+
+console.log(`Loaded ${Object.keys(plugin.configs.recommended.rules).length} rules`);
+
+export default [
+  {
+    files: ['./*.js'],
+    languageOptions: { sourceType: 'commonjs' },
+  },
+  plugin.configs.recommended,
+  { rules: { 'sonarjs/accessor-pairs': 'error' } },
+];

its/eslint9-plugin-sonarjs/file.js

@@ -0,0 +1,43 @@
+function S3776(foo) {
+  if (foo.bar) {
+    if (foo.baz) {
+      if (foo.qux) {
+        if (foo.fred) {
+          if (foo.thud) {
+            if (foo.abc) {
+              foo.bcd();
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+function S2703(foo) {
+  if (x == 0) {
+    x = 42;
+  }
+}
+
+function S2376() {
+  class C {
+    set m(a) {
+      this.a = a;
+    }
+  }
+}
+
+/*
+
+function S125() {
+  class C {
+    set m(a) {
+      this.a = a;
+    }
+  }
+}
+
+ */
+
+// if (something) {}

its/eslint9-plugin-sonarjs/index.test.js

@@ -0,0 +1,36 @@
+const { test } = require('node:test');
+const assert = require('node:assert');
+const spawn = require('cross-spawn');
+
+test('should work with CommonJS config', async t => {
+  const result = spawn.sync('npx', ['eslint', '-c', 'eslint.config.cjs', 'file.js'], {
+    cwd: __dirname,
+    encoding: 'utf-8',
+  });
+  const output = result.stdout;
+  console.log(output);
+  const errorLines = output.split('\n').filter(line => line.includes('error'));
+  assert(errorLines.length > 4);
+});
+
+test('should work with ECMAScript modules config', async t => {
+  const result = spawn.sync('npx', ['eslint', '-c', 'eslint.config.mjs', 'file.js'], {
+    cwd: __dirname,
+    encoding: 'utf-8',
+  });
+  const output = result.stdout;
+  console.log(output);
+  const errorLines = output.split('\n').filter(line => line.includes('error'));
+  assert(errorLines.length > 4);
+});
+
+test('should work with TSESLint config', async t => {
+  const result = spawn.sync('npx', ['eslint', '-c', 'tseslint.config.mjs', 'file.js'], {
+    cwd: __dirname,
+    encoding: 'utf-8',
+  });
+  const output = result.stdout;
+  console.log(output);
+  const errorLines = output.split('\n').filter(line => line.includes('error'));
+  assert(errorLines.length > 4);
+});

its/eslint9-plugin-sonarjs/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "eslint9-plugin-sonarjs-tests",
+  "description": "Test suite for eslint-plugin-sonarjs",
+  "scripts": {
+    "build": "npm install && cp ../../packages/jsts/src/rules/lib/eslint-plugin-sonarjs-* ./plugin.tgz && npm i ./plugin.tgz --no-save && rm -f plugin.tgz",
+    "test": "node index.test.js"
+  },
+  "devDependencies": {
+    "cross-spawn": "7.0.3",
+    "eslint": "8.57.0",
+    "typescript": "5.5.4",
+    "typescript-eslint": "7.16.1"
+  }
+}

its/eslint9-plugin-sonarjs/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "target": "es6",
+    "allowJs": true,
+    "moduleResolution": "NodeNext"
+  },
+  "files": ["tseslint.config.mjs"]
+}

its/eslint9-plugin-sonarjs/tseslint.config.mjs

@@ -0,0 +1,8 @@
+// @ts-check
+
+import plugin from 'eslint-plugin-sonarjs';
+import tseslint from 'typescript-eslint';
+
+console.log(`Loaded ${Object.keys(plugin.configs.recommended.rules).length} rules`);
+
+export default tseslint.config(plugin.configs.recommended);

its/ruling/src/test/expected/jsts/ag-grid/typescript-S2933.json

@@ -43,11 +43,11 @@
 17
 ],
 "ag-grid:src/ts/componentProvider.ts": [
-56,
-59,
-62,
-65,
-69
+57,
+60,
+63,
+66,
+70
 ],
 "ag-grid:src/ts/context/beanStub.ts": [
 10
@@ -118,16 +118,16 @@
 20
 ],
 "ag-grid:src/ts/filter/baseFilter.ts": [
-68,
-71,
-74,
-80,
-230
+69,
+72,
+75,
+81,
+231
 ],
 "ag-grid:src/ts/filter/dateFilter.ts": [
-28,
-31,
-34
+29,
+32,
+35
 ],
 "ag-grid:src/ts/filter/filterManager.ts": [
 22,
@@ -144,18 +144,18 @@
 33
 ],
 "ag-grid:src/ts/filter/floatingFilter.ts": [
-98
+99
 ],
 "ag-grid:src/ts/filter/floatingFilterWrapper.ts": [
 25,
 61
 ],
 "ag-grid:src/ts/filter/numberFilter.ts": [
-20,
-26
+21,
+27
 ],
 "ag-grid:src/ts/filter/textFilter.ts": [
-20
+21
 ],
 "ag-grid:src/ts/focusedCellController.ts": [
 16,
@@ -429,10 +429,10 @@
 34
 ],
 "ag-grid:src/ts/headerRendering/standardMenu.ts": [
-14,
-16,
-18,
-20
+15,
+17,
+19,
+21
 ],
 "ag-grid:src/ts/layout/borderLayout.ts": [
 5,