eslint-plugin-sonarjs 1.0.0 → 1.0.2

package/README.md

@@ -82,7 +82,7 @@ Code Smells, or maintainability issues, are raised for places of code which migh
 ## Prerequisites
 
 - Node.js (>=16.x).
-- ESLint 5.x, 6.x, 7.x or 8.x (peer dependency for the plugin).
+- ESLint 8.x or 9.x (peer dependency for the plugin).
 
 ## Usage
 
@@ -94,25 +94,35 @@ npm install eslint-plugin-sonarjs --save-dev # install for your project
 npm install eslint-plugin-sonarjs -g         # or install globally
 ```
 
-- Add `eslint-plugin-sonarjs` to the `plugins` option of your `.eslintrc`:
+- Add `eslint-plugin-sonarjs` to the plugins of your ESLint config.
 
-```json
-{
-  "plugins": ["sonarjs"]
-}
+For ESLint 9: add `plugins` option to your `eslint.config.js` and include the recommended config to enable all rules:
+
+```code
+import sonarjs from "eslint-plugin-sonarjs";
+
+[
+  sonarjs.configs.recommended,
+  {
+    "plugins": {
+      sonarjs,
+    }
+  }
+]
 ```
 
-- Add `plugin:sonarjs/recommended` to the `extends` option to enable all recommended rules:
+For ESLint 8: add `plugins` option to your `.eslintrc` and `plugin:sonarjs/recommended` to the `extends` option to enable all recommended rules:
 
 ```json
 {
-  "extends": ["plugin:sonarjs/recommended"]
+  "plugins": ["sonarjs"],
+  "extends": ["plugin:sonarjs/recommended-legacy"]
 }
 ```
 
 - or enable only some rules manually:
 
-```javascript
+```json
 {
   "rules": {
     "sonarjs/cognitive-complexity": "error",
@@ -122,11 +132,12 @@ npm install eslint-plugin-sonarjs -g         # or install globally
 }
 ```
 
-- To enable all rules of this plugin, use `@typescript-eslint/parser` as a parser for ESLint ([like we do](https://github.com/SonarSource/eslint-plugin-sonarjs/blob/6e06d59a233e07b28fbbd6398e08b9b0c63b18f9/.eslintrc.js#L4)) and set the [parserOptions.project](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionsproject) option. Thanks to it, type information is available, which is beneficial or even essential for some rules.
+- To allow each of the rules to fully perform, use `@typescript-eslint/parser` as a parser for ESLint ([like we do](https://github.com/SonarSource/eslint-plugin-sonarjs/blob/6e06d59a233e07b28fbbd6398e08b9b0c63b18f9/.eslintrc.js#L4)) and set the [parserOptions.project](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionsproject) option. Thanks to it, type information is available, which is beneficial or even essential for some rules.
 
 ## Available Configurations
 
 This plugin provides only a `recommended` configuration. Almost all rules are activated in this profile with a few exceptions (check the `disabled` tag in the rules list). The `recommended` configuration activates rules with `error` severity.
+We include a `recommended-legacy` configuration to be backward compatible with ESLint v8, with the same rule configuration..
 
 ## ESLint and Sonar
 

package/lib/package.json

@@ -0,0 +1,106 @@
+{
+    "name": "eslint-plugin-sonarjs",
+    "version": "1.0.2",
+    "description": "SonarJS rules for ESLint",
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "repository": "git@github.com:SonarSource/eslint-plugin-sonarjs.git",
+    "license": "LGPL-3.0-only",
+    "keywords": [
+        "sonarjs",
+        "eslint",
+        "eslintplugin"
+    ],
+    "bugs": {
+        "url": "https://github.com/SonarSource/eslint-plugin-sonarjs/issues"
+    },
+    "homepage": "https://github.com/SonarSource/eslint-plugin-sonarjs",
+    "engines": {
+        "node": ">=16"
+    },
+    "files": [
+        "lib",
+        "LICENSE"
+    ],
+    "scripts": {
+        "build": "rimraf lib && tsc -d -p src",
+        "test": "jest",
+        "ruling": "ts-node --files ruling/index.ts",
+        "precommit": "pretty-quick --staged",
+        "prepare": "husky install .husky",
+        "prepack": "npm run build",
+        "format": "prettier --write .",
+        "check-format": "prettier --list-different ."
+    },
+    "peerDependencies": {
+        "eslint": "^8.0.0 || ^9.0.0"
+    },
+    "devDependencies": {
+        "@babel/core": "7.24.4",
+        "@babel/eslint-parser": "7.24.1",
+        "@babel/plugin-proposal-export-default-from": "7.24.1",
+        "@babel/plugin-proposal-function-bind": "7.24.1",
+        "@babel/preset-env": "7.24.4",
+        "@babel/preset-flow": "7.24.1",
+        "@babel/preset-react": "7.24.1",
+        "@types/eslint": "8.56.10",
+        "@types/eslint-ruling": "npm:@types/eslint@^8.56.10",
+        "@types/jest": "29.5.12",
+        "@types/lodash": "4.17.0",
+        "@types/minimist": "1.2.5",
+        "@types/node": "20.12.7",
+        "@typescript-eslint/parser": "7.7.1",
+        "@typescript-eslint/rule-tester": "7.7.1",
+        "@typescript-eslint/utils": "7.7.1",
+        "eslint": "8.57.0",
+        "eslint-config-prettier": "9.1.0",
+        "eslint-plugin-import": "2.29.1",
+        "eslint-plugin-notice": "0.9.10",
+        "eslint-plugin-sonarjs": "0.25.1",
+        "eslint-ruling": "npm:eslint@8.57.0",
+        "husky": "9.0.11",
+        "jest": "29.7.0",
+        "jest-sonar-reporter": "2.0.0",
+        "lodash": "4.17.21",
+        "minimist": "1.2.8",
+        "prettier": "3.2.5",
+        "pretty-quick": "4.0.0",
+        "rimraf": "5.0.5",
+        "semver": "^7.6.0",
+        "ts-jest": "29.1.2",
+        "ts-node": "10.9.2",
+        "typescript": "5.4.5"
+    },
+    "prettier": {
+        "printWidth": 100,
+        "trailingComma": "all",
+        "singleQuote": true,
+        "arrowParens": "avoid",
+        "endOfLine": "lf"
+    },
+    "jest": {
+        "roots": [
+            "tests",
+            "src"
+        ],
+        "collectCoverageFrom": [
+            "src/**/*.ts"
+        ],
+        "moduleFileExtensions": [
+            "ts",
+            "js",
+            "json"
+        ],
+        "transform": {
+            "^.+\\.ts$": [
+                "ts-jest",
+                {
+                    "babelConfig": false
+                }
+            ]
+        },
+        "testMatch": [
+            "<rootDir>/tests/**/*.test.ts"
+        ]
+    }
+}

package/lib/{index.d.ts → src/index.d.ts}

@@ -44,6 +44,10 @@ export declare const configs: {
     recommended: FlatConfig.Config;
     'recommended-legacy': TSESLint.ClassicConfig.Config;
 };
+export declare const meta: {
+    name: string;
+    version: string;
+};
 declare const _default: {
     rules: {
         'cognitive-complexity': TSESLint.RuleModule<string, (number | "sonar-runtime" | "metric")[], TSESLint.RuleListener>;
@@ -89,5 +93,9 @@ declare const _default: {
         recommended: FlatConfig.Config;
         'recommended-legacy': TSESLint.ClassicConfig.Config;
     };
+    meta: {
+        name: string;
+        version: string;
+    };
 };
 export default _default;

package/lib/{index.js → src/index.js}

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configs = exports.rules = void 0;
+exports.meta = exports.configs = exports.rules = void 0;
 const cognitiveComplexity = __importStar(require("./rules/cognitive-complexity"));
 const elseifWithoutElse = __importStar(require("./rules/elseif-without-else"));
 const maxSwitchCases = __importStar(require("./rules/max-switch-cases"));
@@ -56,6 +56,7 @@ const preferImmediateReturn = __importStar(require("./rules/prefer-immediate-ret
 const preferObjectLiteral = __importStar(require("./rules/prefer-object-literal"));
 const preferSingleBooleanReturn = __importStar(require("./rules/prefer-single-boolean-return"));
 const preferWhile = __importStar(require("./rules/prefer-while"));
+const package_json_1 = require("../package.json");
 exports.rules = {
     'cognitive-complexity': cognitiveComplexity,
     'elseif-without-else': elseifWithoutElse,
@@ -109,4 +110,8 @@ exports.configs = {
     recommended: recommendedConfig,
     'recommended-legacy': recommendedLegacyConfig,
 };
-exports.default = { rules: exports.rules, configs: exports.configs };
+exports.meta = {
+    name: package_json_1.name,
+    version: package_json_1.version,
+};
+exports.default = { rules: exports.rules, configs: exports.configs, meta: exports.meta };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-sonarjs",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "SonarJS rules for ESLint",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -66,6 +66,7 @@
     "prettier": "3.2.5",
     "pretty-quick": "4.0.0",
     "rimraf": "5.0.5",
+    "semver": "^7.6.0",
     "ts-jest": "29.1.2",
     "ts-node": "10.9.2",
     "typescript": "5.4.5"