@d-zero/a11y-check 0.10.2 → 0.10.3

package/README.md

@@ -1,75 +1,33 @@
 # `@d-zero/a11y-check`
 
-ウェブサイトのアクセシビリティチェックを行うツールです。
+ウェブサイトのアクセシビリティチェック CLI。Puppeteer でページを検証し、Google スプレッドシートにレポート出力する。
 
-- Puppeteerを使用してページのアクセシビリティを検証します
-- Googleスプレッドシートに詳細なレポートを出力します
-- 複数のシナリオ（axe、01、02）でチェックを実行可能
-- スクリーンショット機能付き
-
-## CLI
+## Installation
 
 ```sh
-npx @d-zero/a11y-check -f <listfile> [options]
-npx @d-zero/a11y-check <url>... [options]
+yarn add @d-zero/a11y-check
 ```
 
-リストをファイルから読み込むか、URLを直接指定して実行します。
-
-### オプション
-
-- `-v, --version`: バージョンを表示
-- `-f, --listfile <file>`: URLリストを持つファイルのパス
-- `<url>`: 対象のURL（複数指定可能）
-- `-s, --screenshot`: スクリーンショットを撮影する（デフォルト: false）
-- `-o, --out <url>`: GoogleスプレッドシートのURL（デフォルト: 標準出力）
-- `-c, --credentials <file>`: Google認証用のクレデンシャルJSONファイルのパス（または環境変数`GOOGLE_AUTH_CREDENTIALS`で指定）
-- `--scenarios <scenarios>`: チェックシナリオ（カンマ区切り、利用可能: axe,01,02、デフォルト: axe）
-- `--cache <true|false>`: キャッシュを使用する（デフォルト: true）
-- `--cacheDir <dir>`: キャッシュディレクトリ（デフォルト: .cache）
-- `--locale <locale>`: ロケール設定
-- `--limit <number>`: 並列実行数の上限
-- `--interval <ms>`: 並列実行間の間隔（デフォルト: なし）
-  - 数値または"min-max"形式でランダム範囲を指定可能
-- `--debug`: デバッグモード（デフォルト: false）
-- `--verbose`: 詳細ログモード（デフォルト: false）
-
-### 使用例
+## Usage
 
 ```sh
-# 基本的な使用
-npx @d-zero/a11y-check https://example.com
-
-# ファイルから読み込み
-npx @d-zero/a11y-check -f urls.txt
-
-# スクリーンショット付きで実行
-npx @d-zero/a11y-check https://example.com --screenshot
-
-# 結果をGoogleスプレッドシートに出力
-npx @d-zero/a11y-check -f urls.txt -o https://docs.google.com/spreadsheets/d/xxx/edit
+npx @d-zero/a11y-check <url>... [options]
+npx @d-zero/a11y-check -f <listfile> [options]
 ```
 
-#### URLリストのファイルフォーマット
+オプションは `--help` を参照。
+
+### URL リストファイル
 
 ```txt
 https://example.com
-https://example.com/a
-https://example.com/b
-ABC https://example.com/c
-XYZ https://example.com/xyz/001
-# コメント
-# https://example.com/d
+ID001 https://example.com/a
+# コメント行
 ```
 
-URLの手前に任意のIDを付与することができます。ホワイトスペースで区切ることでIDとURLを分けることができます。
-IDが指定されていない場合は、URLのみが記録されます。
+各 URL の手前に任意の ID を空白区切りで付与可能。`#` で始まる行はコメント。
 
-`#`で始まる行はコメントとして無視されます。
-
-## 設定ファイル
-
-Frontmatterを使用してページフックを設定できます。
+### 設定ファイル（frontmatter）
 
 ```txt
 ---
@@ -79,93 +37,27 @@ hooks:
 ---
 
 https://example.com
-https://example.com/a
-︙
 ```
 
-**注意**: 設定ファイルでは`hooks`のみ設定可能です。その他のオプション（`scenarios`, `screenshot`, `locale`, `cache`, `cacheDir`など）はCLIオプションとして指定してください。
-
-### 利用可能なシナリオ
-
-- `axe`: axe-coreを使用したアクセシビリティチェック
-- `01`: カスタムシナリオ01
-- `02`: カスタムシナリオ02
+設定ファイルでは `hooks` のみ指定可能。その他のオプションは CLI で渡す。`hooks` は IPC 越境のためファイルパスで渡す仕様（詳細は [`@d-zero/puppeteer-page-scan`](../puppeteer-page-scan/) の `PageHookSource`）。
 
 ### ページフック
 
-`hooks`に配列としてスクリプトファイルのパスを渡すと、ページを開いた後にそれらのスクリプトを実行します。
-
 ```js
-/**
- * @type {import('@d-zero/puppeteer-page-scan').PageHook}
- */
+/** @type {import('@d-zero/puppeteer-page-scan').PageHook} */
 export default async function (page, { name, width, resolution, log }) {
-	// 非同期処理可能
-	// page: PuppeteerのPageオブジェクト
-	// name: サイズ名
-	// width: ウィンドウ幅
-	// resolution: 解像度
-	// log: ロガー
-
-	// ログイン処理の例
-	log('login');
+	// 例: ログイン処理
 	await page.type('#username', 'user');
 	await page.type('#password', 'pass');
 	await page.click('button[type="submit"]');
 	await page.waitForNavigation();
-	log('login done');
 }
 ```
 
-> **挙動変更のお知らせ:** これまでのバージョンでは、内部のプロセス間通信の制約により設定ファイルの `hooks` が無視されていました。本リリース（次回 minor）から正しく実行されます。詳細は [MIGRATION-page-hooks.md](../../../MIGRATION-page-hooks.md) を参照してください。
-
-## Googleスプレッドシート出力
-
-`-o`オプションでGoogleスプレッドシートのURLを指定すると、詳細なレポートが出力されます。
-
-### クレデンシャルの設定
-
-Googleスプレッドシートに出力するには、クレデンシャルファイルが必要です。以下のいずれかの方法で指定します：
-
-**方法1: CLIオプションで指定**
-
-```bash
-npx @d-zero/a11y-check -f urls.txt -o https://docs.google.com/spreadsheets/d/xxx/edit -c /path/to/credential.json
-```
-
-**方法2: 環境変数で指定**
-
-```bash
-export GOOGLE_AUTH_CREDENTIALS='/path/to/credential.json'
-npx @d-zero/a11y-check -f urls.txt -o https://docs.google.com/spreadsheets/d/xxx/edit
-```
-
-CLIオプション`-c`が優先され、未指定の場合は環境変数`GOOGLE_AUTH_CREDENTIALS`が使用されます。
-
-クレデンシャルファイルは、Google Cloud Consoleの[APIとサービス](https://console.cloud.google.com/apis/credentials)から**OAuth 2.0 クライアント ID**（アプリケーションの種類は**デスクトップ**）を発行してダウンロードします。
-
-### 出力されるレポート項目
-
-- No.: 連番
-- 対象画面URL: チェック対象のURL
-- テスト方法: 使用したシナリオ
-- 日時: チェック実行日時
-- パーツ: コンポーネント名
-- 環境: 実行環境
-- 対象箇所: 問題のある要素
-- AS IS: 現在の状態
-- TO BE: 改善すべき状態
-- TO BE(補足): 補足説明
-- WCAGバージョン: WCAGのバージョン
-- 達成基準番号: WCAGの達成基準
-- 適合レベル: A/AA/AAA
-- 深刻度: 問題の深刻度
-- スクリーンショット: スクリーンショットのURL
-
-## 認証
+### Google スプレッドシート出力
 
-### Basic認証
+`-o <URL>` で出力。クレデンシャル指定は `-c <path>` または `GOOGLE_AUTH_CREDENTIALS` 環境変数（CLI 優先）。クレデンシャルファイルは Google Cloud Console の OAuth 2.0 クライアント ID（アプリ種別: **デスクトップ**）を発行してダウンロード。
 
-Basic認証が必要なページの場合はURLにユーザー名とパスワードを含めます。
+### Basic 認証
 
-例: `https://user:pass@example.com`
+URL に資格情報を含める: `https://user:pass@example.com`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/a11y-check",
-	"version": "0.10.2",
+	"version": "0.10.3",
 	"description": "Accessibility Checker CLI",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -24,14 +24,14 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/a11y-check-axe-scenario": "0.5.24",
-		"@d-zero/a11y-check-core": "0.7.2",
-		"@d-zero/a11y-check-scenarios": "0.4.38",
-		"@d-zero/cli-core": "1.3.9",
-		"@d-zero/google-auth": "0.7.1",
-		"@d-zero/google-sheets": "0.9.0",
-		"@d-zero/puppeteer-page-scan": "4.5.0",
-		"@d-zero/readtext": "1.1.21",
+		"@d-zero/a11y-check-axe-scenario": "0.5.25",
+		"@d-zero/a11y-check-core": "0.7.3",
+		"@d-zero/a11y-check-scenarios": "0.4.39",
+		"@d-zero/cli-core": "1.3.10",
+		"@d-zero/google-auth": "0.7.2",
+		"@d-zero/google-sheets": "0.9.1",
+		"@d-zero/puppeteer-page-scan": "4.5.1",
+		"@d-zero/readtext": "1.1.22",
 		"@d-zero/shared": "0.22.0",
 		"ansi-colors": "4.1.3",
 		"dayjs": "1.11.19",
@@ -44,5 +44,5 @@
 		"url": "https://github.com/d-zero-dev/tools.git",
 		"directory": "packages/@d-zero/a11y-check"
 	},
-	"gitHead": "1b1fa31055375315fac7941eef7442ae58de98c2"
+	"gitHead": "25b4043dcd70cf3490ddcefd76a88b22c60f7712"
 }