eslint-config-beslogic 1.4.21 → 1.4.24

package/.eslintrc.js

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright 2023 Beslogic Inc.
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "root": true,
   "plugins": ["eslint-plugin"],

package/.vscode/extensions.json

@@ -4,7 +4,6 @@
 // Please keep in alphabetical order
 {
   // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
-  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
   // List of extensions which should be recommended for users of this workspace.
   // Only keep those used by your specific project
   "recommendations": [
@@ -12,30 +11,31 @@
     "davidanson.vscode-markdownlint",
     "dbaeumer.vscode-eslint",
     "dprint.dprint",
-    "dotenv.dotenv-vscode",
+    // "dotenv.dotenv-vscode",
     "eamodio.gitlens",
-    "firsttris.vscode-jest-runner",
+    // "firsttris.vscode-jest-runner",
     // "johnpapa.angular2",
     "meganrogge.template-string-converter",
-    "ms-vscode.vscode-typescript-next",
     "pkief.material-icon-theme"
+    // "redhat.vscode-xml",
+    // "redhat.vscode-yaml"
   ],
   // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+  // Developpers should uninstall or disable the following extensions for this workspace
+  // https://github.com/microsoft/vscode/issues/40239
   "unwantedRecommendations": [
-    // VSCode has implemented an optimized version
-    "coenraads.bracket-pair-colorizer-2",
-    // Lots of conflicts
-    "esbenp.prettier-vscode",
-    // Use workspace version instead
-    "ms-vscode.vscode-typescript-next",
-    // jest-runner is preferable and doesn't have issues with parametrized tests
-    "orta.vscode-jest",
-    // The ESLint plugin is sufficient in JS/TS projects
-    "sonarsource.sonarlint-vscode",
-    // Everything below is Deprecated or obsoleted
+    "dotjoshjohnson.xml", // Prevent VSCode from recommending a different XML extension than the one we recommend
+    "esbenp.prettier-vscode", // Lots of conflicts
+    "ms-vscode.vscode-typescript-next", // Use workspace version instead
+    "mikestead.dotenv", // Use the official plugin instead
+    "orta.vscode-jest", // firsttris.vscode-jest-runner is preferable and doesn't have issues with parametrized tests
+    "rvest.vs-code-prettier-eslint", // Lots of conflicts
+    "sonarsource.sonarlint-vscode", // Not project-configurable. And the ESLint plugin is sufficient in JS/TS projects
+    // Everything below is Deprecated
     "coenraads.bracket-pair-colorizer",
+    "coenraads.bracket-pair-colorizer-2",
     "eg2.tslint",
-    "mikestead.dotenv",
-    "ms-vscode.vscode-typescript-tslint-plugin"
+    "ms-vscode.vscode-typescript-tslint-plugin",
+    "simonsiefke.prettier-vscode"
   ]
 }

package/.vscode/settings.json

@@ -4,8 +4,7 @@
 {
   "files.associations": {
     ".eslintrc*.json": "jsonc",
-    "dprint*.json": "jsonc",
-    "tsconfig*.json": "jsonc"
+    "dprint*.json": "jsonc"
   },
   "editor.rulers": [
     80,
@@ -39,6 +38,7 @@
   // },
   "editor.codeActionsOnSave": {
     "source.fixAll": true,
+    // Let dedicated imports tool deal with it
     "source.organizeImports": false
   },
   "typescript.tsdk": "node_modules/typescript/lib",
@@ -66,6 +66,11 @@
       "mode": "auto"
     }
   ],
+  "eslint.codeActionsOnSave.rules": [
+    // Clearing imports because of commented code while testing is annoying
+    "!unused-imports/no-unused-imports",
+    "*"
+  ],
   "eslint.rules.customizations": [
     {
       "rule": "*",
@@ -95,5 +100,7 @@
     "package-lock.json": true,
     "*.lock": true
   },
-  "editor.bracketPairColorization.enabled": true
+  "editor.bracketPairColorization.enabled": true,
+  "xml.codeLens.enabled": true,
+  "xml.format.maxLineWidth": 120
 }

package/README.md

@@ -13,6 +13,16 @@ A [dprint preset](#beslogicdprint) is ofered below.
 
 ## Parallel configurations
 
+Add the following scripts to your `package.json`:
+
+```json
+"scripts": {
+  "eslint": "eslint ./ --ignore-path .gitignore",
+  "lint": "dprint check && npm run eslint",
+  "lint:fix": "dprint fmt && npm run eslint -- --fix",
+}
+```
+
 These are configuration files you'll have to update manually to best work with these presets.
 
 - [VSCode Settings and Extensions](https://socket.dev/npm/package/eslint-config-beslogic/files/latest/.vscode)
@@ -38,13 +48,13 @@ Default preset, extends from `beslogic/javascript` and `beslogic/typescript`.
 
 ### `beslogic/javascript`
 
-Basic javascript configs, is extended by all other configs except `beslogic/typescript` and `beslogic/json-like`.
+Basic javascript configs, is extended by all other configs except `beslogic/typescript`, `beslogic/jest`, `beslogic/storybook` and `beslogic/json-like`.
 
 ### `beslogic/typescript`
 
-Basic TypeScript-specific configs and `TSX` support, is extended by all other TypeScript exclusive configs. To avoid rules conflicts, it does **not** already extend from `beslogic/javascript`. So you should extend from both in a pure TypeScript project. You may also need to specify `parserOptions.project`. ie: `"parserOptions": { "project": ["tsconfig.json"] },` and `"parser": "@typescript-eslint/parser"`
+Basic TypeScript-specific configs and `TSX` support, is extended by all other TypeScript exclusive configs. To avoid rules conflicts, it does **not** already extend from `beslogic/javascript`. So you should extend from both in a pure TypeScript project. You may also need to specify `parserOptions.project`. ie: `"parserOptions": { "project": ["tsconfig.json"] },` and `"parser": "@typescript-eslint/parser"`.
 
-For the linting to be fully effective, please make sure to set the following in your `tsconfig.json`:
+For the linting to be fully effective, please make sure to set the following in your base `tsconfig.json`:
 
 <!-- dprint-ignore -->
 ```json
@@ -145,10 +155,13 @@ Add the following `devDependencies` to your `package.json`:
 
 Configurations for NGX projects. Comes with `html` template and inline template support. Already extends `beslogic/rxjs` and `beslogic/typescript`. Also extends `beslogic/node-js` for Javascript files.
 
-For the linting to be fully effective, please make sure to set the following in your `tsconfig.json`:
+For the linting to be fully effective, please make sure to set the following in your base `tsconfig.json`:
 
 <!-- dprint-ignore -->
 ```jsonc
+  "compilerOptions": {
+    "emitDecoratorMetadata": true,
+  },
   "angularCompilerOptions": {
     // "strictMetadataEmit": true, // For bundling with an npm package
     "strictInjectionParameters": true,

package/angular.js

@@ -53,6 +53,8 @@ const baseIgnoreAttributes = [
   "width",
   "xmlns"
 ]
+
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "overrides": [
     {
@@ -81,9 +83,14 @@ module.exports = {
             "allowNullOrUndefined": true
           }
         ],
+        // autofix for this rule is broken: https://github.com/angular-eslint/angular-eslint/issues/1197
+        "@angular-eslint/template/attributes-order": "off",
+        // and it was added in 14.2.0. Not enforcing it for now allows a wider range of versions
+        "no-autofix/@angular-eslint/template/attributes-order": "off",
         "@angular-eslint/template/i18n": "off",
         "no-autofix/@angular-eslint/template/i18n": [
-          "error",
+          // Too many TODO and needs per-project extensions to justify this as "error"
+          "warn",
           {
             // TODO: doesn't work for text elements.
             // see: https://github.com/angular-eslint/angular-eslint/issues/999
@@ -129,11 +136,10 @@ module.exports = {
       ],
       "parserOptions": {
         "project": [
-          "tsconfig.json",
-          "tsconfig.*.json",
-          "projects/*/tsconfig.*.json",
+          "tsconfig?(.*).json",
+          "projects/*/tsconfig?(.*).json",
           // eslint-disable-next-line etc/no-commented-out-code
-          "*/tsconfig.json" // e2e/tsconfig.json
+          "*/tsconfig?(.*).json" // e2e/tsconfig.json
         ],
         // TODO: Consider use a tsconfig.eslint.json instead
         // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/README.md#parseroptionscreatedefaultprogram
@@ -192,10 +198,6 @@ module.exports = {
             }
           }
         ],
-        "@typescript-eslint/semi": [
-          "error",
-          "always"
-        ],
         // Angular directives can lead to empty classes
         "@typescript-eslint/no-extraneous-class": [
           "error",

package/dprint-base.json

@@ -8,15 +8,16 @@
     // "quoteStyle": "alwaysDouble", // If using beslogic/json-like
     "quoteProps": "asNeeded", // If NOT using beslogic/json-like
     // "quoteProps": "preserve", // If using beslogic/json-like
+    // "trailingCommas": "never", // If using beslogic/json-like
     "newLineKind": "auto",
-    "semiColons": "asi", // Except for angular
+    "semiColons": "asi",
     "operatorPosition": "sameLine",
     "conditionalExpression.operatorPosition": "nextLine",
     "arrowFunction.useParentheses": "preferNone",
     "binaryExpression.linePerExpression": true,
     // Not convinced yet
     // "memberExpression.linePerExpression": true,
-    "typeLiteral.separatorKind": "comma", // Except for angular
+    "typeLiteral.separatorKind": "comma",
     "enumDeclaration.memberSpacing": "newLine",
     "importDeclaration.forceSingleLine": true,
     // conflicts with simple-import-sort/imports

package/dprint.js

@@ -2,6 +2,7 @@
 // Copyright 2023 Beslogic Inc.
 
 /* eslint-disable etc/no-commented-out-code */
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "overrides": [
     {

package/index.js

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright 2023 Beslogic Inc.
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "extends": [
     "./javascript",

package/javascript.js

@@ -31,6 +31,7 @@ const idLenghtConfig = {
   ]
 }
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "plugins": [
     "extra-rules",
@@ -85,6 +86,11 @@ module.exports = {
         ".test.jsx"
       ],
       "extends": ["./jest"]
+    },
+    {
+      "files": [".eslintrc.js"],
+      "globals": { "module": true },
+      "extends": ["./json-like"]
     }
   ],
   "rules": {
@@ -94,8 +100,8 @@ module.exports = {
     // unused-imports settings
     // Loosing imports when commenting to test is extremely annoying and slow,
     // so we only use this rule when ran from the command-line
-    // no-autofix/unused-imports is redundant with no-unused-vars
-    "unused-imports/no-unused-imports": "off",
+    // no-autofix/unused-imports is redundant with no-unused-vars and and eslint.codeActionsOnSave.rules
+    "unused-imports/no-unused-imports": "warn",
 
     // unicorn/all overrides (https://github.com/sindresorhus/eslint-plugin-unicorn#rules)
     "unicorn/catch-error-name": [

package/jest.js

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright 2023 Beslogic Inc.
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "extends": [
     "plugin:jest/all",
@@ -12,6 +13,13 @@ module.exports = {
     "jest": true,
     "jest/globals": true
   },
+  "overrides": [
+    {
+      "files": [".eslintrc.js"],
+      "globals": { "module": true },
+      "extends": ["./json-like"]
+    }
+  ],
   "rules": {
     // Using only max-lines and not max-lines-per-function as most of the jest code lives in functions.
     "max-lines-per-function": "off",

package/json-like.js

@@ -1,7 +1,14 @@
 // SPDX-License-Identifier: MIT
 // Copyright 2023 Beslogic Inc.
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
+  "overrides": [
+    {
+      "files": [".eslintrc.js"],
+      "globals": { "module": true }
+    }
+  ],
   "rules": {
     "array-bracket-newline": [
       "error",

package/mui.js

@@ -10,6 +10,7 @@ const noMagicNumbersConfig = typeScriptConfig.overrides[0].rules["@typescript-es
 if (typeof idLenghtConfig === "string") throw new TypeError("idLenghtConfig is a string")
 if (typeof noMagicNumbersConfig === "string") throw new TypeError("noMagicNumbersConfig is a string")
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "plugins": ["mui"],
   "extends": [

package/node-js.js

@@ -15,6 +15,7 @@ preventAbbreviationsConfig.allowList.res = true
 preventAbbreviationsConfig.allowList.req = true
 const expressGlobalMessage = "Import from express instead."
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "extends": [
     "./javascript",

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "eslint-config-beslogic",
-  "version": "1.4.21",
+  "version": "1.4.24",
   "description": "ESLint rules, plugins and configs used at Beslogic",
   "main": "index.js",
   "scripts": {
-    "eslint": "eslint ./ --ignore-path .gitignore --rule \"unused-imports/no-unused-imports:'error'\"",
+    "eslint": "eslint ./ --ignore-path .gitignore",
     "lint": "node ./node_modules/dprint/bin check && npm run eslint",
     "lint:fix": "node ./node_modules/dprint/bin fmt && npm run eslint -- --fix",
     "upgrade": "npx npm-check-updates -u & npm i",
-    "yalc": "yalc publish",
-    "prepack": "type .gitignore* > .npmignore"
+    "yalc": "yalc publish"
   },
   "keywords": [
     "eslint",

package/react-native.js

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright 2023 Beslogic Inc.
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "extends": ["./react"],
   "rules": {

package/react-redux.js

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright 2023 Beslogic Inc.
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "plugins": ["react-redux"],
   "extends": [

package/react.js

@@ -17,6 +17,7 @@ preventAbbreviationsConfig.allowList.Props = true
 preventAbbreviationsConfig.allowList.ref = true
 preventAbbreviationsConfig.allowList.Ref = true
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "extends": [
     "./javascript",

package/rxjs.js

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright 2023 Beslogic Inc.
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "extends": [
     "./javascript",

package/storybook.js

@@ -5,6 +5,7 @@ const angularConfig = require("./angular")
 
 const noRestrictedSyntax = { ...angularConfig.overrides[1].rules["no-restricted-syntax"] }
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "extends": [
     "plugin:storybook/recommended",

package/typescript.js

@@ -24,6 +24,7 @@ const getModuleVersion = nodeModule =>
 // I already checked for dynamic rules up to v5.23.0
 const typescriptEslintVersion = getModuleVersion("@typescript-eslint/eslint-plugin")
 
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   "overrides": [
     {
@@ -55,9 +56,8 @@ module.exports = {
               // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
               "alwaysTryTypes": true,
               "project": [
-                "tsconfig.json",
-                "tsconfig.*.json",
-                "projects/*/tsconfig.*.json"
+                "tsconfig?(.*).json",
+                "projects/*/tsconfig?(.*).json"
               ]
             }
           }
@@ -70,7 +70,7 @@ module.exports = {
       },
       "parser": "@typescript-eslint/parser",
       "parserOptions": {
-        "project": ["tsconfig.json"],
+        "project": ["tsconfig?(.*).json"],
         "sourceType": "module",
         "ecmaFeatures": {
           "impliedStrict": true
@@ -87,11 +87,12 @@ module.exports = {
         "unicode-bom": "off",
 
         // eslint-plugin-total-functions overrides (https://www.npmjs.com/package/eslint-plugin-total-functions#user-content-rules)
-        // It takes an advanced TypeScript use to fully make sense of this rule
+        // It takes an advanced TypeScript user to fully make sense of this rule
         /**
+         * (copied from https://dev.azure.com/Beslogic/Beslogic%20Architecture%20Templates/_wiki/wikis/Beslogic-Architecture-Templates.wiki/656/Frontend-linting-and-formatting?anchor=total-functions/no-unsafe-type-assertion)
          * It can sometimes be hard to make sense of this rule, but let's be strict!
          * Tips:
-         * - Try to assign to an explicitely typed variable and TypeScript will tell you abou the type difference!
+         * - Try to assign to an explicitely typed variable and TypeScript will tell you about the type difference!
          *     ie: `const newValue: ExpectedType = unsafeValue`
          * - Prefer coersion over assertion: `String(value ?? '')` over `value as string | null`
          * - Sometimes just casting as `Partial<>` is sufficient

package/.gitignore.npmignore

@@ -1,2 +0,0 @@
-# .npmignore
-*.ini