@d-zero/archaeologist 3.6.1 → 3.7.0

package/README.md

@@ -14,15 +14,16 @@
 ## CLI
 
 ```sh
+npx @d-zero/archaeologist <urlA> <urlB> [options]
 npx @d-zero/archaeologist -f <listfile> [options]
 ```
 
-URLリストを持つファイルを指定して実行します。
+2つのURLを直接指定するか、URLリストを持つファイルを指定して実行します。
 
 ### オプション
 
 - `-v, --version`: バージョンを表示
-- `-f, --listfile <filepath>`: URLリストを持つファイルのパス（必須）
+- `-f, --listfile <filepath>`: URLリストを持つファイルのパス
 - `-t, --type <types>`: 比較タイプの指定（`image,dom,text,code`、カンマ区切り）
 - `-s, --selector <selector>`: 比較対象を限定するCSSセレクター
 - `-i, --ignore <selector>`: 無視するCSSセレクター
@@ -61,6 +62,9 @@ URLリストを持つファイルを指定して実行します。
 ### 使用例
 
 ```sh
+# 2つのURLを直接比較
+npx @d-zero/archaeologist http://localhost:3000/page https://example.com/page
+
 # デフォルトデバイス（desktop-compact, mobile）
 npx @d-zero/archaeologist -f urls.txt
 

package/dist/cli.js

@@ -6,7 +6,7 @@ import { freeze } from './freeze-main-process.js';
 import { readConfig } from './read-config.js';
 const require = createRequire(import.meta.url);
 const pkg = require('../package.json');
-const { options, hasConfigFile } = createCLI({
+const { options, args, hasConfigFile } = createCLI({
     name: pkg.name,
     version: pkg.version,
     aliases: {
@@ -17,7 +17,8 @@ const { options, hasConfigFile } = createCLI({
         d: 'devices',
     },
     usage: [
-        'Usage: archaeologist -f <listfile> [options]',
+        'Usage: archaeologist <urlA> <urlB> [options]',
+        '       archaeologist -f <listfile> [options]',
         '',
         'Options:',
         '\t-f, --listfile <file>     File containing URL pairs to analyze',
@@ -39,6 +40,7 @@ const { options, hasConfigFile } = createCLI({
         '\tdesktop, tablet, mobile, desktop-hd, desktop-compact, mobile-large, mobile-small',
         '',
         'Examples:',
+        '\tarchaeologist http://localhost:3000 https://example.com',
         '\tarchaeologist -f urls.txt',
         '\tarchaeologist -f urls.txt --devices desktop,mobile',
         '\tarchaeologist -f urls.txt --combined',
@@ -56,24 +58,24 @@ const { options, hasConfigFile } = createCLI({
             cli.device,
         combined: cli.combined,
     }),
-    validateArgs: (options) => {
-        return !!(options.listfile?.length || options.freeze?.length);
+    validateArgs: (options, cli) => {
+        return !!(options.listfile?.length || options.freeze?.length || cli._.length === 2);
     },
 });
+const analyzeOptions = {
+    types: options.type ? parseList(options.type) : undefined,
+    selector: options.selector,
+    ignore: options.ignore,
+    devices: options.devices ? parseList(options.devices) : undefined,
+    combined: options.combined,
+    limit: options.limit,
+    debug: options.debug,
+    verbose: options.verbose,
+    interval: options.interval,
+};
 if (hasConfigFile) {
     const { pairList, hooks } = await readConfig(options.listfile);
-    await analyze(pairList, {
-        hooks,
-        types: options.type ? parseList(options.type) : undefined,
-        selector: options.selector,
-        ignore: options.ignore,
-        devices: options.devices ? parseList(options.devices) : undefined,
-        combined: options.combined,
-        limit: options.limit,
-        debug: options.debug,
-        verbose: options.verbose,
-        interval: options.interval,
-    });
+    await analyze(pairList, { ...analyzeOptions, hooks });
     process.exit(0);
 }
 if (options.freeze) {
@@ -87,3 +89,8 @@ if (options.freeze) {
     });
     process.exit(0);
 }
+if (args.length === 2) {
+    const pairList = [[args[0], args[1]]];
+    await analyze(pairList, { ...analyzeOptions, hooks: [] });
+    process.exit(0);
+}

package/dist/types.d.ts

@@ -1,50 +1,99 @@
 export type { PageHook } from '@d-zero/puppeteer-screenshot';
 import type { PageHook, Screenshot } from '@d-zero/puppeteer-screenshot';
+/**
+ * ページごとのスクリーンショットとDOMツリーのデータ
+ */
 export type PageData = {
     url: string;
     screenshots: Record<string, Screenshot & {
         domTree: string;
     }>;
 };
+/**
+ * 比較対象のURLペア
+ */
 export type URLPair = readonly [urlA: string, urlB: string];
+/**
+ * URLペアの比較結果
+ */
 export type Result = {
     target: [urlA: string, urlB: string];
     screenshots: Record<string, MediaResult>;
     code: CodeResult | null;
 };
+/**
+ * デバイスサイズごとのメディア比較結果
+ */
 export type MediaResult = {
     image: ImageResult | null;
     dom: DOMResult | null;
     text: TextResult | null;
 };
+/**
+ * ビジュアル差分の結果
+ */
 export type ImageResult = {
+    /** ピクセル一致率（0〜1） */
     matches: number;
+    /** 差分画像のファイルパス */
     file: string;
 };
+/**
+ * DOM差分の結果
+ */
 export type DOMResult = {
+    /** DOM一致率（0〜1） */
     matches: number;
+    /** 差分テキスト（差分がない場合はnull） */
     diff: string | null;
+    /** 差分ファイルのパス */
     file: string;
 };
+/**
+ * テキスト差分の結果（形態素解析による比較）
+ */
 export type TextResult = {
+    /** テキスト一致率（0〜1） */
     matches: number;
+    /** 差分テキスト（差分がない場合はnull） */
     diff: string | null;
+    /** 差分ファイルのパス */
     file: string;
 };
+/**
+ * 生HTMLソースの差分結果
+ */
 export type CodeResult = {
+    /** ソースコード一致率（0〜1） */
     matches: number;
+    /** 差分テキスト（差分がない場合はnull） */
     diff: string | null;
+    /** 差分ファイルのパス */
     file: string;
 };
+/**
+ * Archaeologistの分析オプション
+ */
 export interface ArchaeologistOptions extends AnalyzeOptions {
 }
+/**
+ * 分析オプション
+ */
 export interface AnalyzeOptions extends GeneralOptions {
+    /** 比較タイプ（`image`, `dom`, `text`, `code`） */
     readonly types?: readonly string[];
+    /** 比較対象を限定するCSSセレクター */
     readonly selector?: string;
+    /** 無視するCSSセレクター */
     readonly ignore?: string;
+    /** デバイスプリセット名 */
     readonly devices?: readonly string[];
+    /** 環境AとBのスクリーンショットを左右に並べた合成画像を出力 */
     readonly combined?: boolean;
 }
+/**
+ * フリーズモードのオプション
+ */
 export interface FreezeOptions extends GeneralOptions {
 }
 interface GeneralOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/archaeologist",
-	"version": "3.6.1",
+	"version": "3.7.0",
 	"description": "Uncover visual and HTML differences in web pages with precision",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -24,14 +24,14 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/cli-core": "1.3.6",
+		"@d-zero/cli-core": "1.3.7",
 		"@d-zero/fs": "0.2.2",
 		"@d-zero/html-distiller": "2.0.4",
-		"@d-zero/puppeteer-dealer": "0.7.8",
-		"@d-zero/puppeteer-page-scan": "4.4.8",
-		"@d-zero/puppeteer-screenshot": "3.3.8",
+		"@d-zero/puppeteer-dealer": "0.7.9",
+		"@d-zero/puppeteer-page-scan": "4.4.9",
+		"@d-zero/puppeteer-screenshot": "3.3.9",
 		"@d-zero/readtext": "1.1.20",
-		"@d-zero/shared": "0.21.1",
+		"@d-zero/shared": "0.21.2",
 		"ansi-colors": "4.1.3",
 		"diff": "8.0.3",
 		"front-matter": "4.0.2",
@@ -49,5 +49,5 @@
 		"@types/pixelmatch": "5.2.6",
 		"@types/pngjs": "6.0.5"
 	},
-	"gitHead": "a347e4e88968fca7f2ace7639090d32014479d9f"
+	"gitHead": "964c118678a0ad4377e4c2c9af8833707fa29c2d"
 }