max-locator-sniffer 1.0.0

package/README.md

@@ -0,0 +1,62 @@
+# Max Locator Sniffer
+
+<img src="./images/max.webp" alt="Max the Locator Sniffer" width="160" />
+
+**Max Locator Sniffer** is a playful but powerful CLI tool that scans your Playwright test code and **sniffs out duplicate locators**.  
+
+Duplicate locators can lead to **brittle, flaky tests**. Max helps you catch them early by showing:
+
+- Which locators are duplicated
+- Where they appear
+- How often they are reused
+- A clear severity signal so you know what to fix first
+
+---
+
+## ✨ Features
+
+- 🔍 Finds **duplicate Playwright locators**
+- 📁 Shows **every file location**
+- 🔢 Displays **usage counts**
+- ⚠️ Highlights **HIGH / MEDIUM / LOW severity**
+- 🖥 Beautiful CLI table output
+- ⚡ Fast scans using glob
+
+---
+
+## 📦 Installation
+
+```bash
+npm install -g max-locator-sniffer
+```
+
+## 🚀 Usage
+
+Scan a folder and all of its contents:
+
+```bash
+max sniff src
+```
+
+## Example Output
+
+<img src="./images/max_example_terminal.png" alt="Terminal window running the app"/>
+
+
+## Roadmap
+- Flaky locator scoring system
+- CSS complexity analysis
+- JSON output mode
+- CI mode (--fail-on high)
+- HTML report output
+- Flaky locator scoring system
+- CSS complexity analysis
+- JSON output mode
+- CI mode (--fail-on high)
+
+## Why "Max"?
+Inspired by Max the dog from The Grinch, this CLI tool loyally sniffs through your repo, hunting down flaky, duplicated locators so your test suite stays healthy and happy.
+
+MIT © Ian Bridges
+
+---

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+// load using import
+import { Command } from 'commander';
+import { glob } from 'glob';
+import color from 'colors';
+import { tableConfig } from './table/config.js';
+import { buildTable, displayTable } from './table/tableBuilder.js';
+const program = new Command();
+program
+    .name('max')
+    .description('🐶 Sniffs out duplicate Playwright locators')
+    .version('1.0.0');
+program
+    .command('sniff')
+    .description('Scan files for duplicate Playwright locators')
+    .argument('<pattern>', 'Glob pattern to scan')
+    .action(async (pattern) => {
+    const filePaths = await glob(`${pattern}/**/*.{js,ts}`, {
+        ignore: 'node_modules/**',
+    });
+    const duplicateLocatorTable = buildTable(filePaths);
+    await displayTable(duplicateLocatorTable, tableConfig);
+});
+program.parse(process.argv);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,oBAAoB;AACpB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,KAAK,MAAM,QAAQ,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEnE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,KAAK,CAAC;KACX,WAAW,CAAC,6CAA6C,CAAC;KAC1D,OAAO,CAAC,OAAO,CAAC,CAAC;AAGpB,OAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,8CAA8C,CAAC;KAC3D,QAAQ,CACP,WAAW,EACX,sBAAsB,CACvB;KACA,MAAM,CAAC,KAAK,EAAE,OAAe,EAAE,EAAE;IAChC,MAAM,SAAS,GAAa,MAAM,IAAI,CAAC,GAAG,OAAO,eAAe,EAAE;QAChE,MAAM,EAAE,iBAAiB;KAC1B,CAAC,CAAC;IAEH,MAAM,qBAAqB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;IAEpD,MAAM,YAAY,CAAC,qBAAqB,EAAE,WAAW,CAAC,CAAC;AACzD,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/locator_examples/playwright_duplicate_locators_five.d.ts

@@ -0,0 +1,7 @@
+import { type Locator, type Page } from '@playwright/test';
+export declare class PlaywrightDevPage {
+    readonly page: Page;
+    readonly getStartedLink: Locator;
+    constructor(page: Page);
+}
+//# sourceMappingURL=playwright_duplicate_locators_five.d.ts.map

package/dist/locator_examples/playwright_duplicate_locators_five.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_five.d.ts","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_five.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAEnE,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;gBAErB,IAAI,EAAE,IAAI;CAqBvB"}

package/dist/locator_examples/playwright_duplicate_locators_five.js

@@ -0,0 +1,27 @@
+import { expect } from '@playwright/test';
+export class PlaywrightDevPage {
+    page;
+    getStartedLink;
+    constructor(page) {
+        this.page = page;
+        this.getStartedLink = page.locator('#bob .bob > bob bob ~bob +bob');
+        this.getStartedLink = page.locator('a', { hasText: 'Get started..' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started...' });
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+        this.getStartedLink = page.getByLabel('a');
+    }
+}
+//# sourceMappingURL=playwright_duplicate_locators_five.js.map

package/dist/locator_examples/playwright_duplicate_locators_five.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_five.js","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_five.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA2B,MAAM,kBAAkB,CAAC;AAEnE,MAAM,OAAO,iBAAiB;IACnB,IAAI,CAAO;IACX,cAAc,CAAU;IAEjC,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;CACF"}

package/dist/locator_examples/playwright_duplicate_locators_four.d.ts

@@ -0,0 +1,7 @@
+import { type Locator, type Page } from '@playwright/test';
+export declare class PlaywrightDevPage {
+    readonly page: Page;
+    getStartedLink: Locator;
+    constructor(page: Page);
+}
+//# sourceMappingURL=playwright_duplicate_locators_four.d.ts.map

package/dist/locator_examples/playwright_duplicate_locators_four.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_four.d.ts","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_four.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAEnE,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;gBAGZ,IAAI,EAAE,IAAI;CAYvB"}

package/dist/locator_examples/playwright_duplicate_locators_four.js

@@ -0,0 +1,18 @@
+import { expect } from '@playwright/test';
+export class PlaywrightDevPage {
+    page;
+    getStartedLink;
+    constructor(page) {
+        this.page = page;
+        this.getStartedLink = page.locator('a', { hasText: 'bob' });
+        this.getStartedLink = page.locator('a', { hasText: 'bob' });
+        this.getStartedLink = page.locator('a', { hasText: 'bob' });
+        this.getStartedLink = page.locator('a', { hasText: 'bob' });
+        this.getStartedLink = page.locator('a', { hasText: 'bob' });
+        this.getStartedLink = page.locator('a', { hasText: 'bob' });
+        this.getStartedLink = page.locator('a', { hasText: 'bob' });
+        this.getStartedLink = page.locator('a', { hasText: 'bob' });
+        this.getStartedLink = page.locator('a', { hasText: 'bob' });
+    }
+}
+//# sourceMappingURL=playwright_duplicate_locators_four.js.map

package/dist/locator_examples/playwright_duplicate_locators_four.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_four.js","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_four.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA2B,MAAM,kBAAkB,CAAC;AAEnE,MAAM,OAAO,iBAAiB;IACnB,IAAI,CAAO;IACpB,cAAc,CAAU;IAGxB,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF"}

package/dist/locator_examples/playwright_duplicate_locators_one.d.ts

@@ -0,0 +1,8 @@
+import { type Locator, type Page } from '@playwright/test';
+export declare class PlaywrightDevPage {
+    readonly page: Page;
+    getStartedLink: Locator;
+    bob: Locator;
+    constructor(page: Page);
+}
+//# sourceMappingURL=playwright_duplicate_locators_one.d.ts.map

package/dist/locator_examples/playwright_duplicate_locators_one.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_one.d.ts","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_one.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAEnE,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,GAAG,EAAE,OAAO,CAAC;gBAGD,IAAI,EAAE,IAAI;CAWvB"}

package/dist/locator_examples/playwright_duplicate_locators_one.js

@@ -0,0 +1,18 @@
+import { expect } from '@playwright/test';
+export class PlaywrightDevPage {
+    page;
+    getStartedLink;
+    bob;
+    constructor(page) {
+        this.page = page;
+        this.bob = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+    }
+}
+//# sourceMappingURL=playwright_duplicate_locators_one.js.map

package/dist/locator_examples/playwright_duplicate_locators_one.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_one.js","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_one.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA2B,MAAM,kBAAkB,CAAC;AAEnE,MAAM,OAAO,iBAAiB;IACnB,IAAI,CAAO;IACpB,cAAc,CAAU;IACxB,GAAG,CAAU;IAGb,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/dist/locator_examples/playwright_duplicate_locators_seven.d.ts

@@ -0,0 +1,7 @@
+import { type Locator, type Page } from '@playwright/test';
+export declare class PlaywrightDevPage {
+    readonly page: Page;
+    readonly getStartedLink: Locator;
+    constructor(page: Page);
+}
+//# sourceMappingURL=playwright_duplicate_locators_seven.d.ts.map

package/dist/locator_examples/playwright_duplicate_locators_seven.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_seven.d.ts","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_seven.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAEnE,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;gBAErB,IAAI,EAAE,IAAI;CAMvB"}

package/dist/locator_examples/playwright_duplicate_locators_seven.js

@@ -0,0 +1,12 @@
+import { expect } from '@playwright/test';
+export class PlaywrightDevPage {
+    page;
+    getStartedLink;
+    constructor(page) {
+        this.page = page;
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+    }
+}
+//# sourceMappingURL=playwright_duplicate_locators_seven.js.map

package/dist/locator_examples/playwright_duplicate_locators_seven.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_seven.js","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_seven.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA2B,MAAM,kBAAkB,CAAC;AAEnE,MAAM,OAAO,iBAAiB;IACnB,IAAI,CAAO;IACX,cAAc,CAAU;IAEjC,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}

package/dist/locator_examples/playwright_duplicate_locators_six.d.ts

@@ -0,0 +1,7 @@
+import { type Locator, type Page } from '@playwright/test';
+export declare class PlaywrightDevPage {
+    readonly page: Page;
+    readonly getStartedLink: Locator;
+    constructor(page: Page);
+}
+//# sourceMappingURL=playwright_duplicate_locators_six.d.ts.map

package/dist/locator_examples/playwright_duplicate_locators_six.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_six.d.ts","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_six.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAEnE,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;gBAErB,IAAI,EAAE,IAAI;CAOvB"}

package/dist/locator_examples/playwright_duplicate_locators_six.js

@@ -0,0 +1,13 @@
+import { expect } from '@playwright/test';
+export class PlaywrightDevPage {
+    page;
+    getStartedLink;
+    constructor(page) {
+        this.page = page;
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('b', { hasText: 'Get started' });
+    }
+}
+//# sourceMappingURL=playwright_duplicate_locators_six.js.map

package/dist/locator_examples/playwright_duplicate_locators_six.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_six.js","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_six.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA2B,MAAM,kBAAkB,CAAC;AAEnE,MAAM,OAAO,iBAAiB;IACnB,IAAI,CAAO;IACX,cAAc,CAAU;IAEjC,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}

package/dist/locator_examples/playwright_duplicate_locators_three.d.ts

@@ -0,0 +1,7 @@
+import { type Locator, type Page } from '@playwright/test';
+export declare class PlaywrightDevPage {
+    readonly page: Page;
+    getStartedLink: Locator;
+    constructor(page: Page);
+}
+//# sourceMappingURL=playwright_duplicate_locators_three.d.ts.map

package/dist/locator_examples/playwright_duplicate_locators_three.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_three.d.ts","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_three.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAEnE,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;gBAGZ,IAAI,EAAE,IAAI;CAiBvB"}

package/dist/locator_examples/playwright_duplicate_locators_three.js

@@ -0,0 +1,23 @@
+import { expect } from '@playwright/test';
+export class PlaywrightDevPage {
+    page;
+    getStartedLink;
+    constructor(page) {
+        this.page = page;
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+        this.getStartedLink = page.locator('a', { hasText: 'Now Get started' });
+    }
+}
+//# sourceMappingURL=playwright_duplicate_locators_three.js.map

package/dist/locator_examples/playwright_duplicate_locators_three.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_three.js","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_three.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA2B,MAAM,kBAAkB,CAAC;AAEnE,MAAM,OAAO,iBAAiB;IACnB,IAAI,CAAO;IACpB,cAAc,CAAU;IAGxB,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/dist/locator_examples/playwright_duplicate_locators_two.d.ts

@@ -0,0 +1,6 @@
+import { type Page } from '@playwright/test';
+export declare class PlaywrightDevPage {
+    readonly page: Page;
+    constructor(page: Page);
+}
+//# sourceMappingURL=playwright_duplicate_locators_two.d.ts.map

package/dist/locator_examples/playwright_duplicate_locators_two.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_two.d.ts","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_two.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAEnE,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;gBAGR,IAAI,EAAE,IAAI;CAGvB"}

package/dist/locator_examples/playwright_duplicate_locators_two.js

@@ -0,0 +1,9 @@
+import { expect } from '@playwright/test';
+export class PlaywrightDevPage {
+    page;
+    // readonly getStartedLink: Locator;
+    constructor(page) {
+        this.page = page;
+    }
+}
+//# sourceMappingURL=playwright_duplicate_locators_two.js.map

package/dist/locator_examples/playwright_duplicate_locators_two.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright_duplicate_locators_two.js","sourceRoot":"","sources":["../../src/locator_examples/playwright_duplicate_locators_two.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA2B,MAAM,kBAAkB,CAAC;AAEnE,MAAM,OAAO,iBAAiB;IACnB,IAAI,CAAO;IACpB,oCAAoC;IAEpC,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}

package/dist/table/config.d.ts

@@ -0,0 +1,3 @@
+import { type TableUserConfig } from 'table';
+export declare const tableConfig: TableUserConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/table/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/table/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,eAAe,EAAE,MAAM,OAAO,CAAC;AAGzE,eAAO,MAAM,WAAW,EAAE,eAczB,CAAC"}

package/dist/table/config.js

@@ -0,0 +1,18 @@
+import { table, getBorderCharacters } from 'table';
+// table config
+export const tableConfig = {
+    border: getBorderCharacters('honeywell'),
+    columns: [
+        { alignment: 'center' }, // #
+        { alignment: 'left' }, // Locator
+        { alignment: 'right' }, // Total
+        { alignment: 'center' }, // Status
+        { alignment: 'left' }, // FilePath
+        { alignment: 'right' } // Count
+    ],
+    header: {
+        content: '🐶🦴 Max Sniffed Out Duplicate Locators'.cyan,
+        alignment: 'center'
+    }
+};
+//# sourceMappingURL=config.js.map

package/dist/table/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/table/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAwB,MAAM,OAAO,CAAC;AAEzE,eAAe;AACf,MAAM,CAAC,MAAM,WAAW,GAAoB;IACxC,MAAM,EAAE,mBAAmB,CAAC,WAAW,CAAC;IACxC,OAAO,EAAE;QACL,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAI,IAAI;QAC/B,EAAE,SAAS,EAAE,MAAM,EAAE,EAAG,UAAU;QAClC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAI,QAAQ;QAClC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAG,SAAS;QACnC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAG,WAAW;QACnC,EAAE,SAAS,EAAE,OAAO,EAAE,CAAI,QAAQ;KACrC;IACD,MAAM,EAAE;QACJ,OAAO,EAAE,yCAAyC,CAAC,IAAI;QACvD,SAAS,EAAE,QAAQ;KACtB;CACJ,CAAC"}

package/dist/table/regexs.d.ts

@@ -0,0 +1,5 @@
+export declare const regexs: {
+    getLocator: RegExp;
+    getLocatorPrefix: RegExp;
+};
+//# sourceMappingURL=regexs.d.ts.map

package/dist/table/regexs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regexs.d.ts","sourceRoot":"","sources":["../../src/table/regexs.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;CAGlB,CAAA"}

package/dist/table/regexs.js

@@ -0,0 +1,5 @@
+export const regexs = {
+    getLocator: /page\.(locator|getBy|frameLocator)[\w\s*]*.*?\)/gs,
+    getLocatorPrefix: /page.(locator|getBy|frameLocator)/
+};
+//# sourceMappingURL=regexs.js.map

package/dist/table/regexs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"regexs.js","sourceRoot":"","sources":["../../src/table/regexs.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,MAAM,GAAG;IAClB,UAAU,EAAE,mDAAmD;IAC/D,gBAAgB,EAAE,mCAAmC;CACxD,CAAA"}

package/dist/table/tableBuilder.d.ts

@@ -0,0 +1,4 @@
+import { type TableUserConfig } from 'table';
+export declare const displayTable: (duplicateLocatorTable: (string | number)[][], config: TableUserConfig) => Promise<void>;
+export declare const buildTable: (filePaths: string[]) => (string | number)[][];
+//# sourceMappingURL=tableBuilder.d.ts.map

package/dist/table/tableBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableBuilder.d.ts","sourceRoot":"","sources":["../../src/table/tableBuilder.ts"],"names":[],"mappings":"AAGA,OAAO,EAAS,KAAK,eAAe,EAAE,MAAM,OAAO,CAAC;AAoCpD,eAAO,MAAM,YAAY,GAAU,uBAAuB,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,eAAe,kBAOvG,CAAA;AA2FD,eAAO,MAAM,UAAU,GAAI,WAAW,MAAM,EAAE,0BAqB7C,CAAA"}

package/dist/table/tableBuilder.js

@@ -0,0 +1,119 @@
+import figlet from 'figlet';
+import color from 'colors';
+import * as fs from 'fs';
+import { table } from 'table';
+import { regexs } from './regexs.js';
+import { locatorStatus } from './utils.js';
+// turn on colors for console
+color.enable();
+const consoleHeadings = async () => {
+    // display heading for the search - max of tool and info
+    const heading = await figlet.text('MAX', { font: 'Larry 3D' });
+    console.log(heading.green.bold);
+    console.log('PLAYWRIGHT LOCATOR FINDER'
+        .green.bold);
+    console.log('────────────────────────────────────────────────────────────────────────────────'
+        .grey);
+    console.log('🐶  Max scans your codebase for duplicate Playwright locators\n' +
+        '    and flags their locations.'
+            .white);
+    console.log('────────────────────────────────────────────────────────────────────────────────\n'
+        .grey);
+};
+// display the table showing the contents of the script, along with the duplicate locators in the table
+export const displayTable = async (duplicateLocatorTable, config) => {
+    // headings displayed beforing table
+    await consoleHeadings();
+    // display the final table detailing the duplicate locators
+    console.log(table(duplicateLocatorTable, config));
+};
+const listOfDuplicateLocators = (filePaths) => {
+    const locators = new Set();
+    const storeDuplicateLocators = new Map();
+    // read the files find the duplicates, filepath and number of times they appear
+    for (const filePath of filePaths) {
+        try {
+            const readFile = fs.readFileSync(filePath, { encoding: 'utf-8' });
+            const matches = readFile.match(regexs.getLocator) ?? [];
+            // search the matches store the unqie locators and the duplicates
+            for (const locator of matches) {
+                // always add into the all locators set 
+                locators.add(locator);
+                const getDuplicateLocator = storeDuplicateLocators.get(locator);
+                // create new object here as the duplicate locator isn't here yet
+                if (!storeDuplicateLocators.get(locator)) {
+                    storeDuplicateLocators.set(locator, {
+                        files: new Map([[filePath, 1]])
+                    });
+                    // update the object as it exists
+                }
+                else {
+                    // set the total number of locators in a file path
+                    getDuplicateLocator?.files.set(filePath, (storeDuplicateLocators.get(locator)?.files.get(filePath) ?? 0) + 1);
+                }
+            }
+        }
+        catch (err) {
+            console.log(`Error reading file - ${err}`);
+        }
+    }
+    return storeDuplicateLocators;
+};
+const countLocatorsSeenAcrossFiles = (duplicateLocators) => {
+    let index = 0;
+    const tableRows = [];
+    // gets the total times a locator appears across all files
+    for (const [locator, files] of duplicateLocators) {
+        index++;
+        // get the total count for each locator across all files
+        const runningCount = [...files.files.values()].reduce((acc, val) => acc + val, 0);
+        // want to calculate the status based on the running count
+        const status = locatorStatus(runningCount);
+        // get the file paths for each of the locators
+        const filePaths = [...files.files.entries()].map((file) => `${file[0]}`).join('\n');
+        const fileCount = [...files.files.entries()].map((count) => `${count[1]}`).join('\n');
+        // only push into the table if the total number of locators is more than one
+        if (runningCount > 1) {
+            tableRows.push([index, locator.replace(regexs.getLocatorPrefix, ''), runningCount, status, filePaths, fileCount]);
+        }
+    }
+    return tableRows;
+};
+const orderTableByHighestStatus = (tableRows) => {
+    // order to show the highest status at the top of the table - will help to show the highest duplicates
+    const orderByTotalCount = tableRows.sort((first, second) => second[2] - first[2]);
+    // reorder the table numbers - sorting will change this
+    // now reorder the # numbering
+    const reorderedTable = orderByTotalCount.map((row, index) => {
+        return [
+            index + 1,
+            row[1],
+            row[2],
+            row[3],
+            row[4],
+            row[5]
+        ];
+    });
+    return reorderedTable;
+};
+export const buildTable = (filePaths) => {
+    const tableHeaders = ['#', 'Locator', 'Total', 'Status', 'FilePath', 'Count'];
+    // get the duplicate locators
+    const storeDuplicateLocators = listOfDuplicateLocators(filePaths);
+    // get the duplicate locators seen across a file
+    const locatorCountAcrossFiles = countLocatorsSeenAcrossFiles(storeDuplicateLocators);
+    // order the table by the highest status
+    const orderTable = orderTableByHighestStatus(locatorCountAcrossFiles);
+    if (orderTable.length < 1) {
+        console.log();
+        console.log('🐶 Max sniffed everywhere... no duplicate locators found!'.green.bold);
+        console.log('✨ Your selectors are clean, tidy, and robust. Good human.\n'.dim);
+        process.exit(0);
+    }
+    else {
+        // return the final table to be displayed in the console
+        const finalTable = [tableHeaders, ...orderTable];
+        return finalTable;
+    }
+};
+//# sourceMappingURL=tableBuilder.js.map

package/dist/table/tableBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableBuilder.js","sourceRoot":"","sources":["../../src/table/tableBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,KAAK,MAAM,QAAQ,CAAC;AAC3B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,KAAK,EAAwB,MAAM,OAAO,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,6BAA6B;AAC7B,KAAK,CAAC,MAAM,EAAE,CAAC;AAEf,MAAM,eAAe,GAAG,KAAK,IAAI,EAAE;IAC/B,wDAAwD;IACxD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;IAC/D,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEhC,OAAO,CAAC,GAAG,CACP,2BAA2B;SACtB,KAAK,CAAC,IAAI,CAClB,CAAC;IAEF,OAAO,CAAC,GAAG,CACP,kFAAkF;SAC7E,IAAI,CACZ,CAAC;IAEF,OAAO,CAAC,GAAG,CACP,iEAAiE;QACjE,gCAAgC;aAC3B,KAAK,CACb,CAAC;IAEF,OAAO,CAAC,GAAG,CACP,oFAAoF;SAC/E,IAAI,CACZ,CAAC;AAEN,CAAC,CAAA;AACD,uGAAuG;AACvG,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,qBAA4C,EAAE,MAAuB,EAAE,EAAE;IAExG,oCAAoC;IACpC,MAAM,eAAe,EAAE,CAAC;IAExB,2DAA2D;IAC3D,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC,CAAC;AACtD,CAAC,CAAA;AAED,MAAM,uBAAuB,GAAG,CAAC,SAAmB,EAA8B,EAAE;IAChF,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAW,CAAC;IACpC,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAyB,CAAC;IAEhE,+EAA+E;IAC/E,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QAC/B,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;YAClE,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YAExD,iEAAiE;YACjE,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;gBAE5B,wCAAwC;gBACxC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAEtB,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAEhE,iEAAiE;gBACjE,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;oBACvC,sBAAsB,CAAC,GAAG,CAAC,OAAO,EAAE;wBAChC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;qBAClC,CAAC,CAAC;oBAEH,iCAAiC;gBACrC,CAAC;qBAAM,CAAC;oBACJ,kDAAkD;oBAClD,mBAAmB,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBAElH,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,GAAG,EAAE,CAAC;YACT,OAAO,CAAC,GAAG,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAC;QAC/C,CAAC;IAEL,CAAC;IACD,OAAO,sBAAsB,CAAC;AAClC,CAAC,CAAA;AAED,MAAM,4BAA4B,GAAG,CAAC,iBAA6C,EAAe,EAAE;IAChG,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,SAAS,GAAgB,EAAE,CAAC;IAElC,0DAA0D;IAC1D,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,iBAAiB,EAAE,CAAC;QAE/C,KAAK,EAAE,CAAC;QACR,wDAAwD;QACxD,MAAM,YAAY,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAC/D,GAAG,GAAG,GAAG,EAAE,CAAC,CACf,CAAC;QAEF,0DAA0D;QAC1D,MAAM,MAAM,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;QAE3C,8CAA8C;QAC9C,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEpF,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEtF,4EAA4E;QAC5E,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YACnB,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;QACtH,CAAC;IAEL,CAAC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC,CAAA;AAED,MAAM,yBAAyB,GAAG,CAAC,SAAsB,EAAe,EAAE;IACtE,sGAAsG;IACtG,MAAM,iBAAiB,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,KAAU,EAAE,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5F,uDAAuD;IACvD,8BAA8B;IAC9B,MAAM,cAAc,GAAgB,iBAAiB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QACrE,OAAO;YACH,KAAK,GAAG,CAAC;YACT,GAAG,CAAC,CAAC,CAAC;YACN,GAAG,CAAC,CAAC,CAAC;YACN,GAAG,CAAC,CAAC,CAAC;YACN,GAAG,CAAC,CAAC,CAAC;YACN,GAAG,CAAC,CAAC,CAAC;SACT,CAAA;IACL,CAAC,CAAC,CAAA;IACF,OAAO,cAAc,CAAC;AAC1B,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,SAAmB,EAAE,EAAE;IAC9C,MAAM,YAAY,GAAa,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAExF,6BAA6B;IAC7B,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,SAAS,CAAC,CAAC;IAClE,gDAAgD;IAChD,MAAM,uBAAuB,GAAG,4BAA4B,CAAC,sBAAsB,CAAC,CAAC;IAErF,wCAAwC;IACxC,MAAM,UAAU,GAAG,yBAAyB,CAAC,uBAAuB,CAAC,CAAC;IAEtE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,OAAO,CAAC,GAAG,CAAC,2DAA2D,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpF,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,GAAG,CAAC,CAAC;QAC/E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;SAAM,CAAC;QACJ,wDAAwD;QACxD,MAAM,UAAU,GAA0B,CAAC,YAAY,EAAE,GAAG,UAAU,CAAC,CAAC;QACxE,OAAO,UAAU,CAAC;IACtB,CAAC;AACL,CAAC,CAAA"}

package/dist/table/types.d.ts

@@ -0,0 +1,8 @@
+export type TableRows = [index: number, locator: string, total: number, status: string, filePath: string, count: string];
+export type locator = string;
+export type filePath = string;
+export type count = number;
+export type LocatorFiles = {
+    files: Map<filePath, count>;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/table/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/table/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACzH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC;AAG3B,MAAM,MAAM,YAAY,GAAG;IAAE,KAAK,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;CAAE,CAAC"}

package/dist/table/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/table/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/table/types.ts"],"names":[],"mappings":""}

package/dist/table/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const locatorStatus: (count: number) => string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/table/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/table/utils.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,WAM1C,CAAA"}

package/dist/table/utils.js

@@ -0,0 +1,18 @@
+import color from 'colors';
+// turn on colors for console
+color.enable();
+// determind the status of the locator found
+// rules:
+// > 10 = HIGH
+// > 5 = MEDIUM
+// else = LOW
+export const locatorStatus = (count) => {
+    if (count > 10)
+        return 'HIGH'.red;
+    if (count > 4)
+        return 'MEDIUM'.yellow;
+    else {
+        return 'LOW'.grey;
+    }
+};
+//# sourceMappingURL=utils.js.map

package/dist/table/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/table/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,QAAQ,CAAC;AAG3B,6BAA6B;AAC7B,KAAK,CAAC,MAAM,EAAE,CAAC;AAEf,4CAA4C;AAC5C,SAAS;AACT,cAAc;AACd,eAAe;AACf,aAAa;AACb,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAa,EAAE,EAAE;IAC3C,IAAI,KAAK,GAAG,EAAE;QAAE,OAAO,MAAM,CAAC,GAAG,CAAC;IAClC,IAAI,KAAK,GAAG,CAAC;QAAE,OAAO,QAAQ,CAAC,MAAM,CAAC;SACjC,CAAC;QACF,OAAO,KAAK,CAAC,IAAI,CAAC;IACtB,CAAC;AACL,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "max-locator-sniffer",
+  "version": "1.0.0",
+  "description": "a tool to audit playwright locators in a repo, Max finds duplicate locators.",
+  "license": "MIT",
+  "author": "Ian Bridges",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "max": "./dist/index.js"
+  },
+  "scripts": {
+    "dev": "tsx src/index.ts",
+    "build": "tsc",
+    "test": "tsx src/index.ts"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.57.0",
+    "@types/node": "^25.0.6",
+    "colors": "^1.4.0",
+    "commander": "^14.0.2",
+    "figlet": "^1.9.4",
+    "glob": "^13.0.0",
+    "i": "^0.3.7",
+    "npm": "^11.7.0",
+    "table": "^6.9.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+// load using import
+import { Command } from 'commander';
+import { glob } from 'glob';
+import color from 'colors';
+import { tableConfig } from './table/config.js';
+import { buildTable, displayTable } from './table/tableBuilder.js';
+
+const program = new Command();
+
+program
+  .name('max')
+  .description('🐶 Sniffs out duplicate Playwright locators')
+  .version('1.0.0');
+
+
+program
+  .command('sniff')
+  .description('Scan files for duplicate Playwright locators')
+  .argument(
+    '<pattern>',
+    'Glob pattern to scan'
+  )
+  .action(async (pattern: string) => {
+    const filePaths: string[] = await glob(`${pattern}/**/*.{js,ts}`, {
+      ignore: 'node_modules/**',
+    });
+
+    const duplicateLocatorTable = buildTable(filePaths);
+
+    await displayTable(duplicateLocatorTable, tableConfig);
+  });
+
+program.parse(process.argv);

package/src/locator_examples/playwright_duplicate_locators_one.ts

@@ -0,0 +1,26 @@
+import { expect, type Locator, type Page } from '@playwright/test';
+
+export class HomePage {
+  readonly page: Page;
+  getStarted: Locator;
+  loginBtn: Locator;
+
+  constructor(page: Page) {
+    this.page = page;
+
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+
+    this.loginBtn = page.locator('button.login');
+    this.loginBtn = page.locator('button.login');
+  }
+
+  async goto() {
+    await this.page.goto('/');
+  }
+
+  async start() {
+    await this.getStarted.click();
+  }
+}

package/src/locator_examples/playwright_duplicate_locators_three.ts

@@ -0,0 +1,25 @@
+import { type Locator, type Page } from '@playwright/test';
+
+export class SettingsPage {
+  readonly page: Page;
+  getStarted: Locator;
+  nowGetStarted: Locator;
+  saveBtn: Locator;
+
+  constructor(page: Page) {
+    this.page = page;
+
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+
+    this.nowGetStarted = page.locator('a', { hasText: 'Now Get started' });
+    this.nowGetStarted = page.locator('a', { hasText: 'Now Get started' });
+    this.nowGetStarted = page.locator('a', { hasText: 'Now Get started' });
+    this.nowGetStarted = page.locator('a', { hasText: 'Now Get started' });
+    this.nowGetStarted = page.locator('a', { hasText: 'Now Get started' });
+
+    this.saveBtn = page.locator('button[type="submit"]');
+  }
+}

package/src/locator_examples/playwright_duplicate_locators_two.ts

@@ -0,0 +1,23 @@
+import { type Locator, type Page } from '@playwright/test';
+
+export class DashboardPage {
+  readonly page: Page;
+  getStarted: Locator;
+  profileLink: Locator;
+  card: Locator;
+
+  constructor(page: Page) {
+    this.page = page;
+
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+    this.getStarted = page.locator('a', { hasText: 'Get started' });
+
+    this.profileLink = page.locator('a', { hasText: 'Profile' });
+    this.profileLink = page.locator('a', { hasText: 'Profile' });
+
+    this.card = page.locator('div.card.active > span.label');
+    this.card = page.locator('div.card.active > span.label');
+  }
+}

package/src/table/config.ts

@@ -0,0 +1,18 @@
+import { table, getBorderCharacters, type TableUserConfig } from 'table';
+
+// table config
+export const tableConfig: TableUserConfig = {
+    border: getBorderCharacters('honeywell'),
+    columns: [
+        { alignment: 'center' },   // #
+        { alignment: 'left' },  // Locator
+        { alignment: 'right' },   // Total
+        { alignment: 'center' },  // Status
+        { alignment: 'left' },  // FilePath
+        { alignment: 'right' }    // Count
+    ],
+    header: {
+        content: '🐶🦴 Max Sniffed Out Duplicate Locators'.cyan,
+        alignment: 'center'
+    }
+};

package/src/table/regexs.ts

@@ -0,0 +1,4 @@
+export const regexs = {
+    getLocator: /page\.(locator|getBy|frameLocator)[\w\s*]*.*?\)/gs,
+    getLocatorPrefix: /page.(locator|getBy|frameLocator)/
+}

package/src/table/tableBuilder.ts

@@ -0,0 +1,159 @@
+import figlet from 'figlet';
+import color from 'colors';
+import * as fs from 'fs';
+import { table, type TableUserConfig } from 'table';
+import { regexs } from './regexs.js';
+import type { locator, LocatorFiles, TableRows } from './types.js';
+import { locatorStatus } from './utils.js';
+
+// turn on colors for console
+color.enable();
+
+const consoleHeadings = async () => {
+    // display heading for the search - max of tool and info
+    const heading = await figlet.text('MAX', { font: 'Larry 3D' });
+    console.log(heading.green.bold);
+
+    console.log(
+        'PLAYWRIGHT LOCATOR FINDER'
+            .green.bold
+    );
+
+    console.log(
+        '────────────────────────────────────────────────────────────────────────────────'
+            .grey
+    );
+
+    console.log(
+        '🐶  Max scans your codebase for duplicate Playwright locators\n' +
+        '    and flags their locations.'
+            .white
+    );
+
+    console.log(
+        '────────────────────────────────────────────────────────────────────────────────\n'
+            .grey
+    );
+
+}
+// display the table showing the contents of the script, along with the duplicate locators in the table
+export const displayTable = async (duplicateLocatorTable: (string | number)[][], config: TableUserConfig) => {
+
+    // headings displayed beforing table
+    await consoleHeadings();
+
+    // display the final table detailing the duplicate locators
+    console.log(table(duplicateLocatorTable, config));
+}
+
+const listOfDuplicateLocators = (filePaths: string[]): Map<locator, LocatorFiles> => {
+    const locators = new Set<locator>();
+    const storeDuplicateLocators = new Map<locator, LocatorFiles>();
+
+    // read the files find the duplicates, filepath and number of times they appear
+    for (const filePath of filePaths) {
+        try {
+            const readFile = fs.readFileSync(filePath, { encoding: 'utf-8' });
+            const matches = readFile.match(regexs.getLocator) ?? [];
+
+            // search the matches store the unqie locators and the duplicates
+            for (const locator of matches) {
+
+                // always add into the all locators set 
+                locators.add(locator);
+
+                const getDuplicateLocator = storeDuplicateLocators.get(locator);
+
+                // create new object here as the duplicate locator isn't here yet
+                if (!storeDuplicateLocators.get(locator)) {
+                    storeDuplicateLocators.set(locator, {
+                        files: new Map([[filePath, 1]])
+                    });
+
+                    // update the object as it exists
+                } else {
+                    // set the total number of locators in a file path
+                    getDuplicateLocator?.files.set(filePath, (storeDuplicateLocators.get(locator)?.files.get(filePath) ?? 0) + 1);
+
+                }
+            }
+        }
+        catch (err) {
+            console.log(`Error reading file - ${err}`);
+        }
+
+    }
+    return storeDuplicateLocators;
+}
+
+const countLocatorsSeenAcrossFiles = (duplicateLocators: Map<locator, LocatorFiles>): TableRows[] => {
+    let index = 0;
+    const tableRows: TableRows[] = [];
+
+    // gets the total times a locator appears across all files
+    for (const [locator, files] of duplicateLocators) {
+
+        index++;
+        // get the total count for each locator across all files
+        const runningCount = [...files.files.values()].reduce((acc, val) =>
+            acc + val, 0
+        );
+
+        // want to calculate the status based on the running count
+        const status = locatorStatus(runningCount);
+
+        // get the file paths for each of the locators
+        const filePaths = [...files.files.entries()].map((file) => `${file[0]}`).join('\n');
+
+        const fileCount = [...files.files.entries()].map((count) => `${count[1]}`).join('\n');
+
+        // only push into the table if the total number of locators is more than one
+        if (runningCount > 1) {
+            tableRows.push([index, locator.replace(regexs.getLocatorPrefix, ''), runningCount, status, filePaths, fileCount]);
+        }
+
+    }
+    return tableRows;
+}
+
+const orderTableByHighestStatus = (tableRows: TableRows[]): TableRows[] => {
+    // order to show the highest status at the top of the table - will help to show the highest duplicates
+    const orderByTotalCount = tableRows.sort((first: any, second: any) => second[2] - first[2]);
+
+    // reorder the table numbers - sorting will change this
+    // now reorder the # numbering
+    const reorderedTable: TableRows[] = orderByTotalCount.map((row, index) => {
+        return [
+            index + 1,
+            row[1],
+            row[2],
+            row[3],
+            row[4],
+            row[5]
+        ]
+    })
+    return reorderedTable;
+}
+
+export const buildTable = (filePaths: string[]) => {
+    const tableHeaders: string[] = ['#', 'Locator', 'Total', 'Status', 'FilePath', 'Count'];
+
+    // get the duplicate locators
+    const storeDuplicateLocators = listOfDuplicateLocators(filePaths);
+    // get the duplicate locators seen across a file
+    const locatorCountAcrossFiles = countLocatorsSeenAcrossFiles(storeDuplicateLocators);
+
+    // order the table by the highest status
+    const orderTable = orderTableByHighestStatus(locatorCountAcrossFiles);
+
+    if (orderTable.length < 1) {
+        console.log();
+        console.log('🐶 Max sniffed everywhere... no duplicate locators found!'.green.bold);
+        console.log('✨ Your selectors are clean, tidy, and robust. Good human.\n'.dim);
+        process.exit(0);
+    } else {
+        // return the final table to be displayed in the console
+        const finalTable: (string | number)[][] = [tableHeaders, ...orderTable];
+        return finalTable;
+    }
+}

package/src/table/types.ts

@@ -0,0 +1,9 @@
+// TYPES
+// header - '#', 'Locator', 'Total', 'Status', 'FilePath', 'Count'
+export type TableRows = [index: number, locator: string, total: number, status: string, filePath: string, count: string];
+export type locator = string;
+export type filePath = string;
+export type count = number;
+
+// the file path and the number of times the locator is found in the file
+export type LocatorFiles = { files: Map<filePath, count> };

package/src/table/utils.ts

@@ -0,0 +1,18 @@
+import color from 'colors';
+
+
+// turn on colors for console
+color.enable();
+
+// determind the status of the locator found
+// rules:
+// > 10 = HIGH
+// > 5 = MEDIUM
+// else = LOW
+export const locatorStatus = (count: number) => {
+    if (count > 10) return 'HIGH'.red;
+    if (count > 4) return 'MEDIUM'.yellow;
+    else {
+        return 'LOW'.grey;
+    }
+}

package/tsconfig.json

@@ -0,0 +1,44 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    "rootDir": "./src",
+    "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "es2024",
+    "types": ["node"],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/nodev
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+  }
+}