@d-zero/archaeologist 3.7.1 → 4.0.0

package/README.md

@@ -155,6 +155,8 @@ export default async function (page, { name, width, resolution, log }) {
 
 例のように、ページにログインする処理をフックスクリプトに記述することで、ユーザー認証が必要なページのスクリーンショットを撮影することができます。
 
+> **挙動変更のお知らせ:** これまでのバージョンでは、内部のプロセス間通信の制約により設定ファイルの `hooks` が `analyze` / `--freeze` の両モードで無視されていました。本リリース（次回 minor）から正しく実行されます。詳細は [MIGRATION-page-hooks.md](../../../MIGRATION-page-hooks.md) を参照してください。
+
 ## 認証
 
 ### Basic認証

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

@@ -1,5 +1,5 @@
 import type { URLPair } from './types.js';
-import type { PageHook } from '@d-zero/puppeteer-page-scan';
+import type { PageHookSource } from '@d-zero/puppeteer-page-scan';
 export type ChildProcessParams = {
     list: readonly URLPair[];
     dir: string;
@@ -8,6 +8,6 @@ export type ChildProcessParams = {
     selector?: string;
     ignore?: string;
     devices?: readonly string[];
-    hooks?: readonly PageHook[];
+    hooks?: PageHookSource;
     combined?: boolean;
 };

package/dist/analyze-child-process.js

@@ -1,6 +1,7 @@
 import { writeFile } from 'node:fs/promises';
 import path from 'node:path';
 import { createChildProcess } from '@d-zero/puppeteer-dealer';
+import { readPageHooks } from '@d-zero/puppeteer-page-scan';
 import { delay } from '@d-zero/shared/delay';
 import c from 'ansi-colors';
 import { combineImages } from './modules/combine-images.js';
@@ -11,8 +12,11 @@ import { fetchHtml } from './modules/fetch-html.js';
 import { getData } from './modules/get-data.js';
 import { normalizeTextDocument } from './modules/normalize-text-document.js';
 import { score } from './utils.js';
-createChildProcess((param) => {
-    const { list, dir, types = ['image', 'dom', 'text', 'code'], selector, ignore, devices, combined = false, } = param;
+createChildProcess(async (param) => {
+    const { list, dir, types = ['image', 'dom', 'text', 'code'], selector, ignore, devices, hooks: hookSource, combined = false, } = param;
+    const hooks = hookSource && hookSource.paths.length > 0
+        ? await readPageHooks(hookSource.paths, hookSource.baseDir)
+        : undefined;
     return {
         async eachPage({ page, url: urlA, index }, logger) {
             const urlPair = list.find(([url]) => url === urlA);
@@ -29,6 +33,7 @@ createChildProcess((param) => {
                         selector,
                         ignore,
                         devices,
+                        hooks,
                     }, logger);
                     dataPair.push(data);
                     await delay(600);

package/dist/analyze-main-process.js

@@ -27,7 +27,7 @@ export async function analyze(list, options) {
             selector: options?.selector,
             ignore: options?.ignore,
             devices: options?.devices,
-            hooks: options?.hooks ?? [],
+            hooks: options?.hooks,
             combined: options?.combined,
         }, {
             ...options,

package/dist/cli.js

@@ -91,6 +91,6 @@ if (options.freeze) {
 }
 if (args.length === 2) {
     const pairList = [[args[0], args[1]]];
-    await analyze(pairList, { ...analyzeOptions, hooks: [] });
+    await analyze(pairList, analyzeOptions);
     process.exit(0);
 }

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

@@ -1,3 +1,5 @@
+import type { PageHookSource } from '@d-zero/puppeteer-page-scan';
 export type ChildProcessParams = {
     dir: string;
+    hooks?: PageHookSource;
 };

package/dist/freeze-child-process.js

@@ -1,13 +1,17 @@
 import { writeFile } from 'node:fs/promises';
 import path from 'node:path';
 import { createChildProcess } from '@d-zero/puppeteer-dealer';
+import { readPageHooks } from '@d-zero/puppeteer-page-scan';
 import { delay } from '@d-zero/shared/delay';
 import { getData } from './modules/get-data.js';
-createChildProcess((param) => {
-    const { dir } = param;
+createChildProcess(async (param) => {
+    const { dir, hooks: hookSource } = param;
+    const hooks = hookSource && hookSource.paths.length > 0
+        ? await readPageHooks(hookSource.paths, hookSource.baseDir)
+        : undefined;
     return {
         async eachPage({ page, id, url }, logger) {
-            const data = await getData(page, url, {}, logger);
+            const data = await getData(page, url, { hooks }, logger);
             await delay(600);
             for (const size of Object.values(data.screenshots)) {
                 const jsonFile = path.resolve(dir, `${id}_${size.id}.html`);

package/dist/freeze-main-process.js

@@ -22,6 +22,7 @@ export async function freeze(list, options) {
     }, () => {
         return createProcess(path.resolve(import.meta.dirname, 'freeze-child-process.js'), {
             dir,
+            hooks: options?.hooks,
         }, {
             ...options,
             headless: useOldMode ? 'shell' : true,

package/dist/read-config.d.ts

@@ -1,9 +1,10 @@
+import type { PageHookSource } from '@d-zero/puppeteer-page-scan';
 /**
- * Frontmatter形式の設定ファイルを読み込み、URLペアリストとページフックを返す
+ * Frontmatter形式の設定ファイルを読み込み、URLペアリストとページフックの参照を返す
  * @param filePath - 設定ファイルのパス
- * @returns URLペアのリストとページフック関数の配列
+ * @returns URLペアのリストとページフックのロード元情報
  */
 export declare function readConfig(filePath: string): Promise<{
     pairList: [string, string][];
-    hooks: import("@d-zero/puppeteer-page-scan").PageHook[];
+    hooks: PageHookSource;
 }>;

package/dist/read-config.js

@@ -1,10 +1,9 @@
-import { readPageHooks } from '@d-zero/puppeteer-page-scan';
 import { toList } from '@d-zero/readtext/list';
 import { readConfigFile } from '@d-zero/shared/config-reader';
 /**
- * Frontmatter形式の設定ファイルを読み込み、URLペアリストとページフックを返す
+ * Frontmatter形式の設定ファイルを読み込み、URLペアリストとページフックの参照を返す
  * @param filePath - 設定ファイルのパス
- * @returns URLペアのリストとページフック関数の配列
+ * @returns URLペアのリストとページフックのロード元情報
  */
 export async function readConfig(filePath) {
     const { content, baseDir } = await readConfigFile(filePath);
@@ -16,9 +15,11 @@ export async function readConfig(filePath) {
             `${content.attributes.comparisonHost}${url.pathname}${url.search}`,
         ];
     });
-    const hooks = await readPageHooks(content.attributes?.hooks ?? [], baseDir);
     return {
         pairList,
-        hooks,
+        hooks: {
+            paths: content.attributes?.hooks ?? [],
+            baseDir,
+        },
     };
 }

package/dist/types.d.ts

@@ -1,5 +1,5 @@
-export type { PageHook } from '@d-zero/puppeteer-screenshot';
-import type { PageHook, Screenshot } from '@d-zero/puppeteer-screenshot';
+import type { PageHookSource } from '@d-zero/puppeteer-page-scan';
+import type { Screenshot } from '@d-zero/puppeteer-screenshot';
 /**
  * ページごとのスクリーンショットとDOMツリーのデータ
  */
@@ -97,7 +97,8 @@ export interface AnalyzeOptions extends GeneralOptions {
 export interface FreezeOptions extends GeneralOptions {
 }
 interface GeneralOptions {
-    readonly hooks: readonly PageHook[];
+    readonly hooks?: PageHookSource;
     readonly limit?: number;
     readonly debug?: boolean;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/archaeologist",
-	"version": "3.7.1",
+	"version": "4.0.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.8",
+		"@d-zero/cli-core": "1.3.9",
 		"@d-zero/fs": "0.2.3",
 		"@d-zero/html-distiller": "2.0.5",
-		"@d-zero/puppeteer-dealer": "0.7.10",
-		"@d-zero/puppeteer-page-scan": "4.4.10",
-		"@d-zero/puppeteer-screenshot": "3.3.10",
+		"@d-zero/puppeteer-dealer": "0.7.11",
+		"@d-zero/puppeteer-page-scan": "4.5.0",
+		"@d-zero/puppeteer-screenshot": "3.4.0",
 		"@d-zero/readtext": "1.1.21",
-		"@d-zero/shared": "0.21.3",
+		"@d-zero/shared": "0.22.0",
 		"ansi-colors": "4.1.3",
 		"diff": "8.0.3",
 		"front-matter": "4.0.2",
@@ -54,5 +54,5 @@
 		"url": "https://github.com/d-zero-dev/tools.git",
 		"directory": "packages/@d-zero/archaeologist"
 	},
-	"gitHead": "611614bdfcdfe3ef872efd01a1fd31ebedffdbb2"
+	"gitHead": "2d24e08c0cb516b7ea9d07a4301eb991193cca11"
 }