lint-suite 1.2.2 → 1.3.0

package/README.md

@@ -4,61 +4,76 @@ A comprehensive collection of ESLint Flat configurations for modern web applicat
 
 ## Features
 
-- **TypeScript Linting**: Strict typing rules, consistent imports, and code organization
-- **Angular Support**: Component best practices (including Signals), template accessibility rules, and modern control flow
-- **RxJS Guidelines**: Observable patterns, Finnish notation, and operator safety
+- **TypeScript Linting**: Strict typing rules, v8 type-safety replacements, consistent imports, and code organization
+- **Angular Support**: Component best practices (including Signals), Angular 21+ template rules, and modern control flow
+- **RxJS Guidelines**: Observable patterns, Finnish notation, subject encapsulation, and operator safety
 - **Code Style**: Formatting rules, line limits, and structural consistency
 - **Accessibility**: ARIA validation, keyboard events, and semantic HTML
-- **Testing**: Jest configurations with appropriate relaxations for test files
-- **Additional Support**: JSON, Storybook, and more
+- **Testing**: Jest, Vitest, and Playwright configurations with best-practice rules
+- **Prettier**: Automatic disabling of formatting rules that conflict with Prettier
+- **Architecture**: Module boundary enforcement with `eslint-plugin-boundaries`
+- **Additional Support**: JSON (with comment support for tsconfig), Storybook CSF enforcement
 
 ## Installation
 
 ```bash
-npm install --save-dev lint-suite
+pnpm add -D lint-suite
 ```
 
 ## Dependencies
 
 ```bash
-npm install --save-dev eslint typescript-eslint eslint-config-prettier
+pnpm add -D eslint typescript-eslint eslint-config-prettier
 ```
 
 ## Usage
 
-Create a `.eslintrc.config.mjs` file in your project root:
+Create an `eslint.config.mjs` file in your project root:
 
 ```js
-import { base, javascript, typescript } from 'lint-suite';
+import { recommended } from 'lint-suite';
+
+export default [...recommended];
+```
+
+Or selectively include configurations:
+
+```js
+import { base, javascript, typescript, prettier } from 'lint-suite';
 
 export default [
   ...base,
   ...javascript,
-  ...typescript
-  // Rest of the required configurations
+  ...typescript,
+  ...prettier // Must be last to disable conflicting formatting rules
 ];
 ```
 
-You can selectively include configurations you need.
-
 ## Available Configurations
 
-- `base`: Core JavaScript rules and formatting
-- `typescript`: TypeScript-specific rules
-- `angular`: Angular component best practices
-- `angularTemplate`: HTML template rules with accessibility focus
-- `rxjs`: Observable patterns and operator safety
-- `jest`: Testing configurations
-- `json`: JSON file linting
-- `storybook`: Storybook support
-- `boundaries`: Enforce module boundaries (feature, data-access, ui, etc.)
+| Configuration       | Description                                              |
+| ------------------- | -------------------------------------------------------- |
+| `base`              | Core JavaScript rules, formatting, and complexity limits |
+| `javascript`        | JavaScript-specific rules via `@nx/eslint-plugin`        |
+| `typescript`        | TypeScript strict typing, imports, and naming conventions |
+| `angular`           | Angular component best practices with Signal support     |
+| `angularTemplate`   | HTML template rules with accessibility and performance   |
+| `rxjs`              | Observable patterns, operator safety, and subscriptions  |
+| `jest`              | Jest testing best practices and matchers                 |
+| `vitest`            | Vitest testing rules and matcher improvements            |
+| `playwright`        | Playwright e2e locator and matcher best practices        |
+| `json`              | JSON linting with comment support for tsconfig/vscode    |
+| `storybook`         | Storybook CSF enforcement                                |
+| `boundaries`        | Module boundary rules (feature, data-access, ui, etc.)   |
+| `prettier`          | Disables rules that conflict with Prettier (use last)    |
+| **`recommended`**   | **All of the above combined in the correct order**       |
 
 ## Customization
 
 You can override any rules by adding a `rules` section to your ESLint config:
 
 ```js
-import { typescript } from 'lint-suite';
+import { typescript, prettier } from 'lint-suite';
 
 export default [
   ...typescript,
@@ -66,7 +81,8 @@ export default [
     rules: {
       '@typescript-eslint/explicit-function-return-type': 'off'
     }
-  }
+  },
+  ...prettier
 ];
 ```
 
@@ -80,9 +96,24 @@ export default [
 
 ### eslint-plugin-jest
 
-- `jest/no-disabled-tests`: Disallows disabled tests
-- `jest/expect-expect`: Ensures test cases contain at least one expect statement
-- `jest/valid-expect`: Validates expect() usage
+- `jest/consistent-test-it`: Enforces consistent test function usage (`it`)
+- `jest/prefer-comparison-matcher`: Enforces comparison matchers
+- `jest/prefer-hooks-on-top`: Ensures hooks are at the top of describe blocks
+- `jest/no-conditional-in-test`: Warns against conditionals in tests
+- ...
+
+### @vitest/eslint-plugin
+
+- `vitest/max-nested-describe`: Limits describe nesting depth
+- `vitest/prefer-to-be`: Enforces `toBe` matcher usage
+- `vitest/no-conditional-in-test`: Disallows conditionals in tests
+- ...
+
+### eslint-plugin-playwright
+
+- `playwright/prefer-locator`: Enforces modern locator API
+- `playwright/prefer-native-locators`: Prefers native locator methods
+- `playwright/prefer-to-be`: Enforces `toBe` matcher usage
 - ...
 
 ### eslint-plugin-json
@@ -94,22 +125,23 @@ export default [
 ### @smarttools/eslint-plugin-rxjs
 
 - `@rxjs/finnish`: Enforces Finnish notation for observables
-- `@rxjs/no-ignored-subscription`: Prevents ignoring returned subscriptions
+- `@rxjs/no-exposed-subjects`: Enforces subject encapsulation
+- `@rxjs/no-cyclic-action`: Prevents infinite loops in NgRx effects
 - `@rxjs/no-unsafe-takeuntil`: Ensures proper usage of takeUntil operator
 - ...
 
 ### eslint-plugin-storybook
 
-- `storybook/no-redundant-story-name`: Prevents redundant story names
-- `storybook/csf-component`: Enforces Component Story Format standards
-- `storybook/hierarchy-separator`: Enforces story hierarchy separators
+- `storybook/csf-component`: Enforces component property in stories
+- `storybook/no-stories-of`: Prevents deprecated `storiesOf` API
 - ...
 
-### eslint-plugin-import
+### eslint-plugin-import-x
 
-- `import/no-unresolved`: Ensures imports point to valid modules
-- `import/order`: Enforces a consistent order of import statements
-- `import/no-duplicates`: Prevents duplicate imports
+- `import-x/no-cycle`: Detects circular dependencies
+- `import-x/no-self-import`: Prevents modules importing themselves
+- `import-x/order`: Enforces a consistent order of import statements
+- `import-x/consistent-type-specifier-style`: Consistent type import style
 - ...
 
 ### @stylistic/eslint-plugin
@@ -119,18 +151,17 @@ export default [
 - `@stylistic/quotes`: Enforces consistent quote style
 - ...
 
+### eslint-config-prettier
+
+- Automatically disables all ESLint rules that conflict with Prettier
+- Must be the last configuration in the array
+
 ## Contributing
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.
+See [CHANGELOG.md](./CHANGELOG.md) for version history.
+See [RELEASE_NOTES.md](./RELEASE_NOTES.md) for detailed release notes.
 
 ## License
 
 MIT
-
-```
-
-```
-
-```
-
-```

package/index.cjs

@@ -38,6 +38,7 @@ __export(index_exports, {
   jest: () => jest,
   json: () => json,
   playwright: () => playwright,
+  prettier: () => prettier,
   recommended: () => recommended,
   rxjs: () => rxjs,
   storybook: () => storybook,
@@ -74,11 +75,27 @@ var angularTemplate = (0, import_config.defineConfig)([
       "@angular-eslint/template/prefer-self-closing-tags": "error",
       "@angular-eslint/template/prefer-ngsrc": "error",
       "@angular-eslint/template/prefer-built-in-pipes": "error",
-      "@angular-eslint/template/no-call-expression": "error",
       "@angular-eslint/template/no-interpolation-in-attributes": "error",
       "@angular-eslint/template/no-nested-tags": "error",
       "@angular-eslint/template/use-track-by-function": "error",
       "@angular-eslint/template/label-has-associated-control": "error",
+      "@angular-eslint/template/prefer-at-else": "error",
+      // v21: @if/@else syntax
+      "@angular-eslint/template/prefer-at-empty": "error",
+      // v21: @for/@empty syntax
+      "@angular-eslint/template/prefer-contextual-for-variables": "error",
+      // v21: Use $index, $first, etc.
+      "@angular-eslint/template/no-empty-control-flow": "error",
+      // v21: Catch incomplete refactoring
+      "@angular-eslint/template/prefer-class-binding": "error",
+      // v21.2.0: Prefer [class] over ngClass
+      "@angular-eslint/template/prefer-static-string-properties": "error",
+      // Reduce change detection
+      "@angular-eslint/template/conditional-complexity": [
+        "warn",
+        { maxComplexity: 5 }
+      ],
+      // Template readability
       "@angular-eslint/template/attributes-order": [
         "error",
         {
@@ -125,7 +142,17 @@ var angular = (0, import_config2.defineConfig)([
       "@angular-eslint/use-injectable-provided-in": "error",
       "@angular-eslint/prefer-signal-model": "error",
       "@angular-eslint/no-uncalled-signals": "error",
-      "@angular-eslint/prefer-host-metadata-property": "error"
+      "@angular-eslint/prefer-host-metadata-property": "error",
+      "@angular-eslint/no-implicit-take-until-destroyed": "error",
+      // v21.2.0: Enforce explicit DestroyRef
+      "@angular-eslint/no-async-lifecycle-method": "error",
+      // Prevent async lifecycle hooks
+      "@angular-eslint/prefer-output-readonly": "warn",
+      // Prevent accidental reassignment
+      "@angular-eslint/prefer-output-emitter-ref": "warn",
+      // Modern output() function over @Output()
+      "@angular-eslint/sort-lifecycle-methods": "warn"
+      // Consistent lifecycle method ordering
     }
   }
 ]);
@@ -188,7 +215,10 @@ var base = (0, import_config3.defineConfig)([
       "no-useless-concat": "error",
       "prefer-template": "error",
       "no-nested-ternary": "error",
-      "no-return-await": "error",
+      "no-useless-assignment": "error",
+      // NEW: Catch unused assignments (ESLint v9)
+      "no-object-constructor": "error",
+      // Disallow new Object() without arguments
       "no-else-return": ["error", { allowElseIf: false }],
       // Prefer early returns
       "no-multi-assign": "error",
@@ -370,9 +400,29 @@ var import_config5 = require("eslint/config");
 var jest = (0, import_config5.defineConfig)([
   {
     files: ["**/*.spec.ts", "**/*.spec.js"],
-    extends: [import_eslint_plugin_jest.default.configs["flat/all"]],
+    extends: [import_eslint_plugin_jest.default.configs["flat/recommended"]],
     rules: {
-      "jest/no-done-callback": "off"
+      "jest/no-done-callback": "off",
+      // Elevated from recommended defaults
+      "jest/no-focused-tests": "error",
+      "jest/no-identical-title": "error",
+      "jest/valid-expect": "error",
+      // Style rules (selective additions from flat/style)
+      "jest/prefer-to-be": "warn",
+      "jest/prefer-to-contain": "warn",
+      "jest/prefer-to-have-length": "warn",
+      // Best practice additions
+      "jest/consistent-test-it": ["error", { fn: "it" }],
+      "jest/prefer-comparison-matcher": "error",
+      "jest/prefer-equality-matcher": "error",
+      "jest/prefer-hooks-on-top": "error",
+      "jest/prefer-spy-on": "error",
+      "jest/prefer-strict-equal": "warn",
+      "jest/prefer-mock-promise-shorthand": "error",
+      "jest/no-conditional-in-test": "warn",
+      "jest/no-duplicate-hooks": "error",
+      "jest/no-test-return-statement": "error",
+      "jest/require-to-throw-message": "warn"
     }
   }
 ]);
@@ -384,13 +434,22 @@ var json = (0, import_config6.defineConfig)([
   {
     files: ["**/*.json"],
     extends: [import_eslint_plugin_json.default.configs.recommended]
+  },
+  {
+    files: ["**/tsconfig*.json", "**/.vscode/*.json"],
+    extends: [import_eslint_plugin_json.default.configs["recommended-with-comments"]]
   }
 ]);
 
+// packages/lint-suite/src/lib/prettier.ts
+var import_eslint_config_prettier = __toESM(require("eslint-config-prettier"), 1);
+var import_config7 = require("eslint/config");
+var prettier = (0, import_config7.defineConfig)([import_eslint_config_prettier.default]);
+
 // packages/lint-suite/src/lib/rxjs.ts
 var import_eslint_plugin_rxjs = __toESM(require("@smarttools/eslint-plugin-rxjs"), 1);
-var import_config7 = require("eslint/config");
-var rxjs = (0, import_config7.defineConfig)([
+var import_config8 = require("eslint/config");
+var rxjs = (0, import_config8.defineConfig)([
   {
     files: [
       "**/*.js",
@@ -446,7 +505,13 @@ var rxjs = (0, import_config7.defineConfig)([
       "rxjs/no-unsafe-first": "error",
       "rxjs/no-topromise": "error",
       "rxjs/throw-error": "error",
-      "rxjs/no-async-subscribe": "off"
+      "rxjs/no-async-subscribe": "off",
+      "rxjs/no-exposed-subjects": "error",
+      // Enforce subject encapsulation
+      "rxjs/no-cyclic-action": "error",
+      // Prevent infinite loops in NgRx effects
+      "rxjs/no-subscribe-handlers": "warn"
+      // Prefer observer objects (complements prefer-observer)
     }
   },
   {
@@ -459,12 +524,18 @@ var rxjs = (0, import_config7.defineConfig)([
 
 // packages/lint-suite/src/lib/storybook.ts
 var import_eslint_plugin_storybook = __toESM(require("eslint-plugin-storybook"), 1);
-var import_config8 = require("eslint/config");
-var storybook = (0, import_config8.defineConfig)([
+var import_config9 = require("eslint/config");
+var storybook = (0, import_config9.defineConfig)([
   {
     ignores: ["!.storybook"],
     files: ["**/*.stories.ts"],
-    extends: [import_eslint_plugin_storybook.default.configs["flat/recommended"]]
+    extends: [import_eslint_plugin_storybook.default.configs["flat/recommended"]],
+    rules: {
+      "storybook/csf-component": "warn",
+      // Ensure component property is set
+      "storybook/no-stories-of": "error"
+      // Prevent deprecated storiesOf API
+    }
   }
 ]);
 
@@ -472,7 +543,7 @@ var storybook = (0, import_config8.defineConfig)([
 var import_eslint_plugin4 = require("@nx/eslint-plugin");
 var import_eslint_import_resolver_typescript = require("eslint-import-resolver-typescript");
 var import_eslint_plugin_import_x2 = __toESM(require("eslint-plugin-import-x"), 1);
-var import_config9 = require("eslint/config");
+var import_config10 = require("eslint/config");
 
 // packages/lint-suite/src/lib/rules/explicit-accessibility.ts
 var import_utils = require("@typescript-eslint/utils");
@@ -613,7 +684,7 @@ var localTypescriptRules = {
     "explicit-accessibility": explicit_accessibility_default
   }
 };
-var typescript = (0, import_config9.defineConfig)([
+var typescript = (0, import_config10.defineConfig)([
   // NOTE: Checks for 'prettier' and 'eslint-plugin-prettier'
   {
     files: ["**/*.ts", "**/*.tsx", "**/*.cts", "**/*.mts"],
@@ -639,6 +710,13 @@ var typescript = (0, import_config9.defineConfig)([
       "@typescript-eslint/no-unsafe-member-access": "error",
       "@typescript-eslint/no-unsafe-return": "error",
       "@typescript-eslint/no-unsafe-argument": "error",
+      // New v8 type-safety rules (replacements for deprecated ban-types)
+      "@typescript-eslint/no-empty-object-type": "error",
+      // Bans confusing {} type
+      "@typescript-eslint/no-unsafe-function-type": "error",
+      // Bans Function type
+      "@typescript-eslint/no-wrapper-object-types": "error",
+      // Bans Number, String, Boolean wrappers
       // B. Explicit Annotations (partially covered, explicit module boundaries is key)
       "@typescript-eslint/explicit-module-boundary-types": "error",
       // Consider enabling if maximum explicitness is desired, even if verbose:
@@ -659,8 +737,14 @@ var typescript = (0, import_config9.defineConfig)([
       // E. Best Practices & Potential Errors (Some covered by presets, fine-tuning here)
       "@typescript-eslint/no-inferrable-types": "warn",
       // Keep as warn or disable if inference is preferred
-      "@typescript-eslint/no-var-requires": "error",
-      // Use ES modules
+      "@typescript-eslint/no-require-imports": "error",
+      // Use ES modules (replaces deprecated no-var-requires)
+      "@typescript-eslint/only-throw-error": "error",
+      // Replaces deprecated no-throw-literal
+      "@typescript-eslint/no-array-delete": "error",
+      // Prevents delete arr[0]
+      "@typescript-eslint/return-await": ["error", "in-try-catch"],
+      // Better stack traces in try/catch
       "@typescript-eslint/require-await": "error",
       "@typescript-eslint/restrict-template-expressions": [
         "error",
@@ -680,6 +764,32 @@ var typescript = (0, import_config9.defineConfig)([
       "@typescript-eslint/no-useless-constructor": "error",
       "@typescript-eslint/dot-notation": ["error", { allowKeywords: true }],
       // Prefer dot notation where possible
+      // Strict type-checked rules
+      "@typescript-eslint/no-unnecessary-condition": "error",
+      // Catches always-true/false conditions
+      "@typescript-eslint/no-confusing-void-expression": "error",
+      // Prevent confusing void usage
+      "@typescript-eslint/no-dynamic-delete": "error",
+      // Use Map instead of delete obj[key]
+      "@typescript-eslint/no-extraneous-class": ["error", { allowWithDecorator: true }],
+      // Allow Angular classes
+      "@typescript-eslint/no-invalid-void-type": "error",
+      // Restrict void to return types
+      "@typescript-eslint/unified-signatures": "error",
+      // Merge overloads where possible
+      "@typescript-eslint/no-non-null-asserted-nullish-coalescing": "error",
+      // Forbids foo! ?? bar
+      // Stylistic type-checked rules
+      "@typescript-eslint/prefer-find": "error",
+      // Use find() instead of filter()[0]
+      "@typescript-eslint/prefer-for-of": "error",
+      // Modern iteration
+      "@typescript-eslint/prefer-includes": "error",
+      // indexOf() → includes()
+      "@typescript-eslint/prefer-string-starts-ends-with": "error",
+      // Modern string methods
+      "@typescript-eslint/prefer-regexp-exec": "error",
+      // Better regex performance
       // F. Consistency & Style (Some covered by stylistic-type-checked)
       "@typescript-eslint/consistent-type-assertions": [
         "error",
@@ -781,10 +891,18 @@ var typescript = (0, import_config9.defineConfig)([
       "import-x/no-unresolved": "error",
       "import-x/no-duplicates": "error",
       "import-x/prefer-default-export": "off",
-      "import-x/no-useless-path-segments": "error",
+      "import-x/no-useless-path-segments": ["error", { noUselessIndex: true }],
       "import-x/newline-after-import": "error",
       "import-x/first": "error",
-      "import-x/no-mutable-exports": "error"
+      "import-x/no-mutable-exports": "error",
+      "import-x/no-self-import": "error",
+      // Prevents modules importing themselves
+      "import-x/no-cycle": ["error", { maxDepth: 2, ignoreExternal: true }],
+      // Prevents circular dependencies
+      "import-x/consistent-type-specifier-style": ["error", "prefer-top-level"],
+      // Consistent type imports
+      "import-x/no-anonymous-default-export": "error"
+      // Improve code searchability
     },
     settings: {
       "import-x/resolver-next": [
@@ -838,38 +956,63 @@ var typescript = (0, import_config9.defineConfig)([
 
 // packages/lint-suite/src/lib/vitest.ts
 var import_eslint_plugin5 = __toESM(require("@vitest/eslint-plugin"), 1);
-var import_config10 = require("eslint/config");
+var import_config11 = require("eslint/config");
 var vitestPlugin = {
   vitest: import_eslint_plugin5.default
 };
-var vitest = (0, import_config10.defineConfig)([
+var vitest = (0, import_config11.defineConfig)([
   {
     files: ["**/*.spec.ts", "**/*.spec.js", "**/*.test.ts", "**/*.test.js"],
     plugins: vitestPlugin,
     rules: {
       ...import_eslint_plugin5.default.configs.recommended.rules,
-      "vitest/max-nested-describe": ["error", { max: 3 }]
+      "vitest/max-nested-describe": ["error", { max: 3 }],
+      // Matcher improvements
+      "vitest/prefer-to-be": "error",
+      "vitest/prefer-to-contain": "error",
+      "vitest/prefer-to-have-length": "error",
+      "vitest/prefer-comparison-matcher": "error",
+      "vitest/prefer-strict-equal": "warn",
+      // Test quality
+      "vitest/prefer-spy-on": "error",
+      "vitest/prefer-hooks-on-top": "error",
+      "vitest/prefer-each": "warn",
+      "vitest/no-conditional-in-test": "error",
+      "vitest/no-test-return-statement": "error",
+      "vitest/prefer-mock-promise-shorthand": "error"
     }
   }
 ]);
 
 // packages/lint-suite/src/lib/playwright.ts
 var import_eslint_plugin_playwright = __toESM(require("eslint-plugin-playwright"), 1);
-var import_config11 = require("eslint/config");
-var playwright = (0, import_config11.defineConfig)([
+var import_config12 = require("eslint/config");
+var playwright = (0, import_config12.defineConfig)([
   {
     ...import_eslint_plugin_playwright.default.configs["flat/recommended"],
     files: ["**/*.e2e.ts", "**/*.e2e.js"],
     rules: {
-      ...import_eslint_plugin_playwright.default.configs["flat/recommended"].rules
+      ...import_eslint_plugin_playwright.default.configs["flat/recommended"].rules,
+      // Locator best practices
+      "playwright/prefer-locator": "error",
+      "playwright/prefer-native-locators": "error",
+      "playwright/no-nth-methods": "warn",
+      // Matcher improvements
+      "playwright/prefer-to-be": "error",
+      "playwright/prefer-to-have-count": "error",
+      "playwright/prefer-to-have-length": "error",
+      "playwright/prefer-comparison-matcher": "error",
+      // Test structure
+      "playwright/prefer-hooks-on-top": "error",
+      "playwright/require-top-level-describe": "warn"
     }
   }
 ]);
 
 // packages/lint-suite/src/lib/boundaries.ts
 var import_eslint_plugin_boundaries = __toESM(require("eslint-plugin-boundaries"), 1);
-var import_config12 = require("eslint/config");
-var boundaries = (0, import_config12.defineConfig)([
+var import_config13 = require("eslint/config");
+var boundaries = (0, import_config13.defineConfig)([
   {
     files: [
       "**/*.js",
@@ -917,6 +1060,8 @@ var boundaries = (0, import_config12.defineConfig)([
     },
     rules: {
       ...import_eslint_plugin_boundaries.default.configs.recommended.rules,
+      "boundaries/no-unknown": "warn",
+      // Warn on imports from uncategorized files
       "boundaries/element-types": [
         "error",
         {
@@ -973,7 +1118,9 @@ var recommended = [
   ...boundaries,
   ...storybook,
   ...vitest,
-  ...playwright
+  ...playwright,
+  ...prettier
+  // Must be last to disable formatting rules that conflict with Prettier
 ];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -985,6 +1132,7 @@ var recommended = [
   jest,
   json,
   playwright,
+  prettier,
   recommended,
   rxjs,
   storybook,