eslint-config-beslogic 2.2.1 → 2.3.1

package/.azuredevops/pull_request_template.md

@@ -0,0 +1,16 @@
+Thank you for your contribution to Beslogic's **ESLint-Config-Beslogic** repo.
+Before submitting this PR, please make sure:
+
+- [ ] The project is building
+- [ ] There are no linting issues
+- [ ] You updated the projects' README.md and CHANGELOG.md with the new changes
+- [ ] You reviewed your own PR and made sure there's no test/debug code or any obvious mistakes.
+- [ ] You set and configured auto-complete to "Complete associated work items after merging" & "Delete \<branch> after merging".
+- [ ] You cleaned up your commit history or set the PR Merge type to "Squash".
+
+Make sure that the code wasn't copied from elsewhere (check one):
+
+- [ ] This is your own original code
+- [ ] You have made sure that we have permission to use the copied code and that we follow its licensing
+
+_Add a short description_

package/.gitignore.npmignore

@@ -0,0 +1 @@
+static-tests

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 2.3.1
+
+<!-- dprint-ignore -->
+- Fixed the following error when parsing `typescript`` config:\
+  `Configuration for rule "@typescript-eslint/prefer-string-starts-ends-with" is invalid: Value true should be string.`
+- Added `no-restricted-syntax` rules to ensure that Angular optional dependencies are marked as optional in TypeScript and vice-versa
+- Fixed Storybook custom `.ts` configuration not being applied
+- Disabled `autofix/indent-legacy`
+
+<!-- TODO: Validate that static-tests are not published -->
+
+## 2.3.0
+
+- Allow single element equality for `@typescript-eslint/prefer-string-starts-ends-with`
+- Disabled `unicorn/prefer-string-raw` for json-like and eslintrc.json
+- Set tsconfig's `angularCompilerOptions.enableI18nLegacyMessageIdFormat` to `false`
+- Set tsconfig's `compilerOptions.target` to `"ES2022"`
+  For more details, see [this `@angular/cli` warning](https://github.com/angular/angular-cli/blob/16.2.0/packages/angular_devkit/build_angular/src/tools/webpack/plugins/typescript.ts#L36-L39)
+- Presets for Jest now consider the framework (Angular, React, or DOM)
+- Updated Jest file matching to Jest's default patterns
+- No longer leaving empty strings for eslint extends generated by NX
+- Fixed an invalid syntax for `@nx/js` patching
+
 ## 2.2.1
 
 - Bumped `eslint-plugin-react` to `^7.33`
@@ -29,7 +52,6 @@
   - `jest/prefer-importing-jest-globals` is enabled by default, which removes needing a dependency
     on often outdated `@types/jest` and removes the need for `types: ["jest"]` in `tsconfig.json`
 - Bumped `dprint` to `^0.40.2` to prepare for process plugins
-
 - Bumped `@typescript-eslint/eslint-plugin` to `^7.4`
   - Re-enabled `@typescript-eslint/no-import-type-side-effects`
     and set `@typescript-eslint/consistent-type-imports` back to default options
@@ -38,13 +60,11 @@
 - Prefered `@typescript-eslint/prefer-destructuring` over `autofix/prefer-destructuring`
 - Disabled `@typescript-eslint/key-spacing`, `autofix/func-call-spacing`,
   and `lines-around-comment` in `dprint` preset
-
 - Patched-out prettier from nx generators
 - Used Search&Replace based package patching:
   - Removes `patch-package` from dependencies
   - Removes bundled git patches
 - Speedup check for `eslint-plugin-total-functions` install
-
 - Bumped `eslint-plugin-n` to `>=16.2`. Notably, this:
   - improves support for ts-node
   - Updates documentation links

package/README.md

@@ -99,7 +99,7 @@ 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.
+[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, as well as `*.[jt]s` and `*.[jt]sx` files inside of `__tests__` folders. 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`
 
@@ -179,7 +179,7 @@ npm install --save-dev eslint-plugin-mui eslint-plugin-jsx-a11y eslint-plugin-re
 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 that your base `tsconfig.json` extends `eslint-config-beslogic/tsconfig.X.X.json` (see [Parallel configurations](#parallel-configurations)).\
-If bundling with an npm package set `"strictMetadataEmit": true` under `angularCompilerOptions`.
+If bundling as an npm package set `"strictMetadataEmit": true` under `angularCompilerOptions`.
 
 Add the following `devDependencies` to your `package.json`:
 

package/angular.js

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright 2024 Beslogic Inc.
 
-const { getModuleVersion, jestNoRestrictedSyntax } = require("./lib/utils")
+const { getModuleVersion, jestNoRestrictedSyntax, jestFilePatterns } = require("./lib/utils")
 
 const angularEslintVersion = getModuleVersion("@angular-eslint/eslint-plugin", 16.2)
 const typescriptVersion = getModuleVersion("typescript", 4.7)
@@ -31,6 +31,17 @@ const noRestrictedSyntax = [
     "message":
       "Forbidden non-null property assertion. https://typescript-eslint.io/rules/no-non-null-assertion . " +
       "This is only allowed on required component @Input({ required:true }). https://angular.io/api/core/Input#required"
+  },
+  {
+    "selector":
+      "MethodDefinition[key.name=\"constructor\"]:has(TSParameterProperty:has(Decorator[expression.callee.name=\"Optional\"]):not(:has(Identifier[optional=true])))",
+    "message":
+      "Constructor parameter with @Optional decorator should be marked as optional using `?`."
+  },
+  {
+    "selector":
+      "ClassDeclaration:has(Decorator :matches([name=\"Component\"], [name=\"Injectable\"], [name=\"Directive\"], [name=\"Pipe\"])) MethodDefinition[key.name=\"constructor\"]:has(TSParameterProperty:has(Identifier[optional=true]):not(:has(Decorator[expression.callee.name=\"Optional\"])))",
+    "message": "Optional constructor parameter should have @Optional decorator."
   }
 ]
 
@@ -341,7 +352,8 @@ module.exports = {
       }
     },
     {
-      "files": ["*spec.ts"],
+      "files": jestFilePatterns,
+      "extends": ["plugin:testing-library/angular"],
       "rules": { "no-restricted-syntax": jestNoRestrictedSyntax(noRestrictedSyntax) }
     },
     {

package/javascript.js

@@ -2,7 +2,7 @@
 // Copyright 2024 Beslogic Inc.
 
 const restrictedGlobals = require("confusing-browser-globals")
-const { jestNoRestrictedSyntax } = require("./lib/utils")
+const { jestNoRestrictedSyntax, jestFilePatterns } = require("./lib/utils")
 
 const commaDangleDefault = "always-multiline"
 const idLenghtConfig = {
@@ -90,7 +90,6 @@ module.exports = {
   "ignorePatterns": ["node_modules/"],
   // Useful when using experimental features and code transpiled by Babel
   "parser": "@babel/eslint-parser",
-  "reportUnusedDisableDirectives": true,
   "overrides": [
     {
       "files": [
@@ -301,6 +300,9 @@ module.exports = {
           }
         ],
 
+        // indent-legacy is deprecated in favor of indent
+        "autofix/indent-legacy": "off",
+
         // Using simple-import-sort instead
         "autofix/sort-imports": "off",
 
@@ -379,10 +381,7 @@ module.exports = {
       }
     },
     {
-      "files": [
-        "*spec.js",
-        ".test.jsx"
-      ],
+      "files": jestFilePatterns,
       "extends": ["./jest"],
       "rules": { "no-restricted-syntax": jestNoRestrictedSyntax(noRestrictedSyntax) }
     },
@@ -393,7 +392,11 @@ module.exports = {
       ],
       // To reconsider, since this would conflict with a simple dprint default
       // "extends": ["./json-like"]
-      "globals": { "module": true }
+      "globals": { "module": true },
+      "rules": {
+        // Keep consistent with preset rules
+        "unicorn/prefer-string-raw": "off"
+      }
     }
   ],
   "rules": {
@@ -576,18 +579,18 @@ module.exports = {
       {
         "groups": [
           // Side effect imports.
-          [String.raw`^\u0000`],
+          ["^\\u0000"],
           // Node.js builtins prefixed with `node:`.
           ["^node:"],
           // Packages.
           // Things that start with a letter (or digit or underscore), or `@` followed by a letter.
-          [String.raw`^@?\w`],
+          ["^@?\\w"],
           // Absolute imports and other imports such as Vue-style `@/foo`.
           // Anything not matched in another group.
           ["^"],
           // Relative imports.
           // Anything that starts with a dot or src/
-          [String.raw`^(\.|src/)`]
+          ["^(\\.|src/)"]
         ]
       }
     ],

package/jest.js

@@ -9,7 +9,9 @@ module.exports = {
   "extends": [
     "plugin:jest/all",
     "plugin:jest-formatting/strict",
-    "plugin:testing-library/angular"
+    // Note: The DOM preset includes some rules not in Marko or Vue (eg.: no-await-sync-events).
+    // Those must be disabled in their preset if we ever support them.
+    "plugin:testing-library/dom"
   ],
   "env": {
     "browser": false,
@@ -87,6 +89,13 @@ module.exports = {
       {
         "allow": ["beforeEach"]
       }
-    ]
+    ],
+
+    /*
+     * testing-library overrides (https://github.com/testing-library/eslint-plugin-testing-library#supported-rules)
+     */
+    "testing-library/no-debugging-utils": "error",
+    "testing-library/prefer-user-event": "warn",
+    "testing-library/prefer-explicit-assert": "error"
   }
 }

package/lib/patch-dependencies.js

@@ -67,16 +67,11 @@ const patches = [
         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:@nx/angular",
-            "to": ""
-          },
-          {
-            "from": "plugin:@angular-eslint/template/process-inline-templates",
-            "to": ""
-          },
-          {
-            "from": "plugin:@nx/angular-template",
+            "from": /'plugin:.+?',?/gu,
             "to": ""
           },
           // Remove empty extends
@@ -146,8 +141,9 @@ const patches = [
           "to": "false"
         },
         {
-          "from": "devkit_1.ensurePackage)('prettier'",
-          "to": "//"
+          // eslint-disable-next-line regexp/no-super-linear-move -- Is it really?
+          "from": /.+?devkit_1\.ensurePackage\)\('prettier'.+?[\n;]/gu,
+          "to": ""
         }
       ]
     )

package/lib/utils.js

@@ -36,8 +36,15 @@ const jestNoRestrictedSyntax = (
     !entry.selector.startsWith("ArrowFunctionExpression")
   )
 
+// Matching Jest's own default file patterns: https://jestjs.io/docs/configuration#testmatch-arraystring
+const jestFilePatterns = [
+  "**/__tests__/**/*.[jt]s?(x)",
+  "**/?(*.)+(spec|test).[jt]s?(x)"
+]
+
 module.exports = {
   getModuleVersion,
   jestNoRestrictedSyntax,
-  resolveModuleLocation
+  resolveModuleLocation,
+  jestFilePatterns
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-beslogic",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "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",
@@ -10,6 +10,7 @@
     "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",
     "postinstall": "node ./lib/patch-dependencies.js",
     "dependencies": "node ./lib/patch-dependencies.js"
   },
@@ -81,10 +82,17 @@
     "eslint-plugin-testing-library": "^6.0",
     "eslint-plugin-total-functions": ">=6.0"
   },
+  "// plugins": "Test against highest supported version to catch new breaking changes",
   "devDependencies": {
+    "@angular-eslint/eslint-plugin": ">=16.2",
+    "@angular-eslint/eslint-plugin-template": ">=16.2",
+    "@angular-eslint/template-parser": ">=16.2",
+    "@angular/core": ">=16.2",
     "@types/eslint": "^8.37.0",
     "@types/node": "^17.0",
     "eslint-plugin-eslint-plugin": "^4.1",
+    "eslint-plugin-storybook": "^0.6.10",
+    "eslint-plugin-total-functions": ">=6.0",
     "yalc": "^1.0.0-pre.53"
   }
 }

package/react.js

@@ -17,6 +17,8 @@ preventAbbreviationsConfig.allowList.Props = true
 preventAbbreviationsConfig.allowList.ref = true
 preventAbbreviationsConfig.allowList.Ref = true
 
+const { jestFilePatterns } = require("./lib/utils")
+
 /** @type {import("eslint").Linter.Config} */
 module.exports = {
   "extends": [
@@ -88,6 +90,10 @@ module.exports = {
         ]
       }
     },
+    {
+      "files": jestFilePatterns,
+      "extends": ["plugin:testing-library/react"]
+    },
     typeDefinitionOverride
   ],
   "rules": {

package/storybook.js

@@ -2,7 +2,7 @@
 // Copyright 2024 Beslogic Inc.
 
 const angularConfig = require("./angular")
-const { jestNoRestrictedSyntax } = require("./lib/utils")
+const { jestNoRestrictedSyntax, jestFilePatterns } = require("./lib/utils")
 
 const noRestrictedSyntax = angularConfig.overrides?.[1].rules?.["no-restricted-syntax"]
 /** @type {import("eslint").Linter.Config} */
@@ -13,7 +13,7 @@ module.exports = {
   ],
   "overrides": [
     {
-      "files": [".ts"],
+      "files": ["*.ts"],
       "rules": {
         "no-restricted-syntax": [
           ...noRestrictedSyntax,
@@ -28,10 +28,7 @@ module.exports = {
       }
     },
     {
-      "files": [
-        "*spec.ts",
-        ".test.tsx"
-      ],
+      "files": jestFilePatterns,
       "rules": { "no-restricted-syntax": jestNoRestrictedSyntax(noRestrictedSyntax) }
     }
   ]

package/tsconfig.4.3.json

@@ -10,7 +10,8 @@
     // You should probably disable it at least in tests.
     "noUncheckedIndexedAccess": true,
     "module": "ESNext", // ESNext or CommonJS
-    "target": "ES2017", // ES2017 or higher
+    // See: https://github.com/angular/angular-cli/blob/16.2.0/packages/angular_devkit/build_angular/src/tools/webpack/plugins/typescript.ts#L36-L39
+    "target": "ES2022", // ES2022 or higher
     "lib": [
       "ES2021", // ES2021 or higher
       "DOM",
@@ -20,8 +21,10 @@
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true
   },
+  // https://next.angular.dev/reference/configs/angular-compiler-options
   "angularCompilerOptions": {
     // "strictMetadataEmit": true, // For bundling with an npm package
+    "enableI18nLegacyMessageIdFormat": false,
     "strictInjectionParameters": true,
     "strictInputAccessModifiers": true,
     "strictTemplates": true,

package/typescript.js

@@ -2,7 +2,7 @@
 // Copyright 2024 Beslogic Inc.
 
 const javascriptConfig = require("./javascript")
-const { jestNoRestrictedSyntax } = require("./lib/utils")
+const { jestNoRestrictedSyntax, jestFilePatterns } = require("./lib/utils")
 const { resolveModuleLocation } = require("./lib/utils")
 
 const commaDangleDefault = "always-multiline"
@@ -396,6 +396,10 @@ module.exports = {
         "@typescript-eslint/prefer-enum-initializers": "off",
         // TODO: Would accept this if it had autofixes, otherwise this is too tedious to use. Check again later
         "@typescript-eslint/prefer-readonly-parameter-types": "off",
+        "@typescript-eslint/prefer-string-starts-ends-with": [
+          "error",
+          { "allowSingleElementEquality": "always" }
+        ],
         "@typescript-eslint/promise-function-async": [
           "error",
           {
@@ -507,10 +511,7 @@ module.exports = {
       }
     },
     {
-      "files": [
-        "*spec.ts",
-        ".test.tsx"
-      ],
+      "files": jestFilePatterns,
       "extends": ["./jest"],
       "rules": {
         "no-restricted-syntax": jestNoRestrictedSyntax(noRestrictedSyntax)