@diegovelasquezweb/a11y-engine 0.3.1 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diegovelasquezweb/a11y-engine",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "WCAG 2.2 AA accessibility audit engine — scanner, analyzer, and report builders",
   "type": "module",
   "license": "MIT",
@@ -14,27 +14,30 @@
   },
   "exports": {
     ".": {
-      "types": "./scripts/index.d.mts",
-      "default": "./scripts/index.mjs"
+      "types": "./src/index.d.mts",
+      "default": "./src/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "main": "scripts/index.mjs",
-  "types": "scripts/index.d.mts",
+  "main": "src/index.mjs",
+  "types": "src/index.d.mts",
   "bin": {
-    "a11y-audit": "scripts/audit.mjs"
+    "a11y-audit": "src/cli/audit.mjs"
   },
   "files": [
-    "scripts/**",
-    "assets/**",
+    "src/**",
+    "assets/source/**",
+    "assets/generated/**",
     "docs/**",
+    "scripts/sync-assets.mjs",
     "README.md",
     "CHANGELOG.md",
     "LICENSE"
   ],
   "scripts": {
+    "sync-assets": "node scripts/sync-assets.mjs",
     "test": "vitest run",
-    "prepublishOnly": "node -e \"console.log('Publishing @diegovelasquezweb/a11y-engine...')\""
+    "prepublishOnly": "node scripts/sync-assets.mjs"
   },
   "dependencies": {
     "@axe-core/playwright": "^4.11.1",

package/scripts/sync-assets.mjs

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+/**
+ * sync-assets.mjs
+ * Generates assets/generated/**\/*.mjs from assets/source/**\/*.json.
+ * Run: node scripts/sync-assets.mjs
+ * Hooked automatically in prepublishOnly.
+ */
+
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const ROOT = path.resolve(__dirname, "..");
+const SOURCE_DIR = path.join(ROOT, "assets", "source");
+const GENERATED_DIR = path.join(ROOT, "assets", "generated");
+
+let synced = 0;
+let skipped = 0;
+
+function syncDir(sourceDir, generatedDir) {
+  fs.mkdirSync(generatedDir, { recursive: true });
+
+  for (const entry of fs.readdirSync(sourceDir, { withFileTypes: true })) {
+    const sourcePath = path.join(sourceDir, entry.name);
+    const generatedPath = path.join(generatedDir, entry.name);
+
+    if (entry.isDirectory()) {
+      syncDir(sourcePath, path.join(generatedDir, entry.name));
+      continue;
+    }
+
+    if (!entry.name.endsWith(".json")) {
+      skipped++;
+      continue;
+    }
+
+    const mjsName = entry.name.replace(/\.json$/, ".mjs");
+    const mjsPath = path.join(generatedDir, mjsName);
+
+    let data;
+    try {
+      data = JSON.parse(fs.readFileSync(sourcePath, "utf-8"));
+    } catch (err) {
+      console.error(`  [ERROR] Failed to parse ${sourcePath}: ${err.message}`);
+      process.exit(1);
+    }
+
+    const content = `export default ${JSON.stringify(data)};\n`;
+
+    // Only write if content changed (avoid unnecessary fs writes)
+    let existing = null;
+    try { existing = fs.readFileSync(mjsPath, "utf-8"); } catch { /* new file */ }
+
+    if (existing !== content) {
+      fs.writeFileSync(mjsPath, content, "utf-8");
+      console.log(`  synced: ${path.relative(ROOT, mjsPath)}`);
+      synced++;
+    } else {
+      skipped++;
+    }
+  }
+}
+
+console.log("Syncing assets/source/*.json → assets/generated/*.mjs");
+syncDir(SOURCE_DIR, GENERATED_DIR);
+console.log(`Done. ${synced} file(s) written, ${skipped} unchanged/skipped.`);

package/{scripts → src/cli}/audit.mjs

@@ -10,7 +10,7 @@ import { spawn, execSync } from "node:child_process";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import fs from "node:fs";
-import { log, DEFAULTS, SKILL_ROOT, getInternalPath } from "./core/utils.mjs";
+import { log, DEFAULTS, SKILL_ROOT, getInternalPath } from "../core/utils.mjs";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -205,7 +205,7 @@ async function main() {
       log.success("Dependencies ready.");
     }
 
-    await runScript("core/toolchain.mjs");
+    await runScript("../core/toolchain.mjs");
 
     const screenshotsDir = getInternalPath("screenshots");
     fs.rmSync(screenshotsDir, { recursive: true, force: true });
@@ -258,12 +258,12 @@ async function main() {
     }
     if (axeTags) scanArgs.push("--axe-tags", axeTags);
 
-    await runScript("engine/dom-scanner.mjs", scanArgs, childEnv);
+    await runScript("../pipeline/dom-scanner.mjs", scanArgs, childEnv);
 
     const analyzerArgs = [];
     if (ignoreFindings) analyzerArgs.push("--ignore-findings", ignoreFindings);
     if (framework) analyzerArgs.push("--framework", framework);
-    await runScript("engine/analyzer.mjs", analyzerArgs);
+    await runScript("../enrichment/analyzer.mjs", analyzerArgs);
 
     if (projectDir && !skipPatterns) {
       const patternArgs = ["--project-dir", path.resolve(projectDir)];
@@ -275,7 +275,7 @@ async function main() {
         } catch { /* ignore */ }
       }
       if (resolvedFramework) patternArgs.push("--framework", resolvedFramework);
-      await runScript("engine/source-scanner.mjs", patternArgs);
+      await runScript("../source-patterns/source-scanner.mjs", patternArgs);
     }
 
     const mdOutput = getInternalPath("remediation.md");
@@ -283,7 +283,7 @@ async function main() {
     if (target) mdArgs.push("--target", target);
 
     if (skipReports) {
-      await runScript("reports/builders/md.mjs", mdArgs);
+      await runScript("../reports/md.mjs", mdArgs);
     } else {
       const output = getArgValue("output");
       if (!output) {
@@ -307,10 +307,10 @@ async function main() {
       const checklistArgs = ["--output", checklistOutput, "--base-url", baseUrl];
 
       await Promise.all([
-        runScript("reports/builders/html.mjs", buildArgs),
-        runScript("reports/builders/checklist.mjs", checklistArgs),
-        runScript("reports/builders/md.mjs", mdArgs),
-        runScript("reports/builders/pdf.mjs", pdfArgs),
+        runScript("../reports/html.mjs", buildArgs),
+        runScript("../reports/checklist.mjs", checklistArgs),
+        runScript("../reports/md.mjs", mdArgs),
+        runScript("../reports/pdf.mjs", pdfArgs),
       ]);
 
       console.log(`REPORT_PATH=${absoluteOutputPath}`);

package/{scripts → src}/core/asset-loader.mjs

@@ -5,18 +5,18 @@
  * This ensures bundlers (Turbopack, Webpack) can trace them automatically.
  */
 
-import crawlerConfig from "../../assets/discovery/crawler-config.mjs";
-import stackDetection from "../../assets/discovery/stack-detection.mjs";
-import cdpChecks from "../../assets/engine/cdp-checks.mjs";
-import pa11yConfig from "../../assets/engine/pa11y-config.mjs";
-import axeCheckMaps from "../../assets/remediation/axe-check-maps.mjs";
-import codePatterns from "../../assets/remediation/code-patterns.mjs";
-import guardrails from "../../assets/remediation/guardrails.mjs";
-import intelligence from "../../assets/remediation/intelligence.mjs";
-import sourceBoundaries from "../../assets/remediation/source-boundaries.mjs";
-import complianceConfig from "../../assets/reporting/compliance-config.mjs";
-import manualChecks from "../../assets/reporting/manual-checks.mjs";
-import wcagReference from "../../assets/reporting/wcag-reference.mjs";
+import crawlerConfig from "../../assets/generated/discovery/crawler-config.mjs";
+import stackDetection from "../../assets/generated/discovery/stack-detection.mjs";
+import cdpChecks from "../../assets/generated/engine/cdp-checks.mjs";
+import pa11yConfig from "../../assets/generated/engine/pa11y-config.mjs";
+import axeCheckMaps from "../../assets/generated/remediation/axe-check-maps.mjs";
+import codePatterns from "../../assets/generated/remediation/code-patterns.mjs";
+import guardrails from "../../assets/generated/remediation/guardrails.mjs";
+import intelligence from "../../assets/generated/remediation/intelligence.mjs";
+import sourceBoundaries from "../../assets/generated/remediation/source-boundaries.mjs";
+import complianceConfig from "../../assets/generated/reporting/compliance-config.mjs";
+import manualChecks from "../../assets/generated/reporting/manual-checks.mjs";
+import wcagReference from "../../assets/generated/reporting/wcag-reference.mjs";
 
 /**
  * Pre-loaded asset map. Each value is the parsed JSON object, ready to use.

package/{scripts → src}/index.mjs

@@ -457,8 +457,8 @@ export function getAuditSummary(findings, payload = null) {
 export async function runAudit(options) {
   if (!options.baseUrl) throw new Error("runAudit requires baseUrl");
 
-  const { runDomScanner } = await import("./engine/dom-scanner.mjs");
-  const { runAnalyzer } = await import("./engine/analyzer.mjs");
+  const { runDomScanner } = await import("./pipeline/dom-scanner.mjs");
+  const { runAnalyzer } = await import("./enrichment/analyzer.mjs");
 
   const onProgress = options.onProgress || null;
 
@@ -497,7 +497,7 @@ export async function runAudit(options) {
   // Step 3: Source patterns (optional)
   if (options.projectDir && !options.skipPatterns) {
     try {
-      const { resolveScanDirs, scanPattern } = await import("./engine/source-scanner.mjs");
+      const { resolveScanDirs, scanPattern } = await import("./source-patterns/source-scanner.mjs");
       const { patterns } = loadAssetJson(ASSET_PATHS.remediation.codePatterns, "code-patterns.json");
 
       let resolvedFramework = options.framework;
@@ -893,7 +893,7 @@ export async function getRemediationGuide(payload, options = {}) {
  * @returns {Promise<{ findings: object[], summary: { total: number, confirmed: number, potential: number } }>}
  */
 export async function getSourcePatterns(projectDir, options = {}) {
-  const { scanPattern, resolveScanDirs } = await import("./engine/source-scanner.mjs");
+  const { scanPattern, resolveScanDirs } = await import("./source-patterns/source-scanner.mjs");
 
   const { patterns } = loadAssetJson(ASSET_PATHS.remediation.codePatterns, "code-patterns.json");