eslint-config-beslogic 2.4.7 → 2.4.9

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.4.8
+
+Go back to explicit `@typescript-eslint/parser` and `@typescript-eslint/eslint-plugin` dependencies instead of `typescript-eslint` due to <https://github.com/danielnixon/eslint-plugin-total-functions/issues/477#issuecomment-2327088201>.
+
 ## 2.4.7
 
 - No longer recommending to explicitely annotate void returning awaitable arrow functions as `(param): void => { statement }` in JavaScript.

package/README.md

@@ -84,6 +84,7 @@ In the `additional_dependencies` field, you'll need to include _all_ the plugins
 As you'll easily bust the 250MiB limit on the free tier, omit the following dependencies as they're special-cased to always be ignored on `pre-commit.ci` anyway:
 
 - `dprint`
+- `@eslint-community/eslint-plugin-eslint-comments`
 - `eslint-plugin-total-functions`
 - `esling-plugin-no-autofix`
 - `eslint-plugin-testing-library`

package/javascript.js

@@ -2,7 +2,13 @@
 // Copyright 2024 Beslogic Inc.
 
 const restrictedGlobals = require("confusing-browser-globals")
-const { jestNoRestrictedSyntax, jestFilePatterns, resolveModuleLocation, idLenghtConfig } = require(
+const {
+  jestNoRestrictedSyntax,
+  jestFilePatterns,
+  resolveModuleLocation,
+  idLenghtConfig,
+  isPreCommitCI
+} = require(
   "./lib/utils"
 )
 
@@ -13,6 +19,9 @@ const hasEtc = !!resolveModuleLocation("eslint-plugin-etc")
 // https://github.com/aladdin-add/eslint-plugin/issues/98
 // Even if it gets fixed, `no-autofix` rules necessarily don't provide fixes anyway
 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-comments")
 
 const commaDangleDefault = "always-multiline"
 
@@ -55,7 +64,9 @@ module.exports = {
     "plugin:unicorn/all",
     "plugin:regexp/all",
     "plugin:import/recommended",
-    "plugin:@eslint-community/eslint-comments/recommended"
+    ...hasEslintComments
+      ? ["plugin:@eslint-community/eslint-comments/recommended"]
+      : []
   ],
   "parserOptions": {
     "requireConfigFile": false,
@@ -342,12 +353,14 @@ module.exports = {
          *  @eslint-community/eslint-comments/recommended overrides (https://eslint-community.github.io/eslint-plugin-eslint-comments/rules)
          */
         // TODO: Move back to "all files" once HTML parsing crash is fixed https://github.com/eslint-community/eslint-plugin-eslint-comments/issues/162
-        "@eslint-community/eslint-comments/disable-enable-pair": [
-          "error",
-          {
-            "allowWholeFile": true
-          }
-        ]
+        "@eslint-community/eslint-comments/disable-enable-pair": hasEslintComments
+          ? [
+            "error",
+            {
+              "allowWholeFile": true
+            }
+          ]
+          : "off"
       }
     },
     {
@@ -389,16 +402,20 @@ module.exports = {
     }
   ],
   "rules": {
-    /*
-     *  @eslint-community/eslint-comments/recommended overrides (https://eslint-community.github.io/eslint-plugin-eslint-comments/rules)
-     */
-    "@eslint-community/eslint-comments/no-unused-disable": "error",
-    "@eslint-community/eslint-comments/require-description": [
-      "error",
-      {
-        "ignore": ["eslint-enable"]
+    ...hasEslintComments
+      ? {
+        /*
+         *  @eslint-community/eslint-comments/recommended overrides (https://eslint-community.github.io/eslint-plugin-eslint-comments/rules)
+         */
+        "@eslint-community/eslint-comments/no-unused-disable": "error",
+        "@eslint-community/eslint-comments/require-description": [
+          "error",
+          {
+            "ignore": ["eslint-enable"]
+          }
+        ]
       }
-    ],
+      : {},
 
     /*
      *  sonarjs/recommended overrides (https://github.com/SonarSource/eslint-plugin-sonarjs#rules)

package/lib/utils.js

@@ -1,6 +1,6 @@
-// const isPreCommitCI = __dirname.startsWith("/pc/clone/")
-// console.log(__dirname)
-// console.log(__filename)
+const isPreCommitCI = __dirname.startsWith("/pc/clone/")
+console.log(__dirname)
+console.log(__filename)
 
 const getModuleVersion = (
   /** @type {string} */ nodeModule,
@@ -23,11 +23,9 @@ const getModuleVersion = (
 
 const resolveModuleLocation = (/** @type {string} */ nodeModule) => {
   try {
-    // console.log(__dirname)
-    // console.log(__filename)
     const resolved = require.resolve(nodeModule)
-    // DEBUG: console.log(resolved)
-    if (resolved.startsWith("/pc/clone/")) {
+    // equivalent to resolved.startsWith("/pc/clone/"))
+    if (isPreCommitCI) {
       // Assume it's omitted from the pre-commit.ci run
       return false
     }
@@ -86,8 +84,8 @@ const idLenghtConfig = {
 module.exports = {
   getModuleVersion,
   idLenghtConfig,
-  // isPreCommitCI,
   jestFilePatterns,
+  isPreCommitCI,
   jestNoRestrictedSyntax,
   resolveModuleLocation
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-beslogic",
-  "version": "2.4.7",
+  "version": "2.4.9",
   "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",
@@ -39,9 +39,12 @@
   "author": "Samuel Therrien <samuel.therrien@beslogic.com>",
   "license": "MIT",
   "// @babel/eslint-parser": "Bumped json5 to fix prototype Pollution in minimist <1.2.6",
+  "// typescript-eslint": "Can't use the proxy package because of total-functions: https://github.com/danielnixon/eslint-plugin-total-functions/issues/477#issuecomment-2327088201",
   "dependencies": {
     "@babel/eslint-parser": "^7.20.12",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.1",
+    "@typescript-eslint/eslint-plugin": "^7.4",
+    "@typescript-eslint/parser": "^7.4",
     "confusing-browser-globals": "^1.0",
     "dprint": "^0.40.2",
     "eslint": "^8.56",
@@ -60,8 +63,7 @@
     "eslint-plugin-sonarjs": "^1.0",
     "eslint-plugin-testing-library": "^6.0",
     "eslint-plugin-unicorn": ">=49.0",
-    "eslint-plugin-unused-imports": "^3.2",
-    "typescript-eslint": "^7.4"
+    "eslint-plugin-unused-imports": "^3.2"
   },
   "// eslint-plugin-total-functions": "Supported version is dictated by TypeScript and ESLint",
   "// (cont)": "Also made optional because of extra strictness",