eslint-config-beslogic 1.2.0 → 1.3.2

package/.eslintrc.js

@@ -2,28 +2,26 @@ module.exports = {
   "root": true,
   "env": {
     "node": true,
-    "es2021": true,
+    "es2021": true
   },
-  "plugins": [
-    "eslint-plugin",
-  ],
+  "plugins": ["eslint-plugin"],
   "extends": [
     "./javascript",
     "plugin:eslint-plugin/all",
+    "./json-like"
   ],
   "parserOptions": {
-    "sourceType": "script",
+    "sourceType": "script"
   },
   "rules": {
     "unicorn/filename-case": [
       "error",
       {
-        "case": "kebabCase",
-      },
+        "case": "kebabCase"
+      }
     ],
     "max-len": "off",
     "max-lines": "off",
-    "no-magic-numbers": "off",
-    "quotes": ["error","double"],
-  },
+    "no-magic-numbers": "off"
+  }
 }

package/.used-by.ini

@@ -4,5 +4,5 @@ Beslogic.Operations.BesOperationsUI=https://dev.azure.com/Beslogic/BesOperations
 RateMyDay=https://dev.azure.com/Beslogic/Changent.io/_git/RateMyDay # Rate My Day
 # External
 releese_stack=https://github.com/releese-innovations/releese_stack # Releese
-speedrun.com_global_scoreboard_webapp=https://github.com/Avasam/speedrun.com_global_scoreboard_webapp # Global Speedrunnign Scoreboard
+speedrun.com_global_scoreboard_webapp=https://github.com/Avasam/speedrun.com_global_scoreboard_webapp # Global Speedrunning Scoreboard
 troupon-frontend=https://dev.azure.com/PrattAndWhitneyCanada/DT%20LAB/_git/troupon-frontend # Troupon

package/.vscode/extensions.json

@@ -20,7 +20,9 @@
     "coenraads.bracket-pair-colorizer-2",
     // Lots of conflicts
     "esbenp.prettier-vscode",
-    // The ESLint plugin is sufficient in JS-only projects
+    // Use workspace version instead
+    // "ms-vscode.vscode-typescript-next",
+    // The ESLint plugin is sufficient in JS/TS projects
     "sonarsource.sonarlint-vscode",
     // Everything below is Deprecated
     "coenraads.bracket-pair-colorizer",

package/.vscode/settings.json

@@ -20,27 +20,40 @@
   "editor.tabSize": 2,
   "editor.insertSpaces": true,
   "editor.formatOnSave": true,
+  // Specify the formatter in case other formatters are also installed (ie: Prettier)
+  "[json]": {
+    "editor.defaultFormatter": "vscode.json-language-features",
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "vscode.json-language-features",
+  },
   "[javascript]": {
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+    "editor.defaultFormatter": "vscode.typescript-language-features",
   },
   "[javascriptreact]": {
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+    "editor.defaultFormatter": "vscode.typescript-language-features",
   },
   "[typescript]": {
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+    "editor.defaultFormatter": "vscode.typescript-language-features",
   },
   "[typescriptreact]": {
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+    "editor.defaultFormatter": "vscode.typescript-language-features",
+  },
+  "[html]": {
+    "editor.defaultFormatter": "vscode.html-language-features",
   },
   "editor.codeActionsOnSave": {
     "source.fixAll": true,
   },
+  "js/ts.implicitProjectConfig.checkJs": true,
   "javascript.preferences.quoteStyle": "single",
   "typescript.preferences.quoteStyle": "single",
   "html.format.wrapAttributes": "force-expand-multiline",
   "javascript.format.semicolons": "remove",
   "typescript.format.semicolons": "remove",
   // For Angular: "typescript.format.semicolons": "insert",
+  "javascript.preferences.importModuleSpecifier": "non-relative",
+  "typescript.preferences.importModuleSpecifier": "non-relative",
   "eslint.validate": [
     "javascript",
     "javascriptreact",
@@ -53,7 +66,12 @@
       "mode": "auto"
     }
   ],
-  "eslint.rules.customizations": [{ "rule": "*", "severity": "downgrade" }],
+  "eslint.rules.customizations": [
+    {
+      "rule": "*",
+      "severity": "downgrade"
+    }
+  ],
   "files.eol": "\n",
   "files.insertFinalNewline": true,
   "files.exclude": {
@@ -71,8 +89,6 @@
     "package-lock.json": true,
     "*.lock": true,
   },
-  "javascript.preferences.importModuleSpecifier": "non-relative",
-  "typescript.preferences.importModuleSpecifier": "non-relative",
   "editor.bracketPairColorization.enabled": true,
   "trailing-spaces.includeEmptyLines": true,
   "trailing-spaces.trimOnSave": true,

package/README.md

@@ -17,9 +17,13 @@ Below are all the different configurations you can extend from. You can mix and
 
 Default preset, extends from `beslogic/javascript` and `beslogic/typescript`.
 
+### `beslogic/jest`
+
+[Jest](https://www.npmjs.com/package/jest) and [Testing Library](https://testing-library.com/) configs. Is already extended by `beslogic/javascript` and `beslogic/typescript` for all `*spec.[jt]s` and `*.test.[jt]sx` files. You should not need to extend from this configuration unless you want to add it to a test file that is not automatically picked up by the naming convention.
+
 ### `beslogic/javascript`
 
-Basic javascript configs, is extended by all other configs except `beslogic/typescript`.
+Basic javascript configs, is extended by all other configs except `beslogic/typescript` and `beslogic/json-like`.
 
 ### `beslogic/typescript`
 
@@ -30,6 +34,9 @@ For the linting to be fully effective, please make sure to set the following in
 ```json
   "compilerOptions": {
     "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitReturns": true,
     "module": "esnext", // or commonjs
     "target": "es2017", // or higher
     "lib": [
@@ -37,7 +44,7 @@ For the linting to be fully effective, please make sure to set the following in
       "dom",
       "dom.iterable",
     ],
-  }
+  },
 ```
 
 and the following engines in your `package.json`:
@@ -80,7 +87,7 @@ Configurations for NGX projects. Comes with `html` template and inline template
 
 For the linting to be fully effective, please make sure to set the following in your `tsconfig.json`:
 
-```json
+```jsonc
   "angularCompilerOptions": {
     // "strictMetadataEmit": true, // For bundling with an npm package
     "strictInjectionParameters": true,
@@ -95,3 +102,7 @@ For the linting to be fully effective, please make sure to set the following in
 ### `beslogic/storybook`
 
 Includes strict Storybook ESLint plugin and a custom rule for Angular components. This preset should be added last.
+
+### `beslogic/json-like`
+
+Enforces stylistic rules for JS objects to look like valid JSON objects.

package/angular.js

@@ -1,3 +1,4 @@
+// @ts-ignore
 const preventAbbreviationsConfig = { ...require("./javascript").rules["unicorn/prevent-abbreviations"][1] }
 // supported Refs
 preventAbbreviationsConfig.allowList.Ref = true
@@ -9,40 +10,106 @@ const end2endPreventAbbreviationsConfig = { ...preventAbbreviationsConfig }
 // eslint-disable-next-line id-length
 end2endPreventAbbreviationsConfig.allowList.e = true
 const preferArrowFunctionsConfig = require("./javascript").rules["prefer-arrow/prefer-arrow-functions"][1]
-
+const baseIgnoreAttributes = [
+  "charset",
+  "class",
+  "color",
+  "colspan",
+  "fill",
+  "formControlName",
+  "height",
+  "href",
+  "id",
+  "lang",
+  "ngClass",
+  "ngProjectAs",
+  "routerLink",
+  "src",
+  "stroke",
+  "stroke-width",
+  "style",
+  "svgIcon",
+  "tabindex",
+  "target",
+  "type",
+  "viewBox",
+  "width",
+  "xmlns"
+]
 module.exports = {
-  overrides: [
+  "overrides": [
     {
-      files: ["*.html"],
-      extends: ["plugin:@angular-eslint/template/recommended"],
+      "files": ["*.html"],
+      "extends": ["plugin:@angular-eslint/template/all"],
       "rules": {
+        "@angular-eslint/template/click-events-have-key-events": "off",
+        "@angular-eslint/template/conditional-complexity": [
+          "error",
+          // Same as ESLint sonarjs/cognitive-complexity
+          {
+            "maxComplexity": 20
+          }
+        ],
+        "@angular-eslint/template/cyclomatic-complexity": [
+          "error",
+          // Same as ESLint complexity
+          {
+            "maxComplexity": 20
+          }
+        ],
         "@angular-eslint/template/eqeqeq": [
           "error",
           {
-            "allowNullOrUndefined": true,
-          },
+            "allowNullOrUndefined": true
+          }
         ],
-      },
-    },
-    {
-      files: ["*.ts"],
-      plugins: ["rxjs-angular"],
-      extends: [
+        "@angular-eslint/template/i18n": [
+          // Note: 'warn' because this adds a lot of complexity not all projects may want
+          // TODO: don't want the autofixer
+          "off",
+          {
+            // TODO: doesn't work for text elements. Raise the issue on github
+            "boundTextAllowedPattern": "EmPassion",
+            "ignoreTags": [
+              "meta",
+              "link",
+              "title",
+              "mat-icon"
+            ],
+            "ignoreAttributes": [
+              ...baseIgnoreAttributes,
+              // TODO: ask for those to be added in the library
+              "role",
+              "mat-form-field[appearance]",
+              "matTooltipPosition",
+              "input[autocomplete]",
+              "input[accept]",
+              "panelClass",
+              "cdkColumnDef"
+            ]
+          }
+        ],
+        "@angular-eslint/template/use-track-by-function": "error"
+      }
+    }, {
+      "files": ["*.ts"],
+      "plugins": ["rxjs-angular"],
+      "extends": [
         "./rxjs",
         "./typescript",
-        "plugin:@angular-eslint/recommended",
-        "plugin:@angular-eslint/template/process-inline-templates",
+        "plugin:@angular-eslint/all",
+        "plugin:@angular-eslint/template/process-inline-templates"
       ],
-      parserOptions: {
+      "parserOptions": {
         "project": [
           "tsconfig.json",
           "tsconfig.app.json",
           "tsconfig.spec.json",
-          "e2e/tsconfig.json",
+          "e2e/tsconfig.json"
         ],
-        "createDefaultProgram": true,
+        "createDefaultProgram": true
       },
-      rules: {
+      "rules": {
         // rxjs-angular rules
         "rxjs/no-finnish": "error",
         "rxjs-angular/prefer-async-pipe": "off",
@@ -50,67 +117,73 @@ module.exports = {
         // See: https://github.com/cartant/eslint-plugin-rxjs-angular/issues/1
         // "rxjs-angular/prefer-composition": "error",
         "rxjs-angular/prefer-takeuntil": "warn",
-        // Angular-eslint overrides
+        // Angular-eslint overrides (https://github.com/angular-eslint/angular-eslint/tree/master/packages/eslint-plugin/docs/rules)
         "@angular-eslint/component-class-suffix": [
           "error",
           {
-            "suffixes": ["Component", "Dialog"],
-          },
+            "suffixes": ["Component", "Dialog"]
+          }
         ],
         "@angular-eslint/component-selector": [
           "error",
           {
             "type": "element",
-            "prefix": "app",
-            "style": "kebab-case",
-          },
+            "style": "kebab-case"
+          }
         ],
         "@angular-eslint/directive-selector": [
           "error",
           {
             "type": "attribute",
-            "prefix": "app",
-            "style": "camelCase",
-          },
+            "style": "camelCase"
+          }
         ],
-        "@angular-eslint/no-empty-lifecycle-method": "error",
-        "@angular-eslint/use-lifecycle-interface": "error",
+        "@angular-eslint/prefer-on-push-component-change-detection": "off",
+        // TODO: raise issue on github. Shouldn't warn for abstract classes
+        "@angular-eslint/use-component-selector": "warn",
         // Custom rules and @typescript-eslint/all overrides (https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/src/configs/all.ts)
-        "@typescript-eslint/consistent-type-definitions": [
-          "error",
-          "interface",
-        ],
+        "@typescript-eslint/consistent-type-definitions": ["error", "interface"],
         // Angular needs more than just type information for dependency injection
         "@typescript-eslint/consistent-type-imports": [
           "error",
           {
-            "prefer": "no-type-imports",
-          },
+            "prefer": "no-type-imports"
+          }
         ],
         // Works with settings.json > "typescript.format.semicolons": "insert"
         "@typescript-eslint/member-delimiter-style": [
           "error",
           {
             "singleline": {
-              "requireLast": true,
-            },
-          },
+              "requireLast": true
+            }
+          }
         ],
-        "@typescript-eslint/semi": [
+        // From https://github.com/angular-eslint/angular-eslint/blob/master/packages/eslint-plugin/src/configs/recommended--extra.json
+        "@typescript-eslint/member-ordering": [
           "error",
-          "always",
+          {
+            "default": [
+              "static-field",
+              "instance-field",
+              "static-method",
+              "instance-method"
+            ]
+          }
         ],
+        "@typescript-eslint/semi": ["error", "always"],
         // Angular directives can lead to empty classes
         "@typescript-eslint/no-extraneous-class": [
           "error",
           {
-            "allowEmpty": true,
-          },
+            "allowEmpty": true
+          }
         ],
         // Incompatible with Angular's dependecy injection
         "@typescript-eslint/no-invalid-this": "off",
         // Redundant with Angular's dependecy injection
         "@typescript-eslint/no-parameter-properties": "off",
+        "@typescript-eslint/parameter-properties": "off",
         // Angular directives can lead to `const myFunc = this.service.func`
         "@typescript-eslint/unbound-method": "off",
         // Allow class because of "classList"
@@ -119,45 +192,45 @@ module.exports = {
           {
             "disallowedPrefixes": [
               "for",
-              "of",
-            ],
-          },
+              "of"
+            ]
+          }
         ],
         // Angular is ESM
         "unicorn/prefer-module": "error",
         "unicorn/prevent-abbreviations": [
           "error",
-          preventAbbreviationsConfig,
+          preventAbbreviationsConfig
         ],
         "no-restricted-syntax": [
           "error",
           {
             "selector": "ClassDeclaration:has(Decorator :matches([name=\"Component\"], [name=\"Injectable\"])) :matches(PropertyDefinition[key.name=\"intercept\"], PropertyDefinition[key.name=\"ngOnChanges\"], PropertyDefinition[key.name=\"ngOnInit\"], PropertyDefinition[key.name=\"ngDoCheck\"], PropertyDefinition[key.name=\"ngAfterContentInit\"], PropertyDefinition[key.name=\"ngAfterContentChecked\"], PropertyDefinition[key.name=\"ngAfterViewInit\"], PropertyDefinition[key.name=\"ngAfterViewChecked\"], PropertyDefinition[key.name=\"ngOnDestroy\"]) > ArrowFunctionExpression",
-            "message": "Angular hooks need to be functions defined on the prototype: https://github.com/angular/angular/issues/7270#issuecomment-201137617",
+            "message": "Angular hooks need to be functions defined on the prototype: https://github.com/angular/angular/issues/7270#issuecomment-201137617"
           },
-        ],
-      },
-    },
-    {
-      "files": [
-        "*.js",
-      ],
-      "extends": [
-        "./node-js",
-      ],
-    },
-    {
-      "files": [
-        "polyfills.ts",
-      ],
+          {
+            "selector": "ImportDeclaration[source.value=/\\.\\.\\u002F?$/]",
+            "message": "Don't use imports that ends in \"..\" or \"../\""
+          },
+          // From https://github.com/angular-eslint/angular-eslint/blob/master/packages/eslint-plugin/src/configs/recommended--extra.json
+          {
+            "selector": "CallExpression[callee.object.name=\"console\"][callee.property.name=/^(debug|info|time|timeEnd|trace)$/]",
+            "message": "Unexpected property on console object was called"
+          }
+        ]
+      }
+    }, {
+      "files": ["*.js"],
+      "extends": ["./node-js"]
+    }, {
+      "files": ["polyfills.ts"],
       "rules": {
-        "simple-import-sort/imports": "off",
-      },
-    },
-    {
+        "simple-import-sort/imports": "off"
+      }
+    }, {
       // See no-restricted-syntax
-      files: ["*[.-]component.ts", "*[.-]interceptor.ts"],
-      rules: {
+      "files": ["*[.-]component.ts", "*[.-]interceptor.ts"],
+      "rules": {
         // Angular hooks should be named functions
         // https://github.com/mojohaus/extra-enforcer-rules/issues/186
         "extra-rules/potential-point-free": "warn",
@@ -166,34 +239,32 @@ module.exports = {
           {
             ...preferArrowFunctionsConfig,
             // https://github.com/TristonJ/eslint-plugin-prefer-arrow/issues/17
-            "classPropertiesAllowed": false,
-          },
-        ],
-      },
-    },
-    {
-      files: ["*.e2e-spec.ts"],
-      rules: {
+            "classPropertiesAllowed": false
+          }
+        ]
+      }
+    }, {
+      "files": ["*.e2e-spec.ts"],
+      "rules": {
         "unicorn/prevent-abbreviations": [
           "off",
-          end2endPreventAbbreviationsConfig,
-        ],
-      },
-    },
-    {
-      files: [
+          end2endPreventAbbreviationsConfig
+        ]
+      }
+    }, {
+      "files": [
         "*.js",
         "*.ts",
-        "*.html",
+        "*.html"
       ],
-      rules: {
+      "rules": {
         "unicorn/filename-case": [
           "error",
           {
-            "case": "kebabCase",
-          },
-        ],
-      },
-    },
-  ],
+            "case": "kebabCase"
+          }
+        ]
+      }
+    }
+  ]
 }

package/index.js

@@ -1,8 +1,6 @@
-"use strict"
-
 module.exports = {
-  extends: [
+  "extends": [
     "./javascript",
-    "./typescript",
-  ],
+    "./typescript"
+  ]
 }