@d-zero/a11y-check-core 0.2.0 → 0.4.0

package/dist/clean-results.d.ts

@@ -1,2 +1,6 @@
 import type { Violation } from './types.js';
+/**
+ *
+ * @param results
+ */
 export declare function cleanResults(results: readonly Violation[]): Violation[];

package/dist/clean-results.js

@@ -1,6 +1,10 @@
 import { hash } from '@d-zero/shared/hash';
 import { pathComparator } from '@d-zero/shared/sort/path';
 import { scNumberComparator } from './sc-number-comparator.js';
+/**
+ *
+ * @param results
+ */
 export function cleanResults(results) {
     const hashMap = new Map();
     for (const result of results) {

package/dist/color-contrast.d.ts

@@ -5,4 +5,8 @@ export declare enum ColorContrastError {
     FOREGROUND_COLOR_HAS_ALPHA = 2,
     BACKGROUND_COLOR_HAS_ALPHA = 3
 }
+/**
+ *
+ * @param style
+ */
 export declare function colorContrastCheck(style: Style): ColorContrastError | ColorContrast;

package/dist/color-contrast.js

@@ -9,6 +9,10 @@ export var ColorContrastError;
     ColorContrastError[ColorContrastError["FOREGROUND_COLOR_HAS_ALPHA"] = 2] = "FOREGROUND_COLOR_HAS_ALPHA";
     ColorContrastError[ColorContrastError["BACKGROUND_COLOR_HAS_ALPHA"] = 3] = "BACKGROUND_COLOR_HAS_ALPHA";
 })(ColorContrastError || (ColorContrastError = {}));
+/**
+ *
+ * @param style
+ */
 export function colorContrastCheck(style) {
     const foreground = colorFnToHex(style.color);
     if (!foreground) {

package/dist/color.d.ts

@@ -1,2 +1,6 @@
 import type { Color } from './types.js';
+/**
+ *
+ * @param colorFn
+ */
 export declare function colorFnToHex(colorFn: string | null): Color | null;

package/dist/color.js

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param colorFn
+ */
 export function colorFnToHex(colorFn) {
     if (!colorFn) {
         return null;

package/dist/create-scenario.d.ts

@@ -1,2 +1,6 @@
 import type { ScenarioCreator } from './types.js';
+/**
+ *
+ * @param creator
+ */
 export declare function createScenario<O>(creator: ScenarioCreator<O>): ScenarioCreator<O>;

package/dist/create-scenario.js

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param creator
+ */
 export function createScenario(creator) {
     return creator;
 }

package/dist/import-scenarios.d.ts

@@ -0,0 +1,6 @@
+import type { Scenario } from './types.js';
+/**
+ *
+ * @param scenarios
+ */
+export declare function importScenarios(scenarios: readonly [modulePath: string, options?: string][]): Promise<Scenario[]>;

package/dist/import-scenarios.js

@@ -0,0 +1,12 @@
+/**
+ *
+ * @param scenarios
+ */
+export async function importScenarios(scenarios) {
+    return await Promise.all(scenarios.map(async ([modulePath, options]) => {
+        const mod = await import(modulePath);
+        const creator = mod.default;
+        const optionsValue = options ? JSON.parse(options) : {};
+        return creator(optionsValue);
+    }));
+}

package/dist/index.d.ts

@@ -2,5 +2,6 @@ export { colorContrastCheck, ColorContrastError } from './color-contrast.js';
 export { colorFnToHex } from './color.js';
 export { createScenario } from './create-scenario.js';
 export { scNumberComparator } from './sc-number-comparator.js';
-export { scenarioRunner } from './scenario-runner.js';
+export { scenarioRunner } from './scenario-main-process.js';
+export { importScenarios } from './import-scenarios.js';
 export * from './types.js';

package/dist/index.js

@@ -2,5 +2,6 @@ export { colorContrastCheck, ColorContrastError } from './color-contrast.js';
 export { colorFnToHex } from './color.js';
 export { createScenario } from './create-scenario.js';
 export { scNumberComparator } from './sc-number-comparator.js';
-export { scenarioRunner } from './scenario-runner.js';
+export { scenarioRunner } from './scenario-main-process.js';
+export { importScenarios } from './import-scenarios.js';
 export * from './types.js';

package/dist/sc-number-comparator.d.ts

@@ -1 +1,6 @@
+/**
+ *
+ * @param a
+ * @param b
+ */
 export declare function scNumberComparator(a: string | null, b: string | null): number;

package/dist/sc-number-comparator.js

@@ -1,3 +1,8 @@
+/**
+ *
+ * @param a
+ * @param b
+ */
 export function scNumberComparator(a, b) {
     if (a === b) {
         return 0;

package/dist/scenario-child-process.d.ts

@@ -0,0 +1,4 @@
+export type ChildProcessParams = {
+    readonly scenarios: readonly [modulePath: string, options?: string][];
+    readonly cacheDir: string;
+};

package/dist/scenario-child-process.js

@@ -0,0 +1,64 @@
+import { importScenarios } from '@d-zero/a11y-check-core';
+import { createChildProcess } from '@d-zero/puppeteer-dealer';
+import { beforePageScan, defaultSizes, pageScanListener, } from '@d-zero/puppeteer-page-scan';
+import { Cache } from '@d-zero/shared/cache';
+import c from 'ansi-colors';
+createChildProcess(async (param) => {
+    const { cacheDir } = param;
+    const cache = new Cache('a11y-check/run-puppeteer', cacheDir);
+    const sizes = {
+        desktop: defaultSizes.desktop,
+        mobile: defaultSizes.mobile,
+    };
+    const scenarios = await importScenarios(param.scenarios);
+    return {
+        // async beforeOpenPage(_, url, logger) {
+        // 	if (options?.cache === false) {
+        // 		logger('Clearing cache');
+        // 		await cache.clear();
+        // 	}
+        // 	logger('Restoring cache');
+        // 	const cached = await cache.load(url, (key, value) => {
+        // 		if (key === 'timestamp') {
+        // 			return new Date(Date.parse(value));
+        // 		}
+        // 		return value;
+        // 	});
+        // 	if (cached) {
+        // 		logger('Hit cache, skipping page scan');
+        // 		await delay(600);
+        // 		needAnalysis.push(...cached.needAnalysis);
+        // 		passed.push(...cached.passed);
+        // 		violations.push(...cached.violations);
+        // 		return false;
+        // 	}
+        // 	return true;
+        // },
+        async eachPage({ page, url }, logger) {
+            const urlNeedAnalysis = [];
+            const urlPassed = [];
+            const urlViolations = [];
+            for (const [name, size] of Object.entries(sizes)) {
+                const sizeLabel = c.bgMagenta(` ${name} `);
+                for (const scenario of scenarios) {
+                    await beforePageScan(page, url, {
+                        name,
+                        ...size,
+                        listener: pageScanListener(logger),
+                    });
+                    const scenarioResult = await scenario.exec(page, name, (log) => logger(`${sizeLabel} ${log}`));
+                    urlNeedAnalysis.push(...(scenarioResult.needAnalysis ?? []));
+                    urlPassed.push(...(scenarioResult.passed ?? []));
+                    urlViolations.push(...(scenarioResult.violations ?? []));
+                }
+            }
+            const urlResults = {
+                needAnalysis: urlNeedAnalysis,
+                passed: urlPassed,
+                violations: urlViolations,
+            };
+            await cache.store(url, urlResults);
+            return urlResults;
+        },
+    };
+});

package/dist/scenario-main-process.d.ts

@@ -0,0 +1,11 @@
+import type { CoreOptions, Result, ScenarioRunnerOptions } from './types.js';
+/**
+ *
+ * @param urlList
+ * @param scenarios
+ * @param options
+ */
+export declare function scenarioRunner<O>(urlList: readonly (string | {
+    id: string | null;
+    url: string;
+})[], scenarios: readonly [modulePath: string, options?: string][], options?: O & CoreOptions & ScenarioRunnerOptions): Promise<Result>;

package/dist/scenario-main-process.js

@@ -0,0 +1,48 @@
+import path from 'node:path';
+import { importScenarios } from '@d-zero/a11y-check-core';
+import { createProcess, deal } from '@d-zero/puppeteer-dealer';
+import c from 'ansi-colors';
+import { cleanResults } from './clean-results.js';
+/**
+ *
+ * @param urlList
+ * @param scenarios
+ * @param options
+ */
+export async function scenarioRunner(urlList, scenarios, options) {
+    const needAnalysis = [];
+    const passed = [];
+    const violations = [];
+    await deal(urlList.map((url) => {
+        if (typeof url === 'string') {
+            return { id: null, url };
+        }
+        return url;
+    }), (_, done, total) => {
+        return `${c.bold.magenta('🧿 A11y checking%dots%')} ${done}/${total}`;
+    }, () => {
+        return createProcess(path.resolve(import.meta.dirname, 'scenario-child-process.js'), {
+            scenarios,
+            cacheDir: options?.cacheDir ?? '.a11y-check-core',
+        }, options);
+    }, (result) => {
+        needAnalysis.push(...result.needAnalysis);
+        passed.push(...result.passed);
+        violations.push(...result.violations);
+    });
+    const cleanedViolations = cleanResults(violations);
+    process.stdout.write(`📊 Found ${cleanedViolations.length} violations\n`);
+    const scenarioModules = await importScenarios(scenarios);
+    for (const scenario of scenarioModules) {
+        const targets = needAnalysis.filter((result) => result.scenarioId === scenario.id);
+        if (targets.length === 0) {
+            continue;
+        }
+        await scenario.analyze?.(targets, (log) => process.stdout.write(`${log}\n`));
+    }
+    return {
+        needAnalysis: needAnalysis,
+        passed: passed,
+        violations: cleanedViolations,
+    };
+}

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 import type { DealOptions } from '@d-zero/dealer';
-import type { Page } from '@d-zero/puppeteer-page';
 import type { PageHook } from '@d-zero/puppeteer-page-scan';
+import type { Page } from 'puppeteer';
 export type CoreOptions = {
     readonly screenshot?: boolean;
     readonly cache?: boolean;
@@ -12,10 +12,10 @@ export type ScenarioRunnerOptions = DealOptions & {
 };
 export type ScenarioCreator<O> = (options?: O) => Scenario;
 export type Scenario = {
-    id: string;
-    config?: {};
-    exec: ScenarioExecutor;
-    analyze?: ScenarioAnalyzer;
+    readonly modulePath: string;
+    readonly id: string;
+    readonly exec: ScenarioExecutor;
+    readonly analyze?: ScenarioAnalyzer;
 };
 export type ScenarioExecutor = (page: Page, sizeName: string, log: (log: string) => void) => Promise<Partial<Result>>;
 export type ScenarioAnalyzer = (results: NeedAnalysis[], log: (log: string) => void) => Promise<void | Partial<Result>> | void | Partial<Result>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/a11y-check-core",
-	"version": "0.2.0",
+	"version": "0.4.0",
 	"description": "Accessibility Checker (Core Module)",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -24,15 +24,15 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/puppeteer-dealer": "0.2.0",
-		"@d-zero/shared": "0.6.0",
+		"@d-zero/puppeteer-dealer": "0.4.0",
+		"@d-zero/shared": "0.8.0",
 		"ansi-colors": "4.1.3",
-		"color-contrast-checker": "2.1.0"
+		"color-contrast-checker": "2.1.0",
+		"puppeteer": "24.9.0"
 	},
 	"devDependencies": {
-		"@d-zero/dealer": "1.2.0",
-		"@d-zero/puppeteer-page": "0.2.0",
-		"@d-zero/puppeteer-page-scan": "2.0.0"
+		"@d-zero/dealer": "1.3.1",
+		"@d-zero/puppeteer-page-scan": "4.0.0"
 	},
-	"gitHead": "1eb1c03400580040119121e11ffb33acd876fe1b"
+	"gitHead": "4e9cc7b87e0fef91b6f2d4edfb66ca9134b2491b"
 }

package/dist/color-contrast.spec.d.ts

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

package/dist/color-contrast.spec.js

@@ -1,41 +0,0 @@
-import { test, expect } from 'vitest';
-import { colorContrastCheck, ColorContrastError } from './color-contrast.js';
-test('#000 vs #FFF', () => {
-    expect(colorContrastCheck({
-        color: 'rgb(0, 0, 0)',
-        backgroundColor: 'rgb(255, 255, 255)',
-        backgroundImage: '',
-        closestBackgroundColor: null,
-        closestBackgroundImage: null,
-    })).toStrictEqual({
-        foreground: {
-            a: 1,
-            b: 0,
-            g: 0,
-            hex: '#000000',
-            hexA: '#000000FF',
-            r: 0,
-        },
-        background: {
-            a: 1,
-            b: 255,
-            g: 255,
-            hex: '#FFFFFF',
-            hexA: '#FFFFFFFF',
-            r: 255,
-        },
-        ratio: 21,
-        ratioText: '21:1',
-        AA: true,
-        AAA: true,
-    });
-});
-test('has alpha channel', () => {
-    expect(colorContrastCheck({
-        color: 'rgba(0, 0, 0, 0.5)',
-        backgroundColor: 'rgb(255, 255, 255)',
-        backgroundImage: '',
-        closestBackgroundColor: null,
-        closestBackgroundImage: null,
-    })).toBe(ColorContrastError.FOREGROUND_COLOR_HAS_ALPHA);
-});

package/dist/sc-number-comparator.spec.d.ts

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

package/dist/sc-number-comparator.spec.js

@@ -1,21 +0,0 @@
-import { test, expect } from 'vitest';
-import { scNumberComparator } from './sc-number-comparator.js';
-test('scNumberComparator', () => {
-    expect([
-        //
-        '1.2.3',
-        '1.1.1',
-        '1.2.1',
-        '1.1.2',
-        null,
-        '1.1.3',
-    ].toSorted(scNumberComparator)).toStrictEqual([
-        //
-        '1.1.1',
-        '1.1.2',
-        '1.1.3',
-        '1.2.1',
-        '1.2.3',
-        null,
-    ]);
-});

package/dist/scenario-runner.d.ts

@@ -1,5 +0,0 @@
-import type { CoreOptions, Result, Scenario, ScenarioRunnerOptions } from './types.js';
-export declare function scenarioRunner<O>(urlList: readonly (string | {
-    id: string | null;
-    url: string;
-})[], scenarios: readonly Scenario[], options?: O & CoreOptions & ScenarioRunnerOptions): Promise<Result>;

package/dist/scenario-runner.js

@@ -1,91 +0,0 @@
-import { deal } from '@d-zero/puppeteer-dealer';
-import { beforePageScan, defaultSizes, pageScanListener, } from '@d-zero/puppeteer-page-scan';
-import { Cache } from '@d-zero/shared/cache';
-import { delay } from '@d-zero/shared/delay';
-import c from 'ansi-colors';
-import { cleanResults } from './clean-results.js';
-export async function scenarioRunner(urlList, scenarios, options) {
-    const cache = new Cache('a11y-check/run-puppeteer', options?.cacheDir);
-    const hooks = options?.hooks;
-    const sizes = {
-        desktop: defaultSizes.desktop,
-        mobile: defaultSizes.mobile,
-    };
-    const needAnalysis = [];
-    const passed = [];
-    const violations = [];
-    await deal(urlList.map((url) => {
-        if (typeof url === 'string') {
-            return { id: null, url };
-        }
-        return url;
-    }), (_, done, total) => {
-        return `${c.bold.magenta('🧿 A11y checking%dots%')} ${done}/${total}`;
-    }, {
-        async beforeOpenPage(_, url, logger) {
-            if (options?.cache === false) {
-                logger('Clearing cache');
-                await cache.clear();
-            }
-            logger('Restoring cache');
-            const cached = await cache.load(url, (key, value) => {
-                if (key === 'timestamp') {
-                    return new Date(Date.parse(value));
-                }
-                return value;
-            });
-            if (cached) {
-                logger('Hit cache, skipping page scan');
-                await delay(600);
-                needAnalysis.push(...cached.needAnalysis);
-                passed.push(...cached.passed);
-                violations.push(...cached.violations);
-                return false;
-            }
-            return true;
-        },
-        async deal(page, _, url, logger) {
-            const urlNeedAnalysis = [];
-            const urlPassed = [];
-            const urlViolations = [];
-            for (const [name, size] of Object.entries(sizes)) {
-                const sizeLabel = c.bgMagenta(` ${name} `);
-                for (const scenario of scenarios) {
-                    await beforePageScan(page, url, {
-                        name,
-                        ...size,
-                        hooks,
-                        listener: pageScanListener(logger),
-                    });
-                    const scenarioResult = await scenario.exec(page, name, (log) => logger(`${sizeLabel} ${log}`));
-                    urlNeedAnalysis.push(...(scenarioResult.needAnalysis ?? []));
-                    urlPassed.push(...(scenarioResult.passed ?? []));
-                    urlViolations.push(...(scenarioResult.violations ?? []));
-                }
-            }
-            const urlResults = {
-                needAnalysis: urlNeedAnalysis,
-                passed: urlPassed,
-                violations: urlViolations,
-            };
-            await cache.store(url, urlResults);
-            needAnalysis.push(...urlNeedAnalysis);
-            passed.push(...urlPassed);
-            violations.push(...urlViolations);
-        },
-    }, options);
-    const cleanedViolations = cleanResults(violations);
-    process.stdout.write(`📊 Found ${cleanedViolations.length} violations\n`);
-    for (const scenario of scenarios) {
-        const targets = needAnalysis.filter((result) => result.scenarioId === scenario.id);
-        if (targets.length === 0) {
-            continue;
-        }
-        await scenario.analyze?.(targets, (log) => process.stdout.write(`${log}\n`));
-    }
-    return {
-        needAnalysis: needAnalysis,
-        passed: passed,
-        violations: cleanedViolations,
-    };
-}