@testgorilla/tgo-linting 1.0.0

package/Readme.md

@@ -0,0 +1,124 @@
+# @testgorilla/tgo-linting
+
+Linting rules and code quality standards for TestGorilla projects.
+
+## Installation
+
+```bash
+npm install @testgorilla/tgo-linting --save-dev
+```
+
+## Usage
+
+Add the plugin to your ESLint configuration:
+
+### Flat Config (ESLint 9+)
+
+```javascript
+import tgoPlugin from '@testgorilla/tgo-linting';
+
+export default [
+  {
+    plugins: {
+      tgo: tgoPlugin,
+    },
+    rules: {
+      'tgo/require-data-testid': 'warn',
+    },
+  },
+];
+```
+
+### Or use the recommended configuration:
+
+```javascript
+import tgoPlugin from '@testgorilla/tgo-linting';
+
+export default [
+  tgoPlugin.configs.recommended,
+  // Your other configurations
+];
+```
+
+## 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
+
+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" />
+```
+
+## Development
+
+### Building
+
+```bash
+nx build tgo-linting
+```
+
+### Testing
+
+```bash
+nx test tgo-linting
+```
+
+### Linting
+
+```bash
+nx lint tgo-linting
+```
+
+## License
+
+PROPRIETARY - © TestGorilla

package/package.json

@@ -0,0 +1,42 @@
+{
+  "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/"
+  },
+  "peerDependencies": {
+    "eslint": "^8 || ^9",
+    "tslib": "^2.0.0"
+  },
+  "dependencies": {
+    "@typescript-eslint/utils": "^8.54.0"
+  },
+  "displayName": "TGO Linting",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/testgorilla/tgo-fe-libraries"
+  },
+  "type": "commonjs"
+}

package/src/configs/recommended.d.ts

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

package/src/configs/recommended.js

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

package/src/configs/recommended.js.map

@@ -0,0 +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}"]}

package/src/index.d.ts

@@ -0,0 +1,16 @@
+declare const _default: {
+    rules: {
+        'require-data-testid': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"missingTestId", [{
+            tags?: string[];
+        }?], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+    };
+    configs: {
+        recommended: {
+            plugins: string[];
+            rules: {
+                'tgo/require-data-testid': string;
+            };
+        };
+    };
+};
+export = _default;

package/src/index.js

@@ -0,0 +1,10 @@
+"use strict";
+const rules_1 = require("./rules");
+const recommended_1 = require("./configs/recommended");
+module.exports = {
+    rules: rules_1.rules,
+    configs: {
+        recommended: recommended_1.default,
+    },
+};
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +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"]}

package/src/rules/index.d.ts

@@ -0,0 +1,5 @@
+export declare const rules: {
+    'require-data-testid': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"missingTestId", [{
+        tags?: string[];
+    }?], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+};

package/src/rules/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rules = void 0;
+const require_data_testid_1 = require("./require-data-testid");
+exports.rules = {
+    'require-data-testid': require_data_testid_1.default,
+};
+//# sourceMappingURL=index.js.map

package/src/rules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/tgo-linting/src/rules/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqD;AAExC,QAAA,KAAK,GAAG;IACnB,qBAAqB,EAAE,6BAAiB;CACzC,CAAA","sourcesContent":["import requireDataTestId from './require-data-testid'\n\nexport const rules = {\n  'require-data-testid': requireDataTestId,\n}"]}

package/src/rules/require-data-testid.d.ts

@@ -0,0 +1,9 @@
+import { TSESLint } from '@typescript-eslint/utils';
+type Options = [
+    {
+        tags?: string[];
+    }?
+];
+type MessageIds = 'missingTestId';
+declare const rule: TSESLint.RuleModule<MessageIds, Options>;
+export default rule;

package/src/rules/require-data-testid.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const DEFAULT_TAGS = [
+    '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',
+];
+const rule = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Ensures specific elements have data-testid attribute',
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    tags: {
+                        type: 'array',
+                        items: { type: 'string' },
+                        uniqueItems: true,
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            missingTestId: "<{{tag}}> must have 'data-testid' attribute",
+        },
+    },
+    create(context) {
+        var _a, _b;
+        const configuration = (_a = context.options[0]) !== null && _a !== void 0 ? _a : {};
+        const tagsToCheck = (_b = configuration.tags) !== null && _b !== void 0 ? _b : DEFAULT_TAGS;
+        return {
+            Element(node) {
+                var _a, _b, _c;
+                if (!tagsToCheck.includes(node.name)) {
+                    return;
+                }
+                const hasTestId = ((_a = node.attributes) === null || _a === void 0 ? void 0 : _a.some((attr) => attr.name === 'data-testid')) ||
+                    ((_b = node.inputs) === null || _b === void 0 ? void 0 : _b.some((attr) => attr.name === 'data-testid')) ||
+                    ((_c = node.inputs) === null || _c === void 0 ? void 0 : _c.some((attr) => attr.name === 'attr.data-testid'));
+                if (!hasTestId) {
+                    context.report({
+                        node: node,
+                        messageId: 'missingTestId',
+                        data: {
+                            tag: node.name,
+                        },
+                    });
+                }
+            },
+        };
+    },
+};
+exports.default = rule;
+//# sourceMappingURL=require-data-testid.js.map

package/src/rules/require-data-testid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-data-testid.js","sourceRoot":"","sources":["../../../../../packages/tgo-linting/src/rules/require-data-testid.ts"],"names":[],"mappings":";;AAUA,MAAM,YAAY,GAAG;IACnB,QAAQ;IACR,cAAc;IACd,OAAO;IACP,kBAAkB;IAClB,iBAAiB;IACjB,IAAI;IACJ,OAAO;IACP,cAAc;IACd,WAAW;IACX,KAAK;IACL,UAAU;IACV,WAAW;IACX,OAAO;IACP,gBAAgB;IAChB,4BAA4B;IAC5B,gBAAgB;IAChB,sBAAsB;IACtB,oBAAoB;IACpB,WAAW;CACZ,CAAA;AAED,MAAM,IAAI,GAA6C;IACrD,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EAAE,sDAAsD;SACpE;QACD,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE;wBACJ,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBACzB,WAAW,EAAE,IAAI;qBAClB;iBACF;gBACD,oBAAoB,EAAE,KAAK;aAC5B;SACF;QACD,QAAQ,EAAE;YACR,aAAa,EAAE,6CAA6C;SAC7D;KACF;IAED,MAAM,CAAC,OAAO;;QACZ,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAA;QAC9C,MAAM,WAAW,GAAG,MAAA,aAAa,CAAC,IAAI,mCAAI,YAAY,CAAA;QAEtD,OAAO;YACL,OAAO,CAAC,IAAiI;;gBACvI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrC,OAAM;gBACR,CAAC;gBAED,MAAM,SAAS,GACb,CAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC;qBAC5D,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAA;qBACxD,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAA,CAAA;gBAE/D,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,IAAgC;wBACtC,SAAS,EAAE,eAAe;wBAC1B,IAAI,EAAE;4BACJ,GAAG,EAAE,IAAI,CAAC,IAAI;yBACf;qBACF,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;SACF,CAAA;IACH,CAAC;CACF,CAAA;AAED,kBAAe,IAAI,CAAA","sourcesContent":["import { TSESLint, TSESTree } from '@typescript-eslint/utils'\n\ntype Options = [\n  {\n    tags?: string[]\n  }?\n]\n\ntype MessageIds = 'missingTestId'\n\nconst DEFAULT_TAGS = [\n  'button',\n  'mat-checkbox',\n  'input',\n  'mat-radio-button',\n  'mat-radio-group',\n  'h1',\n  'table',\n  'header-table',\n  'mat-table',\n  'img',\n  'textarea',\n  'ng-select',\n  'video',\n  'app-tgo-choice',\n  'testgorilla-confirm-dialog',\n  'mat-form-field',\n  'tgo-checkout-message',\n  'mat-dialog-actions',\n  'ui-button',\n]\n\nconst rule: TSESLint.RuleModule<MessageIds, Options> = {\n  meta: {\n    type: 'suggestion',\n    docs: {\n      description: 'Ensures specific elements have data-testid attribute',\n    },\n    schema: [\n      {\n        type: 'object',\n        properties: {\n          tags: {\n            type: 'array',\n            items: { type: 'string' },\n            uniqueItems: true,\n          },\n        },\n        additionalProperties: false,\n      },\n    ],\n    messages: {\n      missingTestId: \"<{{tag}}> must have 'data-testid' attribute\",\n    },\n  },\n\n  create(context) {\n    const configuration = context.options[0] ?? {}\n    const tagsToCheck = configuration.tags ?? DEFAULT_TAGS\n\n    return {\n      Element(node: TSESLint.RuleListener['Element'] & { name: string; attributes?: Array<{ name: string }>; inputs?: Array<{ name: string }> }) {\n        if (!tagsToCheck.includes(node.name)) {\n          return\n        }\n\n        const hasTestId =\n          node.attributes?.some((attr) => attr.name === 'data-testid') ||\n          node.inputs?.some((attr) => attr.name === 'data-testid') ||\n          node.inputs?.some((attr) => attr.name === 'attr.data-testid')\n\n        if (!hasTestId) {\n          context.report({\n            node: node as unknown as TSESTree.Node,\n            messageId: 'missingTestId',\n            data: {\n              tag: node.name,\n            },\n          })\n        }\n      },\n    }\n  },\n}\n\nexport default rule\n"]}