@testgorilla/tgo-linting 4.0.0 → 5.0.0

package/Readme.md

@@ -8,11 +8,34 @@ Linting rules and code quality standards for TestGorilla projects.
 npm install @testgorilla/tgo-linting @angular-eslint/template-parser --save-dev
 ```
 
+## Compatibility
+
+| tgo-linting | ESLint                | angular-eslint | Angular                                          |
+| ----------- | --------------------- | -------------- | ------------------------------------------------ |
+| 5.x         | `^9.0.0 \|\| ^10.0.0` | 21.x           | any (angular-eslint 21 bundles its own compiler) |
+| 4.x         | `^8.57.0 \|\| ^9.0.0` | 20.x           | any                                              |
+
+> **ESLint 9 consumers:** the bundled `eslint-plugin-rxjs-x@1.0.2` declares an
+> `eslint: ^10` peer dependency (no release of that plugin supports ESLint 9 and 10
+> simultaneously). Until your repo moves to ESLint 10, keep this override in your
+> `package.json` so `npm install` resolves cleanly:
+>
+> ```json
+> "overrides": {
+>   "eslint-plugin-rxjs-x": {
+>     "eslint": "$eslint"
+>   }
+> }
+> ```
+>
+> Consumers on ESLint 10 do not need the override.
+
 ## Usage
 
-This package supports both modern flat config (ESLint 9+) and legacy config formats (ESLint 8.x and below).
+This package requires ESLint flat config (`eslint.config.js`/`.mjs`) and ESLint 9 or 10.
+Support for legacy `.eslintrc.*` configs and ESLint 8 was removed in 5.0.0.
 
-### Flat Config (ESLint 9+)
+### Flat Config
 
 **Recommended approach:**
 
@@ -44,51 +67,6 @@ export default [
 ];
 ```
 
-### Legacy Config (ESLint 8.x and below)
-
-**Using the legacy preset:**
-
-```javascript
-// .eslintrc.js
-const { legacy } = require('@testgorilla/tgo-linting');
-
-module.exports = {
-  // Your base config
-  extends: [
-    // Your other extends
-  ],
-  plugins: ['tgo'],
-  overrides: [
-    {
-      files: ['*.html'],
-      parser: '@angular-eslint/template-parser',
-      ...legacy,
-    },
-  ],
-};
-```
-
-**Manual configuration:**
-
-```javascript
-// .eslintrc.js
-module.exports = {
-  plugins: ['tgo'],
-  extends: [
-    // Your other extends
-  ],
-  overrides: [
-    {
-      files: ['*.html'],
-      parser: '@angular-eslint/template-parser',
-      rules: {
-        'tgo/require-data-testid': 'warn', // Example rule configuration
-      },
-    },
-  ],
-};
-```
-
 ## Important Notes
 
 - **Template Parser Required:** The `tgo/require-data-testid` rule only works with HTML/Angular templates. You must configure `@angular-eslint/template-parser` for `.html` files.
@@ -98,8 +76,8 @@ module.exports = {
 
 ### Available Rules
 
-| Rule | Description |
-|------|-------------|
+| Rule                      | Description                                                                   |
+| ------------------------- | ----------------------------------------------------------------------------- |
 | `tgo/require-data-testid` | Ensures specific HTML elements have a `data-testid` attribute for E2E testing |
 
 ### Rule Documentation
@@ -113,10 +91,11 @@ Detailed documentation for each rule, including examples and configuration optio
 To add a new ESLint rule to this package:
 
 1. **Create the rule file** in `src/rules/`:
+
    ```typescript
    // src/rules/your-rule-name.ts
-   import { Rule } from 'eslint'
-   
+   import { Rule } from 'eslint';
+
    const rule: Rule.RuleModule = {
      meta: {
        type: 'problem', // or 'suggestion' or 'layout'
@@ -134,22 +113,23 @@ To add a new ESLint rule to this package:
        // Your rule implementation
        return {
          // AST node visitors
-       }
+       };
      },
-   }
-   
-   export default rule
+   };
+
+   export default rule;
    ```
 
 2. **Add tests** in `src/rules/your-rule-name.spec.ts`:
+
    ```typescript
-   import { RuleTester } from '@typescript-eslint/rule-tester'
-   import rule from './your-rule-name'
-   
+   import { RuleTester } from '@typescript-eslint/rule-tester';
+   import rule from './your-rule-name';
+
    const ruleTester = new RuleTester({
      parser: '@angular-eslint/template-parser',
-   })
-   
+   });
+
    ruleTester.run('your-rule-name', rule, {
      valid: [
        // Test cases that should pass
@@ -157,20 +137,22 @@ To add a new ESLint rule to this package:
      invalid: [
        // Test cases that should fail
      ],
-   })
+   });
    ```
 
 3. **Export the rule** in `src/rules/index.ts`:
+
    ```typescript
-   import yourRuleName from './your-rule-name'
-   
+   import yourRuleName from './your-rule-name';
+
    export const rules = {
      'require-data-testid': requireDataTestId,
      'your-rule-name': yourRuleName,
-   }
+   };
    ```
 
 4. **Add to recommended config** (optional) in `src/configs/recommended.ts`:
+
    ```typescript
    rules: {
      'tgo/require-data-testid': 'warn',
@@ -179,6 +161,7 @@ To add a new ESLint rule to this package:
    ```
 
 5. **Document the rule** in `src/rules/your-rule-name.md`:
+
    - Describe what the rule does
    - Provide configuration options
    - Show correct and incorrect code examples

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testgorilla/tgo-linting",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "displayName": "TGO Linting",
   "description": "Linting rules and code quality standards for TestGorilla projects",
   "author": "TestGorilla",
@@ -24,13 +24,13 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@angular-eslint/eslint-plugin": "^20.7.0",
-    "@angular-eslint/eslint-plugin-template": "^20.7.0",
-    "@angular-eslint/template-parser": "^20.7.0",
+    "@angular-eslint/eslint-plugin": "^21.4.0",
+    "@angular-eslint/eslint-plugin-template": "^21.4.0",
+    "@angular-eslint/template-parser": "^21.4.0",
     "@typescript-eslint/utils": "^8.56.1",
     "eslint-config-prettier": "10.1.8",
     "eslint-import-resolver-typescript": "4.4.4",
-    "eslint-plugin-import-x": "4.16.1",
+    "eslint-plugin-import-x": "4.16.2",
     "eslint-plugin-jsdoc": "62.7.1",
     "eslint-plugin-no-unsanitized": "4.1.5",
     "eslint-plugin-rxjs-x": "1.0.2",
@@ -38,7 +38,7 @@
     "typescript-eslint": "8.56.1"
   },
   "peerDependencies": {
-    "eslint": "^8.57.0 || ^9.0.0",
+    "eslint": "^9.0.0 || ^10.0.0",
     "typescript": ">=4.8.4 <6.0.0",
     "tslib": "^2.0.0"
   },