@cleaver/breakcheck-core 0.2.5 → 0.3.0

package/dist/types/compare.d.ts

@@ -2,9 +2,12 @@
 import { Change } from "diff";
 /**
  * Represents a single difference found between two page snapshots
- * This is equivalent to the Change type from the diff package
+ * This retains the optional change flags exposed by earlier diff releases.
  */
-export type LineDiff = Change;
+export type LineDiff = Omit<Change, "added" | "removed"> & {
+    added?: boolean;
+    removed?: boolean;
+};
 /**
  * Represents the complete diff result for a single page
  */

package/dist/types/config.d.ts

@@ -0,0 +1,72 @@
+import type { CrawlerType } from "./api.js";
+/** The supported project configuration schema versions. */
+export type ProjectConfigVersion = 1 | 2;
+/** Crawl defaults that may be persisted in a project configuration file. */
+export interface ProjectCrawlConfig {
+    crawlerType?: CrawlerType;
+    maxDepth?: number;
+    maxConcurrency?: number;
+    includePatterns?: string[];
+    excludePatterns?: string[];
+}
+/** Comparison defaults that may be persisted in a project configuration file. */
+export interface ProjectComparisonConfig {
+    rulesDir?: string;
+}
+/** A command passed to Node's process launcher without shell interpretation. */
+export type ProjectCommand = string[];
+/** Local site lifecycle settings for `breakcheck check`. */
+export interface ProjectCheckServerConfig {
+    start: ProjectCommand;
+    stop?: ProjectCommand;
+    cwd?: string;
+    env?: Record<string, string>;
+    readyPath?: string;
+    timeoutMs?: number;
+}
+/** Settings for a repeatable exact-route regression check. */
+export interface ProjectCheckConfig {
+    routesFile: string;
+    baselineSnapshot: string;
+    prepare?: ProjectCommand[];
+    server?: ProjectCheckServerConfig;
+    reportDir?: string;
+}
+/** The JSON shape accepted by `breakcheck.config.json`. */
+export interface ProjectConfig {
+    version: ProjectConfigVersion;
+    baseUrl?: string;
+    storageDir?: string;
+    crawl?: ProjectCrawlConfig;
+    comparison?: ProjectComparisonConfig;
+    check?: ProjectCheckConfig;
+}
+/** A validated project configuration together with the file that supplied it. */
+export interface LoadedProjectConfig {
+    configPath: string;
+    config: ProjectConfig;
+}
+/** Options controlling explicit configuration selection and discovery. */
+export interface ProjectConfigLoadOptions {
+    cwd?: string;
+    configPath?: string;
+    noConfig?: boolean;
+}
+/** A validated configuration with paths resolved for downstream operations. */
+export interface ResolvedProjectConfig {
+    configPath?: string;
+    storageDir: string;
+    baseUrl?: string;
+    crawl: ProjectCrawlConfig;
+    rulesDir?: string;
+    check?: ResolvedProjectCheckConfig;
+}
+/** Check configuration with filesystem paths resolved from the config file. */
+export interface ResolvedProjectCheckConfig extends Omit<ProjectCheckConfig, "routesFile" | "reportDir" | "server"> {
+    configDirectory: string;
+    routesFile: string;
+    reportDir: string;
+    server?: Omit<ProjectCheckServerConfig, "cwd"> & {
+        cwd: string;
+    };
+}

package/dist/types/config.js

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

package/dist/types/config.js.map

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

package/dist/types/rules.d.ts

@@ -72,11 +72,16 @@ export interface Region {
     name: string;
 }
 /**
- * The root structure of the JSON rules document
+ * The serialized JSON document produced from the rules DSL.
  */
-export interface Ruleset {
-    name: string;
+export interface RulesDocument {
     rules: Rule[];
     /** Named regions are optional for backwards-compatible inline rulesets. */
     regions?: Region[];
 }
+/**
+ * A named runtime ruleset used by comparisons.
+ */
+export interface Ruleset extends RulesDocument {
+    name: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cleaver/breakcheck-core",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "type": "module",
   "engines": {
     "node": ">=22"
@@ -32,16 +32,17 @@
     "dev": "tsc -w"
   },
   "dependencies": {
-    "cheerio": "1.0.0-rc.12",
+    "cheerio": "^1.2.0",
     "chevrotain": "^13.2.0",
-    "crawlee": "^3.18.1",
-    "diff": "^5.2.2",
+    "crawlee": "^3.18.2",
+    "diff": "^9.0.0",
     "diff2html": "^3.4.56",
-    "express": "^5.2.1",
-    "find-up": "^7.0.0",
-    "js-beautify": "^1.15.4",
-    "pino": "^9.14.0",
-    "pino-pretty": "^11.2.1",
-    "playwright": "^1.62.1"
+    "domhandler": "^5.0.3",
+    "express": "^5.3.0",
+    "find-up": "^8.0.0",
+    "js-beautify": "^2.0.3",
+    "pino": "^10.4.0",
+    "pino-pretty": "^13.2.0",
+    "playwright": "^1.64.0"
   }
 }