difflens 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 DiffLens Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,149 @@
+# DiffLens
+
+[![npm version](https://img.shields.io/npm/v/difflens.svg)](https://www.npmjs.com/package/difflens)
+[![CI](https://github.com/hayato06/difflens/actions/workflows/ci.yml/badge.svg)](https://github.com/hayato06/difflens/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/node/v/difflens.svg)](https://nodejs.org/)
+
+**Visual Regression Testing for Everyone + Accessibility as a Service**
+
+DiffLens is a lightweight, zero-config visual regression testing and accessibility auditing tool built on top of [Playwright](https://playwright.dev/).
+
+## Features
+
+- 📸 **Visual Regression Testing**: Automatically capture screenshots and detect pixel-perfect differences.
+- ♿ **Accessibility Auditing**: Integrated `axe-core` checks to catch a11y violations.
+- ⚙️ **Zero Config**: Works out of the box, or customize with `difflens.config.ts`.
+- 📊 **HTML Reporting**: Generate visual reports to easily inspect diffs.
+- 🤖 **CI Ready**: Proper exit codes for CI/CD integration.
+
+## Installation
+
+```bash
+npm install -D difflens
+# or
+yarn add -D difflens
+# or
+pnpm add -D difflens
+```
+
+## Usage
+
+### Initialize
+
+Generate a configuration file:
+
+```bash
+npx difflens init
+```
+
+### Run Tests
+
+Execute visual regression tests and accessibility audits:
+
+```bash
+npx difflens test
+```
+
+- **First Run**: Captures screenshots and saves them as **Baseline** (`.difflens/baseline`).
+- **Subsequent Runs**: Captures new screenshots (`.difflens/current`) and compares them with the baseline.
+- **Diffs**: If differences are detected, diff images are saved to `.difflens/diff` and the test fails.
+
+### View Report
+
+After running tests, open the generated HTML report:
+
+```bash
+open .difflens/index.html
+```
+
+## Configuration
+
+Create `difflens.config.ts` in your project root:
+
+```typescript
+import { DiffLensConfig } from 'difflens';
+
+const config: DiffLensConfig = {
+  // Base URL for all scenarios (optional)
+  baseUrl: 'https://example.com',
+
+  // Output directory for artifacts (default: .difflens)
+  outDir: '.difflens',
+
+  // Image comparison threshold (0 to 1, default: 0.1)
+  threshold: 0.1,
+
+  // Fail test if an action fails (default: false)
+  failOnActionError: false,
+
+  // Test scenarios
+  scenarios: [
+    {
+      label: 'homepage',
+      path: '/',
+      // Optional: Define multiple viewports
+      viewports: [
+        { width: 1280, height: 720, label: 'desktop' },
+        { width: 375, height: 667, label: 'mobile' },
+      ],
+      // Optional: Perform actions before screenshot
+      actions: [
+        { type: 'wait', timeout: 1000 },
+        { type: 'click', selector: '#login-button' },
+        { type: 'type', selector: '#username', value: 'user' },
+      ],
+    },
+    {
+      label: 'about',
+      path: '/about',
+    },
+  ],
+};
+
+export default config;
+```
+
+## MCP & API Server
+
+DiffLens provides an MCP server and a REST API for integration with AI agents.
+
+### Response Schema
+
+Both the MCP tool and the API endpoint return a JSON response with the following structure:
+
+```json
+{
+  "success": boolean, // Overall success status
+  "results": [
+    {
+      "scenario": string,
+      "status": "pass" | "fail" | "new",
+      "diffPixels": number,
+      "diffPercentage": number,
+      "dimensionMismatch": boolean, // True if dimensions differ
+      "a11yViolations": [ ... ] // List of accessibility violations
+    }
+  ]
+}
+```
+
+## CLI Options
+
+### `test`
+
+- `--url <url>`: Run a quick test against a specific URL (overrides config).
+- `--label <label>`: Label for the ad-hoc test (default: 'check').
+- `--format <type>`: Output format.
+    - `default`: Standard output with HTML report generation.
+    - `json`: Output pure JSON to stdout (logs redirected to stderr).
+    - `ai`: Output AI-friendly text summary to stdout (logs redirected to stderr).
+
+### Exit Codes
+
+- `0`: Success (No visual regressions or accessibility violations).
+- `1`: Failure (Visual regression detected, dimension mismatch, or accessibility violations).
+
+## License
+
+MIT

package/dist/ai-reporter-GPDXP36M.mjs

@@ -0,0 +1,6 @@
+import {
+  formatAiReport
+} from "./chunk-4Q2LAHUO.mjs";
+export {
+  formatAiReport
+};

package/dist/api-server.d.mts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/api-server.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/api-server.js

@@ -0,0 +1,89 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/api-server.ts
+var import_node_server = require("@hono/node-server");
+var import_hono = require("hono");
+var import_child_process = require("child_process");
+var import_util = require("util");
+var import_path = __toESM(require("path"));
+var execFileAsync = (0, import_util.promisify)(import_child_process.execFile);
+var app = new import_hono.Hono();
+app.get("/health", (c) => {
+  return c.json({ status: "ok", version: "0.0.1" });
+});
+app.post("/check", async (c) => {
+  try {
+    const body = await c.req.json();
+    const { url, label } = body;
+    if (!url) {
+      return c.json({ error: "URL is required" }, 400);
+    }
+    const scenarioLabel = label || "check";
+    const cliPath = import_path.default.resolve(__dirname, "cli.js");
+    const args = [cliPath, "test", "--url", url, "--label", scenarioLabel, "--format", "json"];
+    console.log(`Executing: node ${args.join(" ")}`);
+    try {
+      const { stdout, stderr } = await execFileAsync(process.execPath, args);
+      let results;
+      try {
+        results = JSON.parse(stdout);
+        if (!Array.isArray(results)) {
+          results = [results];
+        }
+      } catch (e) {
+        results = [];
+      }
+      return c.json({
+        success: true,
+        results
+      });
+    } catch (error) {
+      const stdout = error.stdout;
+      let results;
+      try {
+        results = JSON.parse(stdout);
+        if (!Array.isArray(results)) {
+          results = [results];
+        }
+      } catch (e) {
+        results = [];
+      }
+      return c.json({
+        success: false,
+        // Visual regression found or error
+        results,
+        error: error.message
+      });
+    }
+  } catch (error) {
+    return c.json({ error: error.message }, 500);
+  }
+});
+var port = 3e3;
+console.log(`Server is running on port ${port}`);
+(0, import_node_server.serve)({
+  fetch: app.fetch,
+  port
+});

package/dist/api-server.mjs

@@ -0,0 +1,65 @@
+// src/api-server.ts
+import { serve } from "@hono/node-server";
+import { Hono } from "hono";
+import { execFile } from "child_process";
+import { promisify } from "util";
+import path from "path";
+var execFileAsync = promisify(execFile);
+var app = new Hono();
+app.get("/health", (c) => {
+  return c.json({ status: "ok", version: "0.0.1" });
+});
+app.post("/check", async (c) => {
+  try {
+    const body = await c.req.json();
+    const { url, label } = body;
+    if (!url) {
+      return c.json({ error: "URL is required" }, 400);
+    }
+    const scenarioLabel = label || "check";
+    const cliPath = path.resolve(__dirname, "cli.js");
+    const args = [cliPath, "test", "--url", url, "--label", scenarioLabel, "--format", "json"];
+    console.log(`Executing: node ${args.join(" ")}`);
+    try {
+      const { stdout, stderr } = await execFileAsync(process.execPath, args);
+      let results;
+      try {
+        results = JSON.parse(stdout);
+        if (!Array.isArray(results)) {
+          results = [results];
+        }
+      } catch (e) {
+        results = [];
+      }
+      return c.json({
+        success: true,
+        results
+      });
+    } catch (error) {
+      const stdout = error.stdout;
+      let results;
+      try {
+        results = JSON.parse(stdout);
+        if (!Array.isArray(results)) {
+          results = [results];
+        }
+      } catch (e) {
+        results = [];
+      }
+      return c.json({
+        success: false,
+        // Visual regression found or error
+        results,
+        error: error.message
+      });
+    }
+  } catch (error) {
+    return c.json({ error: error.message }, 500);
+  }
+});
+var port = 3e3;
+console.log(`Server is running on port ${port}`);
+serve({
+  fetch: app.fetch,
+  port
+});

package/dist/chunk-4Q2LAHUO.mjs

@@ -0,0 +1,51 @@
+// src/core/reporters/ai-reporter.ts
+import path from "path";
+function formatAiReport(results, outDir) {
+  let output = "DiffLens Test Report\n====================\n\n";
+  const failures = results.filter((r) => r.status === "fail" || r.a11yViolations.length > 0);
+  if (failures.length === 0) {
+    return output + "All tests passed. No visual regressions or accessibility violations found.\n";
+  }
+  output += `Found ${failures.length} issues:
+
+`;
+  failures.forEach((result, index) => {
+    output += `Issue #${index + 1}: ${result.scenario}
+`;
+    output += `----------------------------------------
+`;
+    if (result.status === "fail") {
+      if (result.dimensionMismatch) {
+        output += `[Dimension Mismatch]
+`;
+        output += `  Baseline and current images have different dimensions.
+`;
+      } else if (result.diffPixels > 0) {
+        output += `[Visual Regression]
+`;
+        output += `  Diff Pixels: ${result.diffPixels} (${result.diffPercentage.toFixed(2)}%)
+`;
+        if (result.diffPath) {
+          output += `  Diff Image: ${path.relative(process.cwd(), result.diffPath)}
+`;
+        }
+      }
+    }
+    if (result.a11yViolations.length > 0) {
+      output += `[Accessibility Violations]
+`;
+      result.a11yViolations.forEach((v) => {
+        output += `  - [${v.impact}] ${v.help} (${v.id})
+`;
+        output += `    Target: ${v.nodes.map((n) => n.target.join(", ")).join(" | ")}
+`;
+      });
+    }
+    output += "\n";
+  });
+  return output;
+}
+
+export {
+  formatAiReport
+};