eslint-config-beslogic 6.0.0 → 6.0.2

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 6.0.2
+
+- Explicitly disabled the following rules in `.html` in Angular preset, as they don't parse:
+  - `unicorn/prefer-string-raw`
+  - `sonarjs/code-eval`
+  - `@typescript-eslint/consistent-type-imports`
+
+## 6.0.1
+
+- Removed `@nx` patching. This will be updated in a later update.
+
 ## 6.0.0
 
 ### Changes that may require manual intervention

package/README.md

@@ -8,7 +8,7 @@ Depending on your needs, you will need to also install other peer dependencies f
 
 In your `eslint.config.*` file, simply [extend](#examples) our [presets](#presets) appropriate for your project.
 
-For stylistic rules, it is highly recommended to use a dedicated formatter over ESLint. Read more here: <https://typescript-eslint.io/docs/linting/troubleshooting/formatting/>\
+For stylistic rules, it is highly recommended to use a dedicated formatter over ESLint. Read more here: <https://typescript-eslint.io/users/what-about-formatting/>\
 We assume [dprint](https://dprint.dev/) and don't enable any rules it covers by default. If you're not using a formatter, a [stylistic.mjs](#stylisticmjs) configuration is offered below.
 
 ## Parallel configurations
@@ -98,7 +98,7 @@ Angular Material's MatDialogRef [defaults it dialog result generic to `any`](htt
 
 ## Presets
 
-Below are all the different configurations you can extend from. You can mix and match as you want if a predefined configuration does not exist for your specific stack. You should import TypeScript configs after regular javascript ones at the root of the configuration.
+Below are all the different configurations you can extend from. You can mix and match as you want if a predefined configuration does not exist for your specific stack.
 
 ### Examples
 
@@ -197,6 +197,8 @@ export default defineConfig(
 
 Configurations for NodeJS backends.
 
+TODO: mention already handled by angular preset
+
 Add the following `devDependencies` to your `package.json`:
 
 ```shell
@@ -250,12 +252,10 @@ Configurations for NGX projects. Comes with `html` template and inline template
 For the linting to be fully effective, please make sure that your base `tsconfig.json` extends `eslint-config-beslogic/tsconfig.X.X.json` (see [Parallel configurations](#parallel-configurations)).\
 If bundling as an npm package set `"strictMetadataEmit": true` under `angularCompilerOptions`.
 
-**NOTE**: `angular-eslint` won't work on HTML files on ESLint v8 due to parser configuration issues.
-
 Add the following `devDependencies` to your `package.json`:
 
 ```shell
-npm install --save-dev @angular-eslint/eslint-plugin @angular-eslint/eslint-plugin-template @angular-eslint/template-parser eslint-plugin-rxjs-angular-x eslint-plugin-angular-file-naming
+npm install --save-dev @angular-eslint/eslint-plugin @angular-eslint/eslint-plugin-template @angular-eslint/template-parser eslint-plugin-rxjs-angular-x eslint-plugin-angular-file-naming eslint-plugin-rxjs-x
 ```
 
 If using Standalone Components, which are now the recommended default, you should enable the rule `"no-autofix/@angular-eslint/prefer-standalone": "error"`.

package/angular.mjs

@@ -66,6 +66,12 @@ export default disableAutofix(defineConfig(
     "files": ["**/*.html"],
     "extends": [...angular.configs.templateAll],
     "rules": {
+      // These don't work in html
+      "unicorn/prefer-string-raw": "off",
+      "sonarjs/code-eval": "off",
+      // Rule that requires typescript parser loaded in html files, is it a misconfiguration ??
+      "@typescript-eslint/consistent-type-imports": "off",
+
       /*
        * angular-eslint/template overrides (https://github.com/angular-eslint/angular-eslint/blob/main/packages/eslint-plugin-template/README.md#rules)
        */

package/base.mjs

@@ -1222,6 +1222,16 @@ export default disableAutofix(defineConfig(
   {
     "name": "beslogic/base/configs",
     "files": ["*.config.{[cm][jt]s,[jt]s}"],
+    "languageOptions": {
+      "parserOptions": {
+        "projectService": {
+          // Don't force users to include this file in their tsconfig.json,
+          // because it can lead to tons of type errors
+          // They may still have to configure this if they have nested tsconfig.json
+          "allowDefaultProject": ["*.config.{[cm]js,js}"]
+        }
+      }
+    },
     "rules": {
       // Direct anonymous exports in config files is perfectly acceptable
       "import-x/no-anonymous-default-export": "off",

package/lib/patch-dependencies.mjs

@@ -92,97 +92,98 @@ const patches = [
     return packageName
   },
 
-  async () => {
-    const packageName = "@nx/angular"
-    const base = getPackageBase(packageName)
-    if (!base) return
-    await Promise.all([
-      searchAndReplace(
-        join(base, "src", "generators", "add-linting", "lib", "create-eslint-configuration.js"),
-        [
-          // Remove code that adds preset extensions
-          // plugin:@nx/angular-template
-          // plugin:@nx/angular
-          // plugin:@angular-eslint/template/process-inline-templates
-          {
-            "from": /'plugin:.+?',?/gu,
-            "to": ""
-          },
-          // Remove empty extends
-          {
-            "from": /extends: \[\s*\],?/gu,
-            "to": ""
-          }
-        ]
-      ),
-      // Patch out prettier
-      searchAndReplace(
-        join(base, "src", "generators", "ng-add", "utilities", "workspace.js"),
-        [
-          {
-            "from": "!packageJson.devDependencies['prettier']",
-            "to": "false"
-          },
-          {
-            "from": "esbenp.prettier-vscode",
-            "to": ""
-          }
-        ]
-      )
-    ])
-
-    return packageName
-  },
-  async () => {
-    const packageName = "@nx/eslint"
-    const base = getPackageBase(packageName)
-    if (!base) return
-    // Patch out prettier
-    await searchAndReplace(
-      join(base, "src", "generators", "lint-project", "setup-root-eslint.js"),
-      [
-        {
-          "from": /'eslint-config-prettier':.+?,/gu,
-          "to": ""
-        }
-      ]
-    )
-
-    return packageName
-  },
-  async () => {
-    const packageName = "@nx/js"
-    const base = getPackageBase(packageName)
-    if (!base) return
-    // Patch out prettier
-    await searchAndReplace(
-      join(base, "src", "generators", "init", "init.js"),
-      [
-        {
-          "from": /prettier:.+?,/gu,
-          "to": ""
-        },
-        {
-          "from": "if (prettierrcNameOptions",
-          "to": "if (false && prettierrcNameOptions"
-        },
-        {
-          "from": "!tree.exists(`.prettierignore`)",
-          "to": "false"
-        },
-        {
-          "from": "!json.recommendations.includes(extension)",
-          "to": "false"
-        },
-        {
-          "from": /.+?devkit_1\.ensurePackage\)\('prettier'.+?[\n;]/gu,
-          "to": ""
-        }
-      ]
-    )
-
-    return packageName
-  },
+  // TODO: Fix nx patching
+  // async () => {
+  //   const packageName = "@nx/angular"
+  //   const base = getPackageBase(packageName)
+  //   if (!base) return
+  //   await Promise.all([
+  //     searchAndReplace(
+  //       join(base, "src", "generators", "add-linting", "lib", "create-eslint-configuration.js"),
+  //       [
+  //         // Remove code that adds preset extensions
+  //         // plugin:@nx/angular-template
+  //         // plugin:@nx/angular
+  //         // plugin:@angular-eslint/template/process-inline-templates
+  //         {
+  //           "from": /'plugin:.+?',?/gu,
+  //           "to": ""
+  //         },
+  //         // Remove empty extends
+  //         {
+  //           "from": /extends: \[\s*\],?/gu,
+  //           "to": ""
+  //         }
+  //       ]
+  //     ),
+  //     // Patch out prettier
+  //     searchAndReplace(
+  //       join(base, "src", "generators", "ng-add", "utilities", "workspace.js"),
+  //       [
+  //         {
+  //           "from": "!packageJson.devDependencies['prettier']",
+  //           "to": "false"
+  //         },
+  //         {
+  //           "from": "esbenp.prettier-vscode",
+  //           "to": ""
+  //         }
+  //       ]
+  //     )
+  //   ])
+
+  //   return packageName
+  // },
+  // async () => {
+  //   const packageName = "@nx/eslint"
+  //   const base = getPackageBase(packageName)
+  //   if (!base) return
+  //   // Patch out prettier
+  //   await searchAndReplace(
+  //     join(base, "src", "generators", "lint-project", "setup-root-eslint.js"),
+  //     [
+  //       {
+  //         "from": /'eslint-config-prettier':.+?,/gu,
+  //         "to": ""
+  //       }
+  //     ]
+  //   )
+
+  //   return packageName
+  // },
+  // async () => {
+  //   const packageName = "@nx/js"
+  //   const base = getPackageBase(packageName)
+  //   if (!base) return
+  //   // Patch out prettier
+  //   await searchAndReplace(
+  //     join(base, "src", "generators", "init", "init.js"),
+  //     [
+  //       {
+  //         "from": /prettier:.+?,/gu,
+  //         "to": ""
+  //       },
+  //       {
+  //         "from": "if (prettierrcNameOptions",
+  //         "to": "if (false && prettierrcNameOptions"
+  //       },
+  //       {
+  //         "from": "!tree.exists(`.prettierignore`)",
+  //         "to": "false"
+  //       },
+  //       {
+  //         "from": "!json.recommendations.includes(extension)",
+  //         "to": "false"
+  //       },
+  //       {
+  //         "from": /.+?devkit_1\.ensurePackage\)\('prettier'.+?[\n;]/gu,
+  //         "to": ""
+  //       }
+  //     ]
+  //   )
+
+  //   return packageName
+  // },
   // ESLint 10 removed context.getFilename()/getSourceCode();
   // eslint-rule-composer (unmaintained) still calls them.
   // Patch with ?? fallback.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-beslogic",
-  "version": "6.0.0",
+  "version": "6.0.2",
   "description": "ESLint rules, plugins and configs used at Beslogic",
   "main": "index.js",
   "type": "module",