@testgorilla/tgo-linting 1.0.0 → 1.0.2

package/Readme.md

@@ -5,99 +5,192 @@ Linting rules and code quality standards for TestGorilla projects.
 ## Installation
 
 ```bash
-npm install @testgorilla/tgo-linting --save-dev
+npm install @testgorilla/tgo-linting @angular-eslint/template-parser --save-dev
 ```
 
 ## Usage
 
-Add the plugin to your ESLint configuration:
+This package supports both modern flat config (ESLint 9+) and legacy config formats (ESLint 8.x and below).
 
 ### Flat Config (ESLint 9+)
 
+**Recommended approach:**
+
 ```javascript
+// eslint.config.js
 import tgoPlugin from '@testgorilla/tgo-linting';
 
 export default [
-  {
-    plugins: {
-      tgo: tgoPlugin,
-    },
-    rules: {
-      'tgo/require-data-testid': 'warn',
-    },
-  },
+  tgoPlugin.configs.recommended,
+  // Your other configurations
 ];
 ```
 
-### Or use the recommended configuration:
+**Manual configuration:**
 
 ```javascript
+// eslint.config.js
 import tgoPlugin from '@testgorilla/tgo-linting';
 
 export default [
-  tgoPlugin.configs.recommended,
-  // Your other configurations
+  {
+    plugins: {
+      tgo: tgoPlugin,
+    },
+    rules: {
+      'tgo/require-data-testid': 'warn', // Example rule configuration
+    },
+  },
 ];
 ```
 
-## Rules
-
-### `tgo/require-data-testid`
-
-Ensures that specific HTML elements have a `data-testid` attribute for testing purposes.
-
-**Note:** This rule requires an ESLint setup that parses template ASTs (e.g., `@angular-eslint/template-parser` for Angular projects). It will not run against plain JS/TS ASTs.
-
-#### Default Elements
+### Legacy Config (ESLint 8.x and below)
 
-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`
+**Using the legacy preset:**
 
-#### Configuration
+```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,
+    },
+  ],
+};
+```
 
-You can customize which elements to check:
+**Manual configuration:**
 
 ```javascript
-{
-  rules: {
-    'tgo/require-data-testid': ['warn', {
-      tags: ['button', 'input', 'custom-element']
-    }]
-  }
-}
+// .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
+      },
+    },
+  ],
+};
 ```
 
-#### Examples
+## Important Notes
 
-❌ **Incorrect**
+- **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.
+- **Angular Projects:** If you're using `@angular-eslint`, the template parser is usually already configured for HTML files in your overrides.
 
-```html
-<button>Click me</button>
-<input type="text" />
-```
-
-✅ **Correct**
+## Rules
 
-```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,42 +1,40 @@
 {
   "name": "@testgorilla/tgo-linting",
-  "version": "1.0.0",
-  "description": "Linting rules and code quality standards for TestGorilla projects",
-  "keywords": [
-    "eslint",
-    "eslintplugin",
-    "eslint-plugin",
-    "testgorilla",
-    "angular",
-    "testing",
-    "linting",
-    "code-quality",
-    "accessibility"
-  ],
-  "author": "TestGorilla",
-  "license": "PROPRIETARY",
-  "main": "./src/index.js",
-  "types": "./src/index.d.ts",
-  "files": [
-    "**/*"
-  ],
-  "sideEffects": false,
-  "private": false,
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
+  "version": "1.0.2",
   "peerDependencies": {
+    "@angular-eslint/template-parser": ">= 17.0.0 < 20.0.0",
     "eslint": "^8 || ^9",
     "tslib": "^2.0.0"
   },
   "dependencies": {
     "@typescript-eslint/utils": "^8.54.0"
   },
+  "sideEffects": false,
+  "private": false,
+  "license": "PROPRIETARY",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "displayName": "TGO Linting",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/testgorilla/tgo-fe-libraries"
+  "description": "Linting rules and code quality standards for TestGorilla projects",
+  "author": "TestGorilla",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "require": "./src/index.js",
+      "types": "./src/index.d.ts"
+    },
+    "./legacy": {
+      "import": "./src/configs/legacy.js",
+      "require": "./src/configs/legacy.js",
+      "types": "./src/configs/legacy.d.ts"
+    }
   },
+  "files": [
+    "**/*"
+  ],
   "type": "commonjs"
 }

package/src/configs/legacy.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    plugins: string[];
+    rules: {
+        'tgo/require-data-testid': string;
+    };
+};
+export default _default;

package/src/configs/legacy.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    plugins: ['tgo'],
+    rules: {
+        'tgo/require-data-testid': 'warn',
+    },
+};
+//# sourceMappingURL=legacy.js.map

package/src/configs/legacy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy.js","sourceRoot":"","sources":["../../../../../packages/tgo-linting/src/configs/legacy.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,OAAO,EAAE,CAAC,KAAK,CAAC;IAChB,KAAK,EAAE;QACL,yBAAyB,EAAE,MAAM;KAClC;CACF,CAAA","sourcesContent":["export default {\n  plugins: ['tgo'],\n  rules: {\n    'tgo/require-data-testid': 'warn',\n  },\n}\n"]}

package/src/configs/recommended.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     plugins: ['tgo'],
     rules: {
-        'tgo/require-data-testid': 'error',
+        'tgo/require-data-testid': 'warn',
     },
 };
 //# sourceMappingURL=recommended.js.map

package/src/configs/recommended.js.map

@@ -1 +1 @@
-{"version":3,"file":"recommended.js","sourceRoot":"","sources":["../../../../../packages/tgo-linting/src/configs/recommended.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,OAAO,EAAE,CAAC,KAAK,CAAC;IAChB,KAAK,EAAE;QACL,yBAAyB,EAAE,OAAO;KACnC;CACF,CAAA","sourcesContent":["export default {\n  plugins: ['tgo'],\n  rules: {\n    'tgo/require-data-testid': 'error',\n  },\n}"]}
+{"version":3,"file":"recommended.js","sourceRoot":"","sources":["../../../../../packages/tgo-linting/src/configs/recommended.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,OAAO,EAAE,CAAC,KAAK,CAAC;IAChB,KAAK,EAAE;QACL,yBAAyB,EAAE,MAAM;KAClC;CACF,CAAA","sourcesContent":["export default {\n  plugins: ['tgo'],\n  rules: {\n    'tgo/require-data-testid': 'warn',\n  },\n}"]}

package/src/index.d.ts

@@ -1,4 +1,11 @@
-declare const _default: {
+import { rules } from './rules';
+import recommended from './configs/recommended';
+import legacy from './configs/legacy';
+declare const plugin: {
+    meta: {
+        name: string;
+        version: string;
+    };
     rules: {
         'require-data-testid': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"missingTestId", [{
             tags?: string[];
@@ -13,4 +20,5 @@ declare const _default: {
         };
     };
 };
-export = _default;
+export default plugin;
+export { rules, recommended, legacy };

package/src/index.js

@@ -1,10 +1,22 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.legacy = exports.recommended = exports.rules = void 0;
 const rules_1 = require("./rules");
+Object.defineProperty(exports, "rules", { enumerable: true, get: function () { return rules_1.rules; } });
 const recommended_1 = require("./configs/recommended");
-module.exports = {
+exports.recommended = recommended_1.default;
+const legacy_1 = require("./configs/legacy");
+exports.legacy = legacy_1.default;
+const plugin = {
+    meta: {
+        name: '@testgorilla/tgo-linting',
+        version: '1.0.0',
+    },
     rules: rules_1.rules,
     configs: {
         recommended: recommended_1.default,
     },
 };
+// Default export for ESM and CommonJS compatibility
+exports.default = plugin;
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/tgo-linting/src/index.ts"],"names":[],"mappings":";AAAA,mCAA+B;AAC/B,uDAA+C;AAE/C,iBAAS;IACP,KAAK,EAAL,aAAK;IACL,OAAO,EAAE;QACP,WAAW,EAAX,qBAAW;KACZ;CACF,CAAA","sourcesContent":["import { rules } from './rules'\nimport recommended from './configs/recommended'\n\nexport = {\n  rules,\n  configs: {\n    recommended,\n  },\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/tgo-linting/src/index.ts"],"names":[],"mappings":";;;AAAA,mCAA+B;AAmBtB,sFAnBA,aAAK,OAmBA;AAlBd,uDAA+C;AAkB/B,sBAlBT,qBAAW,CAkBS;AAjB3B,6CAAqC;AAiBR,iBAjBtB,gBAAM,CAiBsB;AAfnC,MAAM,MAAM,GAAG;IACb,IAAI,EAAE;QACJ,IAAI,EAAE,0BAA0B;QAChC,OAAO,EAAE,OAAO;KACjB;IACD,KAAK,EAAL,aAAK;IACL,OAAO,EAAE;QACP,WAAW,EAAX,qBAAW;KACZ;CACF,CAAA;AAED,oDAAoD;AACpD,kBAAe,MAAM,CAAA","sourcesContent":["import { rules } from './rules'\nimport recommended from './configs/recommended'\nimport legacy from './configs/legacy'\n\nconst plugin = {\n  meta: {\n    name: '@testgorilla/tgo-linting',\n    version: '1.0.0',\n  },\n  rules,\n  configs: {\n    recommended,\n  },\n}\n\n// Default export for ESM and CommonJS compatibility\nexport default plugin\n\n// Named exports for specific use cases\nexport { rules, recommended, legacy }\n"]}