@d-zero/a11y-check 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 D-ZERO Co., Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# `@d-zero/a11y-check`

package/dist/a11y-check.d.ts

@@ -0,0 +1,11 @@
+import type { A11yCheckOptions } from './types.js';
+/**
+ *
+ * @param urlList
+ * @param out
+ * @param options
+ */
+export declare function a11yCheck(urlList: readonly (string | {
+    id: string | null;
+    url: string;
+})[], out?: string, options?: A11yCheckOptions): Promise<void>;

package/dist/a11y-check.js

@@ -0,0 +1,43 @@
+import { scenarioAxe } from '@d-zero/a11y-check-axe-scenario';
+import { scenarioRunner } from '@d-zero/a11y-check-core';
+import { scenario01, scenario02 } from '@d-zero/a11y-check-scenarios';
+import dayjs from 'dayjs';
+import { SpreadsheetReporter } from './spreadsheet.js';
+/**
+ *
+ * @param urlList
+ * @param out
+ * @param options
+ */
+export async function a11yCheck(urlList, out, options) {
+    let sheet = null;
+    if (out) {
+        let sheetName = dayjs().format('YYYY-MM-DD');
+        if (options?.debug) {
+            sheetName += `-debug-${Date.now()}`;
+        }
+        sheet = await SpreadsheetReporter.setup(out, sheetName);
+    }
+    const scenarioList = options?.scenarios ?? ['axe'];
+    const scenarios = scenarioList.map((s) => {
+        switch (s) {
+            case 'axe': {
+                return scenarioAxe(options);
+            }
+            case '01': {
+                return scenario01(options);
+            }
+            case '02': {
+                return scenario02(options);
+            }
+            default: {
+                throw new Error(`Unknown scenario: ${s}`);
+            }
+        }
+    });
+    const result = await scenarioRunner(urlList, scenarios, options);
+    if (out && sheet) {
+        process.stdout.write(`Report to ${out}\n`);
+        await sheet.report(result.violations);
+    }
+}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+import { createCLI, parseCommonOptions } from '@d-zero/cli-core';
+import { a11yCheck } from './a11y-check.js';
+import { readConfig } from './read-config.js';
+const { options, args, hasConfigFile } = createCLI({
+    aliases: {
+        f: 'listfile',
+        s: 'screenshot',
+        o: 'out',
+    },
+    usage: [
+        'Usage:',
+        '\ta11y-check -f <listfile> [-o <out>] [--limit <limit>] [--cache <true|false>] [--debug] [--verbose]',
+    ],
+    parseArgs: (cli) => ({
+        ...parseCommonOptions(cli),
+        listfile: cli.listfile,
+        scenarios: cli.scenarios,
+        cache: cli.cache?.trim().toLowerCase() === 'false' ? false : true,
+        cacheDir: cli.cacheDir ?? '.cache',
+        locale: cli.locale,
+        screenshot: !!cli.screenshot,
+        out: cli.out?.trim() || undefined,
+    }),
+    validateArgs: (options, cli) => {
+        return !!(options.listfile?.length || cli._.length > 0);
+    },
+});
+const list = [];
+let a11yOptions = {
+    scenarios: options.scenarios?.split(',').map((s) => s.trim().toLowerCase()),
+    screenshot: options.screenshot,
+    locale: options.locale,
+    limit: options.limit,
+    cache: options.cache,
+    cacheDir: options.cacheDir,
+    debug: options.debug,
+    verbose: options.verbose,
+};
+if (hasConfigFile) {
+    const { urlList, hooks } = await readConfig(options.listfile);
+    list.push(...urlList);
+    a11yOptions = {
+        ...a11yOptions,
+        hooks,
+    };
+}
+else {
+    list.push(...args);
+}
+await a11yCheck(list, options.out, a11yOptions);

package/dist/read-config.d.ts

@@ -0,0 +1,11 @@
+/**
+ *
+ * @param filePath
+ */
+export declare function readConfig(filePath: string): Promise<{
+    urlList: {
+        id: string | null;
+        url: string;
+    }[];
+    hooks: import("@d-zero/puppeteer-page-scan").PageHook[];
+}>;

package/dist/read-config.js

@@ -0,0 +1,19 @@
+import { readPageHooks } from '@d-zero/puppeteer-page-scan';
+import { toKvList } from '@d-zero/readtext/list';
+import { readConfigFile } from '@d-zero/shared/config-reader';
+/**
+ *
+ * @param filePath
+ */
+export async function readConfig(filePath) {
+    const { content, baseDir } = await readConfigFile(filePath);
+    const urlList = toKvList(content.body).map((kv) => ({
+        id: kv.value ? kv.key : null,
+        url: kv.value || kv.key,
+    }));
+    const hooks = await readPageHooks(content.attributes?.hooks ?? [], baseDir);
+    return {
+        urlList,
+        hooks,
+    };
+}

package/dist/spreadsheet.d.ts

@@ -0,0 +1,7 @@
+import type { Violation } from '@d-zero/a11y-check-core';
+export declare class SpreadsheetReporter {
+    #private;
+    private constructor();
+    report(results: readonly Violation[]): Promise<void>;
+    static setup(sheetUrl: string, sheetName: string): Promise<SpreadsheetReporter>;
+}

package/dist/spreadsheet.js

@@ -0,0 +1,112 @@
+import { authentication } from '@d-zero/google-auth';
+import { SheetTable } from '@d-zero/google-sheets';
+import { parseUrl } from '@d-zero/shared/parse-url';
+import dotenv from 'dotenv';
+export class SpreadsheetReporter {
+    #table;
+    // eslint-disable-next-line no-restricted-syntax
+    constructor(sheetUrl, sheetName, auth) {
+        this.#table = new SheetTable(sheetUrl, sheetName, auth, {
+            id: 'No.',
+            url: '対象画面URL',
+            tool: 'テスト方法',
+            timestamp: '日時',
+            component: 'パーツ',
+            environment: '環境',
+            targetNode: '対象箇所',
+            asIs: 'AS IS',
+            toBe: {
+                label: 'TO BE',
+                conditionalFormatRules: [
+                    {
+                        booleanRule: {
+                            condition: { type: 'BLANK' },
+                            format: {
+                                backgroundColor: { red: 0.9 },
+                                textFormat: { foregroundColor: { red: 1, green: 1, blue: 1 } },
+                            },
+                        },
+                    },
+                ],
+            },
+            explanation: {
+                label: 'TO BE(補足)',
+                conditionalFormatRules: [
+                    {
+                        booleanRule: {
+                            condition: {
+                                type: 'TEXT_STARTS_WITH',
+                                values: [{ userEnteredValue: 'N/A' }],
+                            },
+                            format: {
+                                backgroundColor: { red: 0.9 },
+                                textFormat: { foregroundColor: { red: 1, green: 1, blue: 1 } },
+                            },
+                        },
+                    },
+                    {
+                        booleanRule: {
+                            condition: {
+                                type: 'TEXT_STARTS_WITH',
+                                values: [{ userEnteredValue: 'WARNING' }],
+                            },
+                            format: {
+                                backgroundColor: { red: 1, green: 0.5, blue: 0 },
+                                textFormat: { foregroundColor: { red: 1, green: 1, blue: 1 } },
+                            },
+                        },
+                    },
+                ],
+            },
+            wcagVersion: 'WCAGバージョン',
+            scNumber: '達成基準番号',
+            level: '適合レベル',
+            screenshot: 'スクリーンショット',
+        }, {
+            frozen: {
+                rows: 1,
+                cols: 2,
+            },
+        });
+    }
+    async report(results) {
+        await this.#table.update(results.map((result) => {
+            const url = parseUrl(result.url);
+            return {
+                id: { value: result.id },
+                url: {
+                    value: url.withoutHashAndAuth,
+                    textFormat: { link: { uri: url.withoutHashAndAuth } },
+                },
+                tool: { value: result.tool },
+                timestamp: { value: result.timestamp },
+                component: { value: result.component },
+                environment: { value: result.environment },
+                targetNode: {
+                    value: result.targetNode.value,
+                    note: result.targetNode.note,
+                },
+                asIs: { value: result.asIs.value, note: result.asIs.note },
+                toBe: { value: result.toBe.value, note: result.toBe.note },
+                explanation: {
+                    value: result.explanation.value,
+                    note: result.explanation.note,
+                },
+                wcagVersion: { value: result.wcagVersion },
+                scNumber: { value: result.scNumber },
+                level: { value: result.level },
+                screenshot: { value: result.screenshot },
+            };
+        }));
+    }
+    static async setup(sheetUrl, sheetName) {
+        dotenv.config();
+        if (!process.env.GOOGLE_AUTH_CREDENTIALS) {
+            throw new Error('GOOGLE_AUTH_CREDENTIALS is not set');
+        }
+        const auth = await authentication(process.env.GOOGLE_AUTH_CREDENTIALS, [
+            'https://www.googleapis.com/auth/spreadsheets',
+        ]);
+        return new SpreadsheetReporter(sheetUrl, sheetName, auth);
+    }
+}

package/dist/types.d.ts

@@ -0,0 +1,4 @@
+import type { CoreOptions, ScenarioRunnerOptions } from '@d-zero/a11y-check-core';
+export type A11yCheckOptions = {
+    readonly scenarios?: readonly string[];
+} & CoreOptions & ScenarioRunnerOptions;

package/dist/types.js

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

package/package.json

@@ -0,0 +1,46 @@
+{
+	"name": "@d-zero/a11y-check",
+	"version": "0.4.0",
+	"description": "Accessibility Checker CLI",
+	"author": "D-ZERO",
+	"license": "MIT",
+	"private": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./dist/a11y-check.js",
+			"types": "./dist/a11y-check.d.ts"
+		}
+	},
+	"bin": {
+		"a11y-check": "./dist/cli.js"
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"watch": "tsc --watch",
+		"clean": "tsc --build --clean"
+	},
+	"dependencies": {
+		"@d-zero/a11y-check-axe-scenario": "0.4.0",
+		"@d-zero/a11y-check-core": "0.5.0",
+		"@d-zero/a11y-check-scenarios": "0.4.0",
+		"@d-zero/cli-core": "1.1.0",
+		"@d-zero/google-auth": "0.4.0",
+		"@d-zero/google-sheets": "0.3.2",
+		"@d-zero/puppeteer-page-scan": "4.0.1",
+		"@d-zero/readtext": "1.1.4",
+		"@d-zero/shared": "0.9.0",
+		"ansi-colors": "4.1.3",
+		"dayjs": "1.11.13",
+		"dotenv": "16.5.0",
+		"front-matter": "4.0.2",
+		"minimist": "1.2.8"
+	},
+	"gitHead": "04c6969564182c36ee38ef41e78130936dfa4863"
+}