rlint 0.4.0

package/dist/runner.js

@@ -0,0 +1,63 @@
+import { allChecks, checksByName } from './checks/index.js';
+export async function runChecks(page, options = {}) {
+    const config = options.config || {};
+    const url = page.url();
+    const viewport = page.viewport() || { width: 1280, height: 720 };
+    // Determine which checks to run
+    let checksToRun;
+    if (options.checks && options.checks.length > 0) {
+        // Run specific checks
+        checksToRun = options.checks
+            .map(name => checksByName[name])
+            .filter((c) => c !== undefined);
+    }
+    else if (config.checks) {
+        // Run checks based on config (skip disabled ones)
+        checksToRun = allChecks.filter(check => {
+            const checkName = check.name;
+            const checkConfig = config.checks?.[checkName];
+            return checkConfig !== false;
+        });
+    }
+    else {
+        // Run all checks
+        checksToRun = allChecks;
+    }
+    // Run all checks
+    const allIssues = [];
+    let totalPassed = 0;
+    for (const check of checksToRun) {
+        try {
+            const result = await check.run({ page, config });
+            allIssues.push(...result.issues);
+            totalPassed += result.passed;
+        }
+        catch (error) {
+            console.error(`Error running check "${check.name}":`, error);
+        }
+    }
+    // Apply severity from config
+    if (config.severity) {
+        for (const issue of allIssues) {
+            const checkName = issue.check;
+            if (config.severity[checkName]) {
+                issue.severity = config.severity[checkName];
+            }
+        }
+    }
+    // Count by severity
+    const errors = allIssues.filter(i => i.severity === 'error').length;
+    const warnings = allIssues.filter(i => i.severity === 'warning').length;
+    return {
+        url,
+        viewport,
+        timestamp: new Date().toISOString(),
+        summary: {
+            passed: totalPassed,
+            errors,
+            warnings,
+        },
+        issues: allIssues,
+    };
+}
+//# sourceMappingURL=runner.js.map

package/dist/runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner.js","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAO5D,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,IAAU,EACV,UAAyB,EAAE;IAE3B,MAAM,MAAM,GAAgB,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;IACjD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;IAEjE,gCAAgC;IAChC,IAAI,WAAoB,CAAC;IAEzB,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,sBAAsB;QACtB,WAAW,GAAG,OAAO,CAAC,MAAM;aACzB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;aAC/B,MAAM,CAAC,CAAC,CAAC,EAAc,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;IAChD,CAAC;SAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB,kDAAkD;QAClD,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAkC,CAAC;YAC3D,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC;YAC/C,OAAO,WAAW,KAAK,KAAK,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,iBAAiB;QACjB,WAAW,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED,iBAAiB;IACjB,MAAM,SAAS,GAAY,EAAE,CAAC;IAC9B,IAAI,WAAW,GAAG,CAAC,CAAC;IAEpB,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;YACjD,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YACjC,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,wBAAwB,KAAK,CAAC,IAAI,IAAI,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,6BAA6B;IAC7B,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;YAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,KAAqC,CAAC;YAC9D,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/B,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAE,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAED,oBAAoB;IACpB,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;IACpE,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;IAExE,OAAO;QACL,GAAG;QACH,QAAQ;QACR,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,OAAO,EAAE;YACP,MAAM,EAAE,WAAW;YACnB,MAAM;YACN,QAAQ;SACT;QACD,MAAM,EAAE,SAAS;KAClB,CAAC;AACJ,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,96 @@
+import type { Page } from 'puppeteer-core';
+export type Severity = 'error' | 'warning' | 'info';
+export interface ElementInfo {
+    selector: string;
+    tagName: string;
+    className: string;
+    id: string | null;
+    textContent: string | null;
+    rect: {
+        width: number;
+        height: number;
+        left: number;
+        top: number;
+        right: number;
+        bottom: number;
+    };
+}
+export interface Issue {
+    check: string;
+    severity: Severity;
+    message: string;
+    element: ElementInfo;
+    details: Record<string, unknown>;
+    fixHint?: string;
+}
+export interface CheckResult {
+    check: string;
+    passed: number;
+    issues: Issue[];
+}
+export interface CheckContext {
+    page: Page;
+    config: CheckConfig;
+}
+export interface Check {
+    name: string;
+    description: string;
+    run: (ctx: CheckContext) => Promise<CheckResult>;
+}
+export interface OverflowConfig {
+    horizontal?: boolean;
+    vertical?: boolean;
+    ignore?: string[];
+}
+export interface ClickabilityConfig {
+    selectors?: string[];
+    checkCorners?: boolean;
+    ignore?: string[];
+}
+export interface TouchTargetsConfig {
+    minWidth?: number;
+    minHeight?: number;
+    selectors?: string[];
+    ignore?: string[];
+}
+export interface TextOverflowConfig {
+    allowEllipsis?: boolean;
+    ignore?: string[];
+}
+export interface VisibilityConfig {
+    selectors?: string[];
+    ignore?: string[];
+}
+export interface ZIndexConfig {
+    maxAllowed?: number;
+    allowNegative?: boolean;
+    ignore?: string[];
+}
+export interface ChecksConfig {
+    overflow?: boolean | OverflowConfig;
+    clickability?: boolean | ClickabilityConfig;
+    touchTargets?: boolean | TouchTargetsConfig;
+    textOverflow?: boolean | TextOverflowConfig;
+    visibility?: boolean | VisibilityConfig;
+    zIndex?: boolean | ZIndexConfig;
+}
+export interface CheckConfig {
+    checks?: ChecksConfig;
+    ignore?: string[];
+    severity?: Partial<Record<keyof ChecksConfig, Severity>>;
+}
+export interface HealthResults {
+    url: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    timestamp: string;
+    summary: {
+        passed: number;
+        errors: number;
+        warnings: number;
+    };
+    issues: Issue[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;AAEpD,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,IAAI,CAAC;IACX,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CAClD;AAGD,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,OAAO,GAAG,cAAc,CAAC;IACpC,YAAY,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC5C,YAAY,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC5C,YAAY,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC5C,UAAU,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;IACxC,MAAM,CAAC,EAAE,OAAO,GAAG,YAAY,CAAC;CACjC;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC;CAC1D;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE;QACP,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB"}

package/dist/types.js

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

package/dist/types.js.map

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

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "rlint",
+  "version": "0.4.0",
+  "author": "yail259",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yail259/rlint.git"
+  },
+  "main": "./dist/index.js",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "chalk": "^5.3.0",
+    "chrome-launcher": "1.2.1",
+    "commander": "^12.0.0",
+    "puppeteer-core": "24.36.1"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.1.0",
+    "@types/node": "^20.11.0",
+    "typescript": "^5.3.3"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "rlint": "./dist/cli.js",
+    "rlint-mcp": "./dist/mcp-server.js"
+  },
+  "bugs": {
+    "url": "https://github.com/yail259/rlint/issues"
+  },
+  "description": "Catch rendered layout bugs automatically - no screenshots needed. Like ESLint for your rendered UI.",
+  "engines": {
+    "node": ">=18",
+    "bun": ">=1.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/yail259/rlint#readme",
+  "keywords": [
+    "css",
+    "testing",
+    "layout",
+    "overflow",
+    "accessibility",
+    "puppeteer",
+    "automation",
+    "visual-testing",
+    "lint",
+    "rlint",
+    "bun"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "bun test --timeout 30000",
+    "check": "bun src/cli.ts",
+    "mcp": "bun src/mcp-server.ts",
+    "prepublishOnly": "tsc"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts"
+}