@octaviaflow/accessibility-checker 1.0.0

package/README.md

@@ -0,0 +1,94 @@
+# Accessibility Checker
+
+## Overview
+
+Accessibility Checker is a JavaScript project designed to help developers ensure that their web content meets accessibility standards. This tool provides functionalities to check and validate the accessibility of web pages.
+
+## Features
+
+- Core functionality for accessibility checking.
+- Utility functions to support main functionalities.
+- Unit tests to ensure reliability and correctness.
+
+## Installation
+
+To install the project, clone the repository and run the following command in the project directory:
+
+```
+npm install
+```
+
+## Usage
+
+To use the accessibility checker, you can run the main entry point:
+
+```
+node src/index.js
+```
+
+## Running Tests
+
+To run the unit tests, use the following command:
+
+```
+npm test
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a pull request or open an issue for any enhancements or bug fixes.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for more details.
+
+### octaviaflow - Local Accessibility Checker
+
+Usage:
+
+- node src/index.js --input path/to/file.html
+- node src/index.js --sample
+- Optional: --output path/to/results.json (defaults to ./data/results.json)
+
+Behavior:
+
+- Performs lightweight accessibility heuristics (images missing alt, empty links, empty headings).
+- Stores results as an array in the output JSON file (suitable for future import to MongoDB).
+- No IBM telemetry or IBM/carbon dependencies included.
+
+### octaviaflow - Local Accessibility Checker (TypeScript)
+
+Quick start:
+
+1. Install deps:
+
+   cd accessibility-checker
+   npm install
+
+2. Build:
+
+   npm run build
+
+3. Run:
+
+   node ./cjs/index.js --sample
+   or
+   octaviaflow --input path/to/file.html --output ./data/results.json
+
+What changed:
+
+- Converted to TypeScript.
+- Uses axe-core + heuristics for more complete checks.
+- Stores results locally as an array in JSON (ready for importing to MongoDB).
+- No IBM telemetry or Carbon packages included.
+
+Testing:
+
+- npm test (uses vitest)
+
+Build outputs:
+
+- cjs/ CommonJS build (cjs/index.js)
+- mjs/ ES module build (mjs/index.js)
+- types/ TypeScript declaration files
+- bin/ CLI shim (bin/octaviaflow.js)

package/bin/achecker.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+// simple shim that delegates to the CommonJS build
+try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const mod = require('../cjs/index.js');
+    if (mod && typeof mod.main === 'function') {
+        mod.main(process.argv.slice(2)).catch((e) => {
+            console.error('Error:', e);
+            process.exit(2);
+        });
+    } else {
+        console.error('octaviaflow entrypoint missing');
+        process.exit(1);
+    }
+} catch (e) {
+    console.error('Failed to start octaviaflow:', e);
+    process.exit(2);
+}

package/cjs/checker/index.js

@@ -0,0 +1,130 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyze = analyze;
+const jsdom_1 = require("jsdom");
+const axe = __importStar(require("axe-core"));
+function heuristicAnalyze(html) {
+    const issues = [];
+    // images without alt
+    const imgRegex = /<img\b[^>]*>/gi;
+    let m;
+    while ((m = imgRegex.exec(html))) {
+        const tag = m[0];
+        if (!/alt\s*=\s*["'][^"']*["']/i.test(tag)) {
+            issues.push({
+                type: 'image-missing-alt',
+                message: 'Image tag missing alt attribute',
+                snippet: tag,
+            });
+        }
+    }
+    // links without descriptive text (naive)
+    const aRegex = /<a\b[^>]*>([\s\S]*?)<\/a>/gi;
+    while ((m = aRegex.exec(html))) {
+        const inner = (m[1] || '').trim();
+        if (!inner || /^<img\b/i.test(inner) || inner.length === 0) {
+            issues.push({
+                type: 'link-empty',
+                message: 'Link has no accessible text',
+                snippet: m[0],
+            });
+        }
+    }
+    // empty headings
+    const hRegex = /<h[1-6][^>]*>([\s\S]*?)<\/h[1-6]>/gi;
+    while ((m = hRegex.exec(html))) {
+        const content = (m[1] || '').replace(/<[^>]*>/g, '').trim();
+        if (!content) {
+            issues.push({
+                type: 'heading-empty',
+                message: 'Heading tag is empty',
+                snippet: m[0],
+            });
+        }
+    }
+    return issues;
+}
+async function runAxe(html) {
+    const dom = new jsdom_1.JSDOM(html, {
+        runScripts: 'dangerously',
+        resources: 'usable',
+    });
+    const { window } = dom;
+    // axe.run expects document; pass document
+    const result = await axe.run(window.document, {
+    // default rules; you can customize here
+    });
+    return result;
+}
+async function analyze(html) {
+    const heuristics = heuristicAnalyze(html);
+    let axeRes = null;
+    try {
+        axeRes = await runAxe(html);
+    }
+    catch (e) {
+        // If axe fails for some HTML, continue with heuristics
+        axeRes = { error: String(e) };
+    }
+    const axeIssues = [];
+    if (axeRes && Array.isArray(axeRes.violations)) {
+        for (const v of axeRes.violations) {
+            for (const node of v.nodes || []) {
+                axeIssues.push({
+                    type: `axe:${v.id}`,
+                    message: v.description || v.help,
+                    snippet: node.html,
+                    helpUrl: v.helpUrl,
+                    source: 'axe',
+                });
+            }
+        }
+    }
+    const combined = heuristics.concat(axeIssues);
+    const byType = {};
+    for (const it of combined) {
+        byType[it.type] = (byType[it.type] || 0) + 1;
+    }
+    return {
+        summary: {
+            totalIssues: combined.length,
+            byType,
+            axeViolations: axeIssues.length,
+        },
+        issues: combined,
+        axe: axeRes,
+    };
+}

package/mjs/checker/index.js

@@ -0,0 +1,94 @@
+import { JSDOM } from 'jsdom';
+import * as axe from 'axe-core';
+function heuristicAnalyze(html) {
+    const issues = [];
+    // images without alt
+    const imgRegex = /<img\b[^>]*>/gi;
+    let m;
+    while ((m = imgRegex.exec(html))) {
+        const tag = m[0];
+        if (!/alt\s*=\s*["'][^"']*["']/i.test(tag)) {
+            issues.push({
+                type: 'image-missing-alt',
+                message: 'Image tag missing alt attribute',
+                snippet: tag,
+            });
+        }
+    }
+    // links without descriptive text (naive)
+    const aRegex = /<a\b[^>]*>([\s\S]*?)<\/a>/gi;
+    while ((m = aRegex.exec(html))) {
+        const inner = (m[1] || '').trim();
+        if (!inner || /^<img\b/i.test(inner) || inner.length === 0) {
+            issues.push({
+                type: 'link-empty',
+                message: 'Link has no accessible text',
+                snippet: m[0],
+            });
+        }
+    }
+    // empty headings
+    const hRegex = /<h[1-6][^>]*>([\s\S]*?)<\/h[1-6]>/gi;
+    while ((m = hRegex.exec(html))) {
+        const content = (m[1] || '').replace(/<[^>]*>/g, '').trim();
+        if (!content) {
+            issues.push({
+                type: 'heading-empty',
+                message: 'Heading tag is empty',
+                snippet: m[0],
+            });
+        }
+    }
+    return issues;
+}
+async function runAxe(html) {
+    const dom = new JSDOM(html, {
+        runScripts: 'dangerously',
+        resources: 'usable',
+    });
+    const { window } = dom;
+    // axe.run expects document; pass document
+    const result = await axe.run(window.document, {
+    // default rules; you can customize here
+    });
+    return result;
+}
+export async function analyze(html) {
+    const heuristics = heuristicAnalyze(html);
+    let axeRes = null;
+    try {
+        axeRes = await runAxe(html);
+    }
+    catch (e) {
+        // If axe fails for some HTML, continue with heuristics
+        axeRes = { error: String(e) };
+    }
+    const axeIssues = [];
+    if (axeRes && Array.isArray(axeRes.violations)) {
+        for (const v of axeRes.violations) {
+            for (const node of v.nodes || []) {
+                axeIssues.push({
+                    type: `axe:${v.id}`,
+                    message: v.description || v.help,
+                    snippet: node.html,
+                    helpUrl: v.helpUrl,
+                    source: 'axe',
+                });
+            }
+        }
+    }
+    const combined = heuristics.concat(axeIssues);
+    const byType = {};
+    for (const it of combined) {
+        byType[it.type] = (byType[it.type] || 0) + 1;
+    }
+    return {
+        summary: {
+            totalIssues: combined.length,
+            byType,
+            axeViolations: axeIssues.length,
+        },
+        issues: combined,
+        axe: axeRes,
+    };
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@octaviaflow/accessibility-checker",
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "description": "Accessibility checker for OctaviaFlow Design System - A custom implementation",
+  "main": "cjs/index.js",
+  "module": "mjs/index.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./mjs/index.js",
+      "require": "./cjs/index.js",
+      "types": "./types/index.d.ts"
+    }
+  },
+  "files": [
+    "cjs",
+    "mjs",
+    "types",
+    "bin"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OctaviaFlow/OctaviaFlow-Design-System.git",
+    "directory": "packages/accessibility-checker"
+  },
+  "bugs": "https://github.com/OctaviaFlow/OctaviaFlow-Design-System/issues",
+  "scripts": {
+    "clean": "rimraf cjs mjs types",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:mjs": "tsc -p tsconfig.mjs.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build": "yarn clean && yarn build:cjs && yarn build:mjs && yarn build:types",
+    "test": "vitest",
+    "ci-check": "yarn build && yarn test",
+    "start": "node ./cjs/index.js --sample"
+  },
+  "keywords": [
+    "octaviaflow",
+    "octaviaflow-design-system",
+    "accessibility",
+    "checker",
+    "web",
+    "a11y"
+  ],
+  "author": "OctaviaFlow",
+  "dependencies": {
+    "axe-core": "^4.11.0",
+    "chromedriver": "*",
+    "deep-diff": "^1.0.2",
+    "exceljs": "^4.3.0",
+    "js-yaml": "^4.1.0",
+    "jsdom": "^27.1.0",
+    "puppeteer": "^24.29.1",
+    "string-hash": "^1.1.3"
+  },
+  "devDependencies": {
+    "@types/jsdom": "^27.0.0",
+    "@types/node": "^24.10.0",
+    "eslint": "^9.31.1",
+    "jest": "^30.2.0",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.8"
+  },
+  "bin": {
+    "octaviaflow-achecker": "bin/achecker.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/types/checker/index.d.ts

@@ -0,0 +1,18 @@
+export type Issue = {
+    type: string;
+    message: string;
+    snippet?: string;
+    helpUrl?: string;
+    source?: string;
+};
+export type Result = {
+    summary: {
+        totalIssues: number;
+        byType: Record<string, number>;
+        axeViolations?: number;
+    };
+    issues: Issue[];
+    axe?: any;
+    meta?: any;
+};
+export declare function analyze(html: string): Promise<Result>;