@cleaver/breakcheck-core 0.1.0

package/README.md

@@ -0,0 +1,152 @@
+# Breakcheck Core
+
+This package provides the core programmatic API for **Breakcheck**. Use this library to integrate website snapshotting, comparison, and viewing directly into your own JavaScript or TypeScript projects.
+
+This package is intended for developers who need to build custom automation or tooling. If you're looking to use Breakcheck from the command line, see the main [`breakcheck`](https://github.com/cleaver/breakcheck) package.
+
+---
+
+## Installation
+
+```bash
+npm install breakcheck-core
+```
+
+---
+
+## API Usage
+
+The `breakcheck-core` library exposes a set of simple, asynchronous functions to manage the entire workflow.
+
+### Creating a Snapshot
+
+To begin, you need to create a "snapshot" of a website. A snapshot is a record of a site's state at a specific point in time, created by crawling the site and saving its content.
+
+The `createSnapshotFromConfig` function takes a configuration object and returns the results of the crawl.
+
+```javascript
+import { createSnapshotFromConfig } from "breakcheck-core";
+
+async function takeSnapshot() {
+  const snapshotConfig = {
+    // The URL where the crawler will start
+    baseUrl: "http://localhost:3000",
+
+    // A unique name for this snapshot
+    name: "my-site-before-changes",
+
+    // Settings for the crawler
+    crawlSettings: {
+      baseUrl: "http://localhost:3000",
+      // 'cheerio' for static sites, 'playwright' for dynamic, JS-heavy sites
+      crawlerType: "cheerio",
+      maxDepth: 3, // How many links deep to follow
+    },
+
+    // Optional: Write a list of all crawled URLs to a file
+    urlListPath: "./crawled-urls.txt",
+  };
+
+  const result = await createSnapshotFromConfig(snapshotConfig);
+
+  if (result.status === "success") {
+    console.log(`✅ Snapshot created: ${result.snapshotId}`);
+    console.log(`📊 Pages crawled: ${result.pageCount}`);
+  } else {
+    console.error(`❌ Snapshot failed: ${result.message}`);
+  }
+}
+
+takeSnapshot();
+```
+
+### Listing Snapshots
+
+You can get a list of all locally saved snapshots using the `listSnapshots` function.
+
+```javascript
+import { listSnapshots } from "breakcheck-core";
+
+async function showSnapshots() {
+  const snapshots = await listSnapshots();
+
+  if (snapshots.length === 0) {
+    console.log("No snapshots found.");
+    return;
+  }
+
+  console.log("Available Snapshots:");
+  snapshots.forEach((snapshot) => {
+    console.log(
+      `- ${snapshot.name} (${snapshot.pageCount} pages, created on ${snapshot.date})`
+    );
+  });
+}
+
+showSnapshots();
+```
+
+### Running a Comparison
+
+The core of the tool is comparing two snapshots. The `runComparison` function compares a "before" and "after" snapshot, applies rules to ignore dynamic content, and saves a detailed diff report.
+
+```javascript
+import { runComparison } from "breakcheck-core";
+
+async function compareStates() {
+  const comparisonConfig = {
+    // The name of the 'before' snapshot
+    beforeSnapshotId: "my-site-before-changes",
+
+    // The name of the 'after' snapshot
+    afterSnapshotId: "my-site-after-changes",
+
+    // A unique name for the comparison results directory
+    comparisonName: "v1-vs-v2-comparison",
+
+    // The ruleset to apply. 'default' uses built-in baseline rules.
+    // You can also provide a path to a rules file or a ruleset object.
+    ruleset: "default",
+  };
+
+  const summary = await runComparison(comparisonConfig);
+
+  if (summary.status === "completed") {
+    console.log(`✅ Comparison complete!`);
+    console.log(`   - Overall result: ${summary.overallResult.toUpperCase()}`);
+    console.log(`   - Pages with differences: ${summary.pagesWithDifferences}`);
+    console.log(`   - Results saved to: ${summary.resultsPath}`);
+  } else {
+    console.error("❌ Comparison failed.");
+  }
+}
+
+compareStates();
+```
+
+### Viewing Comparison Results
+
+After a comparison is complete, you can launch a local web server to view the results in your browser. The `startViewServer` function starts an Express server that renders the diffs.
+
+```javascript
+import { startViewServer } from "breakcheck-core";
+
+async function viewResults() {
+  const comparisonName = "v1-vs-v2-comparison"; // The name of the comparison to view
+  const port = 8080;
+
+  try {
+    const server = await startViewServer(comparisonName, port);
+    console.log(`🌐 View server running at http://localhost:${port}`);
+    console.log("Press Ctrl+C to stop the server.");
+
+    // You can add logic to automatically open the browser or close the server
+    // For example, to stop it after 60 seconds:
+    // setTimeout(() => server.close(), 60000);
+  } catch (error) {
+    console.error(`❌ Could not start view server: ${error.message}`);
+  }
+}
+
+viewResults();
+```

package/dist/__tests__/compare/index.test.js

@@ -0,0 +1,322 @@
+import { describe, expect, it } from "vitest";
+import { comparePage, compareSnapshots } from "../../core/compare";
+import { ComparisonRepository } from "../../core/compare/classes/ComparisonRepository";
+/**
+ * Creates a mock SnapshotRepository for testing
+ */
+class MockSnapshotRepository {
+    beforeSnapshot;
+    afterSnapshot;
+    constructor(beforeSnapshot, afterSnapshot) {
+        this.beforeSnapshot = beforeSnapshot;
+        this.afterSnapshot = afterSnapshot;
+    }
+    async loadSnapshot(name) {
+        return name === "before" ? this.beforeSnapshot : this.afterSnapshot;
+    }
+    async saveSnapshot(name, data) {
+        return 0;
+    }
+    async generateUrlList(name) {
+        return "";
+    }
+    async listSnapshots() {
+        return [];
+    }
+}
+/**
+ * Creates a mock RulesEngine for testing
+ */
+class MockRulesEngine {
+    constructor(rulesetOrName) {
+        // No-op constructor
+    }
+    process(html) {
+        return html;
+    }
+}
+/**
+ * Creates a mock ComparisonRepository for testing
+ */
+class MockComparisonRepository {
+    index = {
+        urls: {},
+        metadata: {
+            timestamp: new Date().toISOString(),
+            totalPages: 0,
+            pagesWithDifferences: 0,
+        },
+    };
+    constructor() { }
+    static async create(name, metadata) {
+        const instance = new MockComparisonRepository();
+        instance.index.metadata = {
+            ...metadata,
+            timestamp: new Date().toISOString(),
+            totalPages: 0,
+            pagesWithDifferences: 0,
+        };
+        return instance;
+    }
+    async savePageDiff(pageDiff) {
+        this.index.urls[pageDiff.url] = {
+            filename: `${pageDiff.url}.json.gz`,
+            hasDifferences: pageDiff.hasDifferences,
+        };
+        this.index.metadata.totalPages++;
+        if (pageDiff.hasDifferences) {
+            this.index.metadata.pagesWithDifferences++;
+        }
+    }
+    async finalizeComparison() {
+        return "/mock/comparison/path";
+    }
+    getIndex() {
+        return this.index;
+    }
+}
+async function createMockSnapshotRepository(beforeSnapshot, afterSnapshot) {
+    return new MockSnapshotRepository(beforeSnapshot, afterSnapshot);
+}
+function createMockRulesEngine() {
+    return new MockRulesEngine("default");
+}
+function createMockSnapshot(urls, content) {
+    return {
+        index: {
+            urls,
+            metadata: {
+                baseUrl: "https://example.com",
+                timestamp: new Date().toISOString(),
+                totalPages: Object.keys(urls).length,
+            },
+        },
+        getPage: async (url) => ({
+            url,
+            finalUrl: url,
+            content,
+            statusCode: 200,
+            headers: { "content-type": "text/html" },
+        }),
+    };
+}
+describe("Compare Functions", () => {
+    describe("comparePage", () => {
+        it("should detect content differences between snapshots", async () => {
+            const before = {
+                url: "https://example.com",
+                finalUrl: "https://example.com",
+                content: "<html>\n<body>Hello World</body>\n</html>",
+                statusCode: 200,
+                headers: { "content-type": "text/html" },
+            };
+            const after = {
+                url: "https://example.com",
+                finalUrl: "https://example.com",
+                content: "<html>\n<body>Hello New World</body>\n</html>",
+                statusCode: 200,
+                headers: { "content-type": "text/html" },
+            };
+            const result = await comparePage(before, after);
+            expect(result.url).toBe("https://example.com");
+            expect(result.hasDifferences).toBe(true);
+            // Expect 4 lines: One addition, one removal, two unchanged
+            expect(result.differences).toHaveLength(4);
+            const numberLinesAdded = result.differences.filter((d) => d.added).length;
+            const numberLinesRemoved = result.differences.filter((d) => d.removed).length;
+            const numberLinesUnchanged = result.differences.filter((d) => !d.added && !d.removed).length;
+            expect(numberLinesAdded).toBe(1);
+            expect(numberLinesRemoved).toBe(1);
+            expect(numberLinesUnchanged).toBe(2);
+        });
+        it("should return no differences for identical snapshots", async () => {
+            const snapshot = {
+                url: "https://example.com",
+                finalUrl: "https://example.com",
+                content: "<html><body>Hello World</body></html>",
+                statusCode: 200,
+                headers: { "content-type": "text/html" },
+            };
+            const result = await comparePage(snapshot, snapshot);
+            expect(result.url).toBe("https://example.com");
+            expect(result.hasDifferences).toBe(false);
+            expect(result.differences).toHaveLength(1);
+            expect(result.differences[0].added).toBeUndefined();
+            expect(result.differences[0].removed).toBeUndefined();
+        });
+    });
+    describe("compareSnapshots", () => {
+        async function createSetup(beforeUrls, afterUrls, beforeContent, afterContent) {
+            const beforeSnapshot = createMockSnapshot(beforeUrls, beforeContent);
+            const afterSnapshot = createMockSnapshot(afterUrls, afterContent);
+            const snapshotRepository = await createMockSnapshotRepository(beforeSnapshot, afterSnapshot);
+            const comparisonRepository = await ComparisonRepository.create("test-comparison", {
+                beforeSnapshotId: "before",
+                afterSnapshotId: "after",
+                rulesUsedIdentifier: "default",
+            });
+            const rulesEngine = createMockRulesEngine();
+            return {
+                snapshotRepository,
+                comparisonRepository,
+                rulesEngine,
+                comparisonParams: {
+                    beforeSnapshotId: "before",
+                    afterSnapshotId: "after",
+                    comparisonName: "test-comparison",
+                    ruleset: "default",
+                },
+            };
+        }
+        it("should detect content differences between snapshots", async () => {
+            const beforeUrls = {
+                "https://example.com": {
+                    filename: "example.html",
+                    statusCode: 200,
+                },
+            };
+            const afterUrls = {
+                "https://example.com": {
+                    filename: "example.html",
+                    statusCode: 200,
+                },
+            };
+            const beforeContent = "<html>\n<body>Hello World</body>\n</html>";
+            const afterContent = "<html>\n<body>Hello New World</body>\n</html>";
+            const setup = await createSetup(beforeUrls, afterUrls, beforeContent, afterContent);
+            const result = await compareSnapshots(setup.comparisonParams, setup.snapshotRepository, setup.comparisonRepository, setup.rulesEngine);
+            expect(result.status).toBe("completed");
+            expect(result.overallResult).toBe("fail");
+            expect(result.totalPagesCompared).toBe(1);
+            expect(result.pagesWithDifferences).toBe(1);
+            expect(result.newUrls).toHaveLength(0);
+            expect(result.removedUrls).toHaveLength(0);
+        });
+        it("should detect new and removed URLs between snapshots", async () => {
+            const beforeUrls = {
+                "https://example.com/old": {
+                    filename: "old.html",
+                    statusCode: 200,
+                },
+            };
+            const afterUrls = {
+                "https://example.com/new": {
+                    filename: "new.html",
+                    statusCode: 200,
+                },
+            };
+            const beforeContent = "<html><body>Old Page</body></html>";
+            const afterContent = "<html><body>New Page</body></html>";
+            const setup = await createSetup(beforeUrls, afterUrls, beforeContent, afterContent);
+            const result = await compareSnapshots(setup.comparisonParams, setup.snapshotRepository, setup.comparisonRepository, setup.rulesEngine);
+            expect(result.status).toBe("completed");
+            expect(result.overallResult).toBe("pass");
+            expect(result.totalPagesCompared).toBe(0);
+            expect(result.pagesWithDifferences).toBe(0);
+            expect(result.newUrls).toHaveLength(1);
+            expect(result.newUrls[0]).toBe("https://example.com/new");
+            expect(result.removedUrls).toHaveLength(1);
+            expect(result.removedUrls[0]).toBe("https://example.com/old");
+        });
+        it("should filter URLs when specified", async () => {
+            const beforeUrls = {
+                "https://example.com/page1": {
+                    filename: "page1.html",
+                    statusCode: 200,
+                },
+                "https://example.com/page2": {
+                    filename: "page2.html",
+                    statusCode: 200,
+                },
+            };
+            const afterUrls = {
+                "https://example.com/page1": {
+                    filename: "page1.html",
+                    statusCode: 200,
+                },
+                "https://example.com/page2": {
+                    filename: "page2.html",
+                    statusCode: 200,
+                },
+            };
+            const beforeContent = "<html><body>Original Content</body></html>";
+            const afterContent = "<html><body>Modified Content</body></html>";
+            const setup = await createSetup(beforeUrls, afterUrls, beforeContent, afterContent);
+            const result = await compareSnapshots({
+                ...setup.comparisonParams,
+                urls: ["https://example.com/page1"],
+            }, setup.snapshotRepository, setup.comparisonRepository, setup.rulesEngine);
+            expect(result.status).toBe("completed");
+            expect(result.overallResult).toBe("fail");
+            expect(result.totalPagesCompared).toBe(1);
+            expect(result.pagesWithDifferences).toBe(1);
+            expect(result.newUrls).toHaveLength(0);
+            expect(result.removedUrls).toHaveLength(0);
+        });
+        it("should return no differences for identical snapshots", async () => {
+            const beforeUrls = {
+                "https://example.com": {
+                    filename: "example.html",
+                    statusCode: 200,
+                },
+            };
+            const afterUrls = {
+                "https://example.com": {
+                    filename: "example.html",
+                    statusCode: 200,
+                },
+            };
+            const beforeContent = "<html><body>Hello World</body></html>";
+            const afterContent = "<html><body>Hello World</body></html>";
+            const setup = await createSetup(beforeUrls, afterUrls, beforeContent, afterContent);
+            const result = await compareSnapshots(setup.comparisonParams, setup.snapshotRepository, setup.comparisonRepository, setup.rulesEngine);
+            expect(result.status).toBe("completed");
+            expect(result.overallResult).toBe("pass");
+            expect(result.totalPagesCompared).toBe(1);
+            expect(result.pagesWithDifferences).toBe(0);
+            expect(result.newUrls).toHaveLength(0);
+            expect(result.removedUrls).toHaveLength(0);
+        });
+        it("should return URLs in ascending sorted order regardless of input order", async () => {
+            const beforeUrls = {
+                "https://example.com/m": {
+                    filename: "m.html",
+                    statusCode: 200,
+                },
+                "https://example.com/a": {
+                    filename: "a.html",
+                    statusCode: 200,
+                },
+                "https://example.com/z": {
+                    filename: "z.html",
+                    statusCode: 200,
+                },
+            };
+            const afterUrls = {
+                "https://example.com/m": {
+                    filename: "m.html",
+                    statusCode: 200,
+                },
+                "https://example.com/a": {
+                    filename: "a.html",
+                    statusCode: 200,
+                },
+                "https://example.com/z": {
+                    filename: "z.html",
+                    statusCode: 200,
+                },
+            };
+            const beforeContent = "<html><body>Original Content</body></html>";
+            const afterContent = "<html><body>Modified Content</body></html>";
+            const setup = await createSetup(beforeUrls, afterUrls, beforeContent, afterContent);
+            const result = await compareSnapshots(setup.comparisonParams, setup.snapshotRepository, setup.comparisonRepository, setup.rulesEngine);
+            expect(result.status).toBe("completed");
+            expect(result.overallResult).toBe("fail");
+            expect(result.totalPagesCompared).toBe(3);
+            expect(result.pagesWithDifferences).toBe(3);
+            expect(result.newUrls).toHaveLength(0);
+            expect(result.removedUrls).toHaveLength(0);
+        });
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/__tests__/compare/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../../src/__tests__/compare/index.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AAUvF;;GAEG;AACH,MAAM,sBAAsB;IAON;IAA6B;IAAjD,YAAoB,cAAmB,EAAU,aAAkB;QAA/C,mBAAc,GAAd,cAAc,CAAK;QAAU,kBAAa,GAAb,aAAa,CAAK;IAAG,CAAC;IAEvE,KAAK,CAAC,YAAY,CAAC,IAAY;QAC7B,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;IACtE,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,IAAyC;QACxE,OAAO,CAAC,CAAC;IACX,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,IAAY;QAChC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,eAAe;IACnB,YAAY,aAA2B;QACrC,oBAAoB;IACtB,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;GAEG;AACH,MAAM,wBAAwB;IACpB,KAAK,GAAoB;QAC/B,IAAI,EAAE,EAAE;QACR,QAAQ,EAAE;YACR,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,UAAU,EAAE,CAAC;YACb,oBAAoB,EAAE,CAAC;SACjB;KACT,CAAC;IAEF,gBAAuB,CAAC;IAExB,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,IAAY,EACZ,QAA4B;QAE5B,MAAM,QAAQ,GAAG,IAAI,wBAAwB,EAAE,CAAC;QAChD,QAAQ,CAAC,KAAK,CAAC,QAAQ,GAAG;YACxB,GAAG,QAAQ;YACX,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,UAAU,EAAE,CAAC;YACb,oBAAoB,EAAE,CAAC;SACxB,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,QAAkB;QACnC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG;YAC9B,QAAQ,EAAE,GAAG,QAAQ,CAAC,GAAG,UAAU;YACnC,cAAc,EAAE,QAAQ,CAAC,cAAc;SACxC,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACjC,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF;AAED,KAAK,UAAU,4BAA4B,CACzC,cAAmB,EACnB,aAAkB;IAElB,OAAO,IAAI,sBAAsB,CAC/B,cAAc,EACd,aAAa,CACmB,CAAC;AACrC,CAAC;AAED,SAAS,qBAAqB;IAC5B,OAAO,IAAI,eAAe,CAAC,SAAS,CAA2B,CAAC;AAClE,CAAC;AAcD,SAAS,kBAAkB,CACzB,IAA8D,EAC9D,OAAe;IAEf,OAAO;QACL,KAAK,EAAE;YACL,IAAI;YACJ,QAAQ,EAAE;gBACR,OAAO,EAAE,qBAAqB;gBAC9B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM;aACrC;SACF;QACD,OAAO,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,CAAC;YAC/B,GAAG;YACH,QAAQ,EAAE,GAAG;YACb,OAAO;YACP,UAAU,EAAE,GAAG;YACf,OAAO,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE;SACzC,CAAC;KACH,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,MAAM,GAAiB;gBAC3B,GAAG,EAAE,qBAAqB;gBAC1B,QAAQ,EAAE,qBAAqB;gBAC/B,OAAO,EAAE,2CAA2C;gBACpD,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE;aACzC,CAAC;YAEF,MAAM,KAAK,GAAiB;gBAC1B,GAAG,EAAE,qBAAqB;gBAC1B,QAAQ,EAAE,qBAAqB;gBAC/B,OAAO,EAAE,+CAA+C;gBACxD,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE;aACzC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAEhD,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzC,2DAA2D;YAC3D,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAE3C,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;YAC1E,MAAM,kBAAkB,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAClD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CACjB,CAAC,MAAM,CAAC;YACT,MAAM,oBAAoB,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CACpD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAC9B,CAAC,MAAM,CAAC;YAET,MAAM,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,QAAQ,GAAiB;gBAC7B,GAAG,EAAE,qBAAqB;gBAC1B,QAAQ,EAAE,qBAAqB;gBAC/B,OAAO,EAAE,uCAAuC;gBAChD,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE;aACzC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAErD,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACpD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,KAAK,UAAU,WAAW,CACxB,UAAoE,EACpE,SAAmE,EACnE,aAAqB,EACrB,YAAoB;YAEpB,MAAM,cAAc,GAAG,kBAAkB,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;YACrE,MAAM,aAAa,GAAG,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YAClE,MAAM,kBAAkB,GAAG,MAAM,4BAA4B,CAC3D,cAAc,EACd,aAAa,CACd,CAAC;YACF,MAAM,oBAAoB,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAC5D,iBAAiB,EACjB;gBACE,gBAAgB,EAAE,QAAQ;gBAC1B,eAAe,EAAE,OAAO;gBACxB,mBAAmB,EAAE,SAAS;aAC/B,CACF,CAAC;YACF,MAAM,WAAW,GAAG,qBAAqB,EAAE,CAAC;YAC5C,OAAO;gBACL,kBAAkB;gBAClB,oBAAoB;gBACpB,WAAW;gBACX,gBAAgB,EAAE;oBAChB,gBAAgB,EAAE,QAAQ;oBAC1B,eAAe,EAAE,OAAO;oBACxB,cAAc,EAAE,iBAAiB;oBACjC,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC;QACJ,CAAC;QAED,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,UAAU,GAAG;gBACjB,qBAAqB,EAAE;oBACrB,QAAQ,EAAE,cAAc;oBACxB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,SAAS,GAAG;gBAChB,qBAAqB,EAAE;oBACrB,QAAQ,EAAE,cAAc;oBACxB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,aAAa,GAAG,2CAA2C,CAAC;YAClE,MAAM,YAAY,GAAG,+CAA+C,CAAC;YACrE,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,UAAU,EACV,SAAS,EACT,aAAa,EACb,YAAY,CACb,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,KAAK,CAAC,gBAAgB,EACtB,KAAK,CAAC,kBAAkB,EACxB,KAAK,CAAC,oBAAoB,EAC1B,KAAK,CAAC,WAAW,CAClB,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,UAAU,GAAG;gBACjB,yBAAyB,EAAE;oBACzB,QAAQ,EAAE,UAAU;oBACpB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,SAAS,GAAG;gBAChB,yBAAyB,EAAE;oBACzB,QAAQ,EAAE,UAAU;oBACpB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,aAAa,GAAG,oCAAoC,CAAC;YAC3D,MAAM,YAAY,GAAG,oCAAoC,CAAC;YAC1D,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,UAAU,EACV,SAAS,EACT,aAAa,EACb,YAAY,CACb,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,KAAK,CAAC,gBAAgB,EACtB,KAAK,CAAC,kBAAkB,EACxB,KAAK,CAAC,oBAAoB,EAC1B,KAAK,CAAC,WAAW,CAClB,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;YAC1D,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,UAAU,GAAG;gBACjB,2BAA2B,EAAE;oBAC3B,QAAQ,EAAE,YAAY;oBACtB,UAAU,EAAE,GAAG;iBAChB;gBACD,2BAA2B,EAAE;oBAC3B,QAAQ,EAAE,YAAY;oBACtB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,SAAS,GAAG;gBAChB,2BAA2B,EAAE;oBAC3B,QAAQ,EAAE,YAAY;oBACtB,UAAU,EAAE,GAAG;iBAChB;gBACD,2BAA2B,EAAE;oBAC3B,QAAQ,EAAE,YAAY;oBACtB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,aAAa,GAAG,4CAA4C,CAAC;YACnE,MAAM,YAAY,GAAG,4CAA4C,CAAC;YAClE,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,UAAU,EACV,SAAS,EACT,aAAa,EACb,YAAY,CACb,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC;gBACE,GAAG,KAAK,CAAC,gBAAgB;gBACzB,IAAI,EAAE,CAAC,2BAA2B,CAAC;aACpC,EACD,KAAK,CAAC,kBAAkB,EACxB,KAAK,CAAC,oBAAoB,EAC1B,KAAK,CAAC,WAAW,CAClB,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,UAAU,GAAG;gBACjB,qBAAqB,EAAE;oBACrB,QAAQ,EAAE,cAAc;oBACxB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,SAAS,GAAG;gBAChB,qBAAqB,EAAE;oBACrB,QAAQ,EAAE,cAAc;oBACxB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,aAAa,GAAG,uCAAuC,CAAC;YAC9D,MAAM,YAAY,GAAG,uCAAuC,CAAC;YAC7D,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,UAAU,EACV,SAAS,EACT,aAAa,EACb,YAAY,CACb,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,KAAK,CAAC,gBAAgB,EACtB,KAAK,CAAC,kBAAkB,EACxB,KAAK,CAAC,oBAAoB,EAC1B,KAAK,CAAC,WAAW,CAClB,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wEAAwE,EAAE,KAAK,IAAI,EAAE;YACtF,MAAM,UAAU,GAAG;gBACjB,uBAAuB,EAAE;oBACvB,QAAQ,EAAE,QAAQ;oBAClB,UAAU,EAAE,GAAG;iBAChB;gBACD,uBAAuB,EAAE;oBACvB,QAAQ,EAAE,QAAQ;oBAClB,UAAU,EAAE,GAAG;iBAChB;gBACD,uBAAuB,EAAE;oBACvB,QAAQ,EAAE,QAAQ;oBAClB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,SAAS,GAAG;gBAChB,uBAAuB,EAAE;oBACvB,QAAQ,EAAE,QAAQ;oBAClB,UAAU,EAAE,GAAG;iBAChB;gBACD,uBAAuB,EAAE;oBACvB,QAAQ,EAAE,QAAQ;oBAClB,UAAU,EAAE,GAAG;iBAChB;gBACD,uBAAuB,EAAE;oBACvB,QAAQ,EAAE,QAAQ;oBAClB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC;YACF,MAAM,aAAa,GAAG,4CAA4C,CAAC;YACnE,MAAM,YAAY,GAAG,4CAA4C,CAAC;YAClE,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,UAAU,EACV,SAAS,EACT,aAAa,EACb,YAAY,CACb,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,KAAK,CAAC,gBAAgB,EACtB,KAAK,CAAC,kBAAkB,EACxB,KAAK,CAAC,oBAAoB,EAC1B,KAAK,CAAC,WAAW,CAClB,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/__tests__/rules/RulesDsl.test.js

@@ -0,0 +1,190 @@
+import { readFileSync } from "fs";
+import { join } from "path";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { processRulesDsl } from "../../core/rules/RulesDsl";
+// Mock fs and path modules
+vi.mock("fs", () => ({
+    readFileSync: vi.fn(),
+}));
+vi.mock("path", () => ({
+    join: vi.fn(),
+}));
+// Mock the findRootDir function to return a predictable path
+vi.mock("../../lib/root", () => ({
+    findRootDir: vi.fn().mockResolvedValue("/mock/root"),
+}));
+describe("RulesDsl", () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+        join.mockImplementation((...args) => args.join("/"));
+    });
+    afterEach(() => {
+        vi.resetAllMocks();
+    });
+    describe("processRulesDsl", () => {
+        it("should throw error if rules file not found", async () => {
+            readFileSync.mockImplementation(() => {
+                throw new Error("File not found");
+            });
+            await expect(processRulesDsl("non-existent")).rejects.toThrow("Rules file not found: rules/non-existent/rules.breakcheck");
+        });
+        it("should parse single action rules", async () => {
+            const rulesContent = `
+                css:.ad-container do: exclude
+                css:#session-id do: exclude
+                css:.important-note do: include content_regex:"Warning:"
+            `;
+            readFileSync.mockReturnValue(rulesContent);
+            const result = await processRulesDsl("test-rules");
+            expect(result).toEqual({
+                name: "test-rules",
+                rules: [
+                    {
+                        selector: ".ad-container",
+                        actions: [{ action: "exclude", modifiers: {} }],
+                    },
+                    {
+                        selector: "#session-id",
+                        actions: [{ action: "exclude", modifiers: {} }],
+                    },
+                    {
+                        selector: ".important-note",
+                        actions: [
+                            {
+                                action: "include",
+                                modifiers: { content_regex: "Warning:" },
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+        it("should parse action blocks", async () => {
+            const rulesContent = `
+                css:img do
+                    remove_attr attr:"srcset"
+                    remove_attr attr:"sizes"
+                    rewrite_attr attr:"src" regex:"//cdn\\d+\\.example\\.com/" replace:"//cdn.example.com/"
+                end
+            `;
+            readFileSync.mockReturnValue(rulesContent);
+            const result = await processRulesDsl("test-rules");
+            expect(result).toEqual({
+                name: "test-rules",
+                rules: [
+                    {
+                        selector: "img",
+                        actions: [
+                            { action: "remove_attr", modifiers: { attr: "srcset" } },
+                            { action: "remove_attr", modifiers: { attr: "sizes" } },
+                            {
+                                action: "rewrite_attr",
+                                modifiers: {
+                                    attr: "src",
+                                    regex: "//cdn\\d+\\.example\\.com/",
+                                    replace: "//cdn.example.com/",
+                                },
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+        it("should parse rewrite content rules", async () => {
+            const rulesContent = `
+                css:.timestamp do: rewrite_content regex:"\\d{2}/\\d{2}/\\d{4}" replace:"DATE_STAMP"
+                css:.view-count do: rewrite_content regex:"\\d{1,3}(,\\d{3})* views" replace:"VIEW_COUNT views"
+            `;
+            readFileSync.mockReturnValue(rulesContent);
+            const result = await processRulesDsl("test-rules");
+            expect(result).toEqual({
+                name: "test-rules",
+                rules: [
+                    {
+                        selector: ".timestamp",
+                        actions: [
+                            {
+                                action: "rewrite_content",
+                                modifiers: {
+                                    regex: "\\d{2}/\\d{2}/\\d{4}",
+                                    replace: "DATE_STAMP",
+                                },
+                            },
+                        ],
+                    },
+                    {
+                        selector: ".view-count",
+                        actions: [
+                            {
+                                action: "rewrite_content",
+                                modifiers: {
+                                    regex: "\\d{1,3}(,\\d{3})* views",
+                                    replace: "VIEW_COUNT views",
+                                },
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+        it("should handle comments and whitespace", async () => {
+            const rulesContent = `
+-- This is a comment
+css:.ad-container do: exclude
+
+-- Another comment
+css:.important-note do: include content_regex:"Warning:"
+            `;
+            readFileSync.mockReturnValue(rulesContent);
+            const result = await processRulesDsl("test-rules");
+            expect(result).toEqual({
+                name: "test-rules",
+                rules: [
+                    {
+                        selector: ".ad-container",
+                        actions: [{ action: "exclude", modifiers: {} }],
+                    },
+                    {
+                        selector: ".important-note",
+                        actions: [
+                            {
+                                action: "include",
+                                modifiers: { content_regex: "Warning:" },
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+        it("should throw error for invalid syntax", async () => {
+            const rulesContent = `
+                css:.ad-container do exclude  # Missing colon after do
+            `;
+            readFileSync.mockReturnValue(rulesContent);
+            await expect(processRulesDsl("test-rules")).rejects.toThrow("Syntax errors in rules file");
+        });
+        it("should throw error for invalid action", async () => {
+            const rulesContent = `
+                css:.ad-container do: invalid_action
+            `;
+            readFileSync.mockReturnValue(rulesContent);
+            await expect(processRulesDsl("test-rules")).rejects.toThrow("Syntax errors in rules file");
+        });
+        it("should throw error for unclosed action block", async () => {
+            const rulesContent = `
+                css:img do
+                    remove_attr attr:"srcset"
+            `;
+            readFileSync.mockReturnValue(rulesContent);
+            await expect(processRulesDsl("test-rules")).rejects.toThrow("Syntax errors in rules file");
+        });
+        it("should throw error for missing required modifiers", async () => {
+            const rulesContent = `
+                css:img do: remove_attr
+            `;
+            readFileSync.mockReturnValue(rulesContent);
+            await expect(processRulesDsl("test-rules")).rejects.toThrow("Syntax errors in rules file");
+        });
+    });
+});
+//# sourceMappingURL=RulesDsl.test.js.map