@testgorilla/tgo-linting 1.0.1 → 1.0.2

package/Readme.md

@@ -38,7 +38,7 @@ export default [
       tgo: tgoPlugin,
     },
     rules: {
-      'tgo/require-data-testid': 'warn',
+      'tgo/require-data-testid': 'warn', // Example rule configuration
     },
   },
 ];
@@ -82,7 +82,7 @@ module.exports = {
       files: ['*.html'],
       parser: '@angular-eslint/template-parser',
       rules: {
-        'tgo/require-data-testid': 'warn',
+        'tgo/require-data-testid': 'warn', // Example rule configuration
       },
     },
   ],
@@ -96,64 +96,101 @@ module.exports = {
 
 ## Rules
 
-### `tgo/require-data-testid`
-
-Ensures that specific HTML elements have a `data-testid` attribute for testing purposes. This makes it easier to write stable E2E tests by providing consistent selectors.
-
-**Severity:** `warn` (in recommended config)
-
-**Category:** Testing Best Practices
-
-#### Default Elements
-
-By default, this rule checks the following elements:
-- `button`
-- `mat-checkbox`
-- `input`
-- `mat-radio-button`
-- `mat-radio-group`
-- `h1`
-- `table`, `header-table`, `mat-table`
-- `img`
-- `textarea`
-- `ng-select`
-- `video`
-- `app-tgo-choice`
-- `testgorilla-confirm-dialog`
-- `mat-form-field`
-- `tgo-checkout-message`
-- `mat-dialog-actions`
-- `ui-button`
-
-#### Configuration
-
-You can customize which elements to check:
-
-```javascript
-{
-  rules: {
-    'tgo/require-data-testid': ['warn', {
-      tags: ['button', 'input', 'custom-element']
-    }]
-  }
-}
-```
-
-#### Examples
-
-❌ **Incorrect**
-
-```html
-<button>Click me</button>
-<input type="text" />
-```
-
-✅ **Correct**
-
-```html
-<button data-testid="submit-button">Click me</button>
-<input type="text" data-testid="email-input" />
-```
+### Available Rules
+
+| Rule | Description |
+|------|-------------|
+| `tgo/require-data-testid` | Ensures specific HTML elements have a `data-testid` attribute for E2E testing |
+
+### Rule Documentation
+
+Detailed documentation for each rule, including examples and configuration options, can be found alongside the rule implementation:
+
+- [require-data-testid](./src/rules/require-data-testid.md) - Enforces data-testid attributes on specified elements
+
+## Adding New Rules
+
+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'
+   
+   const rule: Rule.RuleModule = {
+     meta: {
+       type: 'problem', // or 'suggestion' or 'layout'
+       docs: {
+         description: 'Your rule description',
+         category: 'Best Practices',
+         recommended: false,
+       },
+       schema: [], // JSON schema for rule options
+       messages: {
+         // Define error messages here
+       },
+     },
+     create(context) {
+       // Your rule implementation
+       return {
+         // AST node visitors
+       }
+     },
+   }
+   
+   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'
+   
+   const ruleTester = new RuleTester({
+     parser: '@angular-eslint/template-parser',
+   })
+   
+   ruleTester.run('your-rule-name', rule, {
+     valid: [
+       // Test cases that should pass
+     ],
+     invalid: [
+       // Test cases that should fail
+     ],
+   })
+   ```
+
+3. **Export the rule** in `src/rules/index.ts`:
+   ```typescript
+   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',
+     'tgo/your-rule-name': 'error', // or 'warn'
+   }
+   ```
+
+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
+   - Explain the rationale
+
+6. **Update this README** by adding the new rule to the rules table above
+
+7. **Test your changes**:
+   ```bash
+   nx test tgo-linting
+   nx build tgo-linting
+   ```
 
 ## Development
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testgorilla/tgo-linting",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "peerDependencies": {
     "@angular-eslint/template-parser": ">= 17.0.0 < 20.0.0",
     "eslint": "^8 || ^9",