eslint-config-beslogic 3.0.0 → 3.0.2

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## Unreleased
+## 3.0.2
+
+- Made `eslint-plugin-sonarjs` optional for pre-commit.ci contexts
+
+## 3.0.0
 
 ### Important migration points
 
@@ -13,6 +17,7 @@
 - If you only have `tsconfig.json` files and no complex `tsconfig.*.json`, you can also try this instead:
 
   ```js
+  /** @type {import("eslint").Linter.Config} */
   module.exports = {
     parserOptions: {
       projectService: {

package/README.md

@@ -91,16 +91,18 @@ As you'll easily bust the 250MiB limit on the free tier, omit the following depe
 
 - `dprint`
 - `@eslint-community/eslint-plugin-eslint-comments`
-- `eslint-import-resolver-typescript`
 - `esling-plugin-no-autofix`
-- `eslint-plugin-testing-library`
+- `eslint-import-resolver-typescript`
+- `eslint-plugin-etc`
 - `eslint-plugin-jest-formatting`
 - `eslint-plugin-jest`
-- `eslint-plugin-etc`
+- `eslint-plugin-sonarjs`
+- `eslint-plugin-testing-library`
 
 If using TypeScript and pre-commit.ci, in your ESLint config you'll _have to_ use the project service, or you'll run into OOM issues:
 
 ```js
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   parser: "@typescript-eslint/parser",
   parserOptions: {

package/javascript.js

@@ -17,6 +17,9 @@ const hasNoAutofix = !!resolveModuleLocation("eslint-plugin-no-autofix")
 // @eslint-community/eslint-comments' only autofix is removing unused suppression comments
 // Some rules get globally disabled for pre-commit.ci, so finding unused comments is expected
 const hasEslintComments = !!resolveModuleLocation("@eslint-community/eslint-plugin-eslint-comments")
+// eslint-plugin-sonarjs@2 pulls in a ton of extra dependnecies we don't need
+// https://community.sonarsource.com/t/warning-react-version-not-specified-in-eslint-plugin-react/125412/11?u=avasam
+const hasSonarJS = !!resolveModuleLocation("eslint-plugin-sonarjs")
 
 const noRestrictedSyntax = [
   "error",
@@ -52,7 +55,9 @@ module.exports = {
   ],
   "extends": [
     "eslint:recommended",
-    "plugin:sonarjs/recommended-legacy", // "legacy" is for ESLint v8 compatibility
+    ...hasSonarJS
+      ? ["plugin:sonarjs/recommended-legacy"] // "legacy" is for ESLint v8 compatibility
+      : [],
     "plugin:unicorn/all",
     "plugin:regexp/all",
     "plugin:import/recommended",
@@ -322,33 +327,37 @@ module.exports = {
       }
       : {},
 
-    /*
-     * sonarjs/recommended overrides (https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md#rules)
-     */
-    // Same as eslint (cyclomatic) complexity
-    // This is also based on the fact that react-app service workers template hits this
-    "sonarjs/cognitive-complexity": [
-      "warn",
-      20
-    ],
-    // False-positives with top-level Promises (and maybe more, but that was enough for me ot disable)
-    "sonarjs/constructor-for-side-effects": "off",
-    "sonarjs/deprecation": "warn",
-    "sonarjs/no-duplicate-string": "error",
-    // Duplicates etc/no-commented-out-code. But is faster but also catches less.
-    // Incidentally this is good for a non-strict config.
-    "sonarjs/no-commented-code": "error",
-    // Too annoying, let us use our lovely PATH :)
-    "sonarjs/no-os-command-from-path": "off",
-    // Too annoying, consider maybe for an extra-strict
-    // but JS doesn't have kw params unlike Python
-    "sonarjs/no-selector-parameter": "off",
-    // Is default, but let's note that this option replaced `eslint-plugin-unused-imports` entirely,
-    // so if there's an issue, we can always go back.
-    "sonarjs/unused-import": "error",
-    // TODO: Raise an issue. Also mention that online doc examples sees to be inverted
-    // False-positives using Intl.DateTimeFormat()
-    "sonarjs/new-cap": "off",
+    ...hasSonarJS
+      ? {
+        /*
+         * sonarjs/recommended overrides (https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md#rules)
+         */
+        // Same as eslint (cyclomatic) complexity
+        // This is also based on the fact that react-app service workers template hits this
+        "sonarjs/cognitive-complexity": [
+          "warn",
+          20
+        ],
+        // False-positives with top-level Promises (and maybe more, but that was enough for me ot disable)
+        "sonarjs/constructor-for-side-effects": "off",
+        "sonarjs/deprecation": "warn",
+        "sonarjs/no-duplicate-string": "error",
+        // Duplicates etc/no-commented-out-code. But is faster but also catches less.
+        // Incidentally this is good for a non-strict config.
+        "sonarjs/no-commented-code": "error",
+        // Too annoying, let us use our lovely PATH :)
+        "sonarjs/no-os-command-from-path": "off",
+        // Too annoying, consider maybe for an extra-strict
+        // but JS doesn't have kw params unlike Python
+        "sonarjs/no-selector-parameter": "off",
+        // Is default, but let's note that this option replaced `eslint-plugin-unused-imports` entirely,
+        // so if there's an issue, we can always go back.
+        "sonarjs/unused-import": "error",
+        // TODO: Raise an issue. Also mention that online doc examples sees to be inverted
+        // False-positives using Intl.DateTimeFormat()
+        "sonarjs/new-cap": "off"
+      }
+      : {},
 
     /*
      * eslint-plugin-sonarjs@2 added rules that duplicate base ESLint rules or specific plugins we prefer
@@ -365,7 +374,7 @@ module.exports = {
     "sonarjs/default-param-last": "off",
     "sonarjs/no-delete-var": "off",
     "sonarjs/no-empty-function": "off",
-    "sonarjs/no-extend-native": "error",
+    "sonarjs/no-extend-native": "off",
     "sonarjs/no-redeclare": "off",
     "sonarjs/no-unreachable": "off",
     "sonarjs/no-unused-expressions": "off",

package/jest.js

@@ -8,6 +8,9 @@ const jestGlobalsVersion = getModuleVersion("@jest/globals", 29)
 const hasTestingLibrary = !!resolveModuleLocation("eslint-plugin-testing-library")
 const hasJestFormatting = !!resolveModuleLocation("eslint-plugin-jest-formatting")
 const hasJest = !!resolveModuleLocation("eslint-plugin-jest")
+// eslint-plugin-sonarjs@2 pulls in a ton of extra dependnecies we don't need
+// https://community.sonarsource.com/t/warning-react-version-not-specified-in-eslint-plugin-react/125412/11?u=avasam
+const hasSonarJS = !!resolveModuleLocation("eslint-plugin-sonarjs")
 
 /** @type {import("eslint").Linter.Config} */
 module.exports = {
@@ -73,16 +76,20 @@ module.exports = {
     "@typescript-eslint/no-unsafe-call": "off",
     // Allow printing "as-is" in tests
     "@typescript-eslint/restrict-template-expressions": "off",
-    // Higher requirements for tests since we like being explicit
-    // Arbitrary same as max-params (+1 because this is exclusive)
-    "sonarjs/no-duplicate-string": [
-      "error",
-      { "threshold": 8 }
-    ],
-    // We could bump it higher than 4, but doc doesn't provide its config
-    // So disabling since fluent tests are nested functions
-    // (same comment in jsx)
-    "sonarjs/no-nested-functions": "off",
+    ...hasSonarJS
+      ? {
+        // Higher requirements for tests since we like being explicit
+        // Arbitrary same as max-params (+1 because this is exclusive)
+        "sonarjs/no-duplicate-string": [
+          "error",
+          { "threshold": 8 }
+        ],
+        // We could bump it higher than 4, but doc doesn't provide its config
+        // So disabling since fluent tests are nested functions
+        // (same comment in jsx)
+        "sonarjs/no-nested-functions": "off"
+      }
+      : {},
 
     /*
      * jest/all overrides (https://github.com/jest-community/eslint-plugin-jest#rules)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-beslogic",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "ESLint rules, plugins and configs used at Beslogic",
   "main": "index.js",
   "// dependencies": "Run for ourselves when we install dependencies w/o running npm i afterward",