@nitpicker/cli 0.4.2

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.4.2](https://github.com/d-zero-dev/nitpicker/compare/v0.4.1...v0.4.2) (2026-02-27)
+
+**Note:** Version bump only for package @nitpicker/cli
+
+
+
+
+
+## [0.4.1](https://github.com/d-zero-dev/nitpicker/compare/v0.4.0...v0.4.1) (2026-02-27)
+
+**Note:** Version bump only for package nitpicker

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 D-ZERO Co., Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# @nitpicker/cli
+
+Web サイトのクローラー・分析・レポート統合 CLI。
+
+## 概要
+
+ヘッドレスブラウザで Web サイトをクロールし、各ページのメタデータ・リンク構造・ネットワークリソース・HTML スナップショットを `.nitpicker` アーカイブに保存します。さらに、アーカイブに対して各種プラグインによる分析を実行し、Google Sheets にレポートを出力できます。
+
+## 使い方
+
+```sh
+npx @nitpicker/cli crawl <URL>     # Web サイトをクロール
+npx @nitpicker/cli analyze <file>  # 分析プラグインを実行
+npx @nitpicker/cli report <file>   # Google Sheets レポートを生成
+```
+
+詳細なオプションは[ルートの README](../../README.md) を参照してください。
+
+## ライセンス
+
+Apache-2.0

package/bin/nitpicker.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../lib/index.js';

package/lib/analyze/log.d.ts

@@ -0,0 +1,12 @@
+import type { Nitpicker } from '@nitpicker/core';
+/**
+ * Registers event listeners on a Nitpicker instance for analyze output,
+ * and prints the initial summary lines.
+ *
+ * Outputs the start log lines (site URL, file path), then listens for
+ * `writeFile` and `error` events to provide CLI feedback.
+ * Progress display is handled by Lanes in the calling code.
+ * @param nitpicker - The Nitpicker instance to listen on
+ * @param startLog - Lines to display at the start (URL + file path summary)
+ */
+export declare function log(nitpicker: Nitpicker, startLog: string[]): void;

package/lib/analyze/log.js

@@ -0,0 +1,24 @@
+/**
+ * Registers event listeners on a Nitpicker instance for analyze output,
+ * and prints the initial summary lines.
+ *
+ * Outputs the start log lines (site URL, file path), then listens for
+ * `writeFile` and `error` events to provide CLI feedback.
+ * Progress display is handled by Lanes in the calling code.
+ * @param nitpicker - The Nitpicker instance to listen on
+ * @param startLog - Lines to display at the start (URL + file path summary)
+ */
+export function log(nitpicker, startLog) {
+    for (const line of startLog) {
+        // eslint-disable-next-line no-console
+        console.log(line);
+    }
+    nitpicker.on('writeFile', ({ filePath }) => {
+        // eslint-disable-next-line no-console
+        console.log(`  📥 Write file: ${filePath}`);
+    });
+    nitpicker.on('error', (err) => {
+        // eslint-disable-next-line no-console
+        console.error(err.message);
+    });
+}

package/lib/analyze/logger.d.ts

@@ -0,0 +1,10 @@
+export default class Logger {
+    verbose: boolean;
+    constructor(_options?: {
+        dots?: string[];
+        propeller?: string[];
+    });
+    close(): void;
+    verbosely(): void;
+    write(lines: string | string[]): void;
+}

package/lib/analyze/logger.js

@@ -0,0 +1,16 @@
+export default class Logger {
+    verbose = false;
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    constructor(_options) { }
+    close() { }
+    verbosely() {
+        this.verbose = true;
+    }
+    write(lines) {
+        const output = Array.isArray(lines) ? lines : [lines];
+        for (const line of output) {
+            const cleaned = line.replaceAll(/%dots%|%propeller%/g, '');
+            process.stderr.write(cleaned + '\n');
+        }
+    }
+}

package/lib/audit.d.ts

@@ -0,0 +1,7 @@
+import type { Options } from './bootstrap.js';
+/**
+ *
+ * @param filePath
+ * @param options
+ */
+export declare function audit(filePath: string, options: Options): Promise<void>;

package/lib/audit.js

@@ -0,0 +1,42 @@
+import path from 'node:path';
+import { Nitpicker } from '@nitpicker/core';
+import enquirer from 'enquirer';
+import { log } from './log.js';
+const { prompt } = enquirer;
+/**
+ *
+ * @param filePath
+ * @param options
+ */
+export async function audit(filePath, options) {
+    let errStack = null;
+    const absFilePath = path.isAbsolute(filePath)
+        ? filePath
+        : path.resolve(process.cwd(), filePath);
+    const nitpicker = await Nitpicker.open(absFilePath);
+    const config = await nitpicker.getConfig();
+    const audits = config.audit || [];
+    const pluginNameList = audits.map((plugin) => plugin.name);
+    let filter;
+    if (!options.all) {
+        const res = await prompt([
+            {
+                message: 'What do you audit through?',
+                name: 'filter',
+                type: 'multiselect',
+                choices: pluginNameList,
+            },
+        ]);
+        filter = res.filter;
+    }
+    const siteUrl = (await nitpicker.archive.getUrl()) || '<Unknown URL 🤔 >';
+    const head = [`🥢 ${siteUrl} (${filePath})`, `  📤 Read file: ${absFilePath}`];
+    log(nitpicker, head, !!options.verbose).catch((error) => {
+        errStack = error;
+    });
+    await nitpicker.audit(filter);
+    await nitpicker.write();
+    if (errStack) {
+        throw errStack;
+    }
+}

package/lib/bootstrap.d.ts

@@ -0,0 +1,9 @@
+export declare const cli: import("meow").Result<{
+    all: {
+        type: "boolean";
+    };
+    verbose: {
+        type: "boolean";
+    };
+}>;
+export type Options = typeof cli.flags;

package/lib/bootstrap.js

@@ -0,0 +1,22 @@
+import meow from 'meow';
+export const cli = meow(`
+    Usage
+      $ nitpicker <URL>
+
+      Options
+      --all      Audit through all audits.
+	  --verbose  Output logs verbosely.
+
+    Examples
+      $ nitpicker https://www.d-zero.co.jp --output-path ./path/to/result.csv
+`, {
+    importMeta: import.meta,
+    flags: {
+        all: {
+            type: 'boolean',
+        },
+        verbose: {
+            type: 'boolean',
+        },
+    },
+});

package/lib/commands/analyze.d.ts

@@ -0,0 +1,35 @@
+import type { InferFlags } from '@d-zero/roar';
+/**
+ * Command definition for the `analyze` sub-command.
+ * @see {@link analyze} for the main entry point
+ */
+export declare const commandDef: {
+    readonly desc: "Analyze a .nitpicker archive";
+    readonly flags: {
+        readonly all: {
+            readonly type: "boolean";
+            readonly desc: "Run all analysis plugins";
+        };
+        readonly verbose: {
+            readonly type: "boolean";
+            readonly desc: "Output logs verbosely";
+        };
+    };
+};
+type AnalyzeFlags = InferFlags<typeof commandDef.flags>;
+/**
+ * Main entry point for the `analyze` CLI command.
+ *
+ * Opens a `.nitpicker` archive, loads the configured analyze plugins,
+ * presents an interactive multi-select prompt (unless `--all` is specified),
+ * runs the selected plugins with per-plugin Lanes progress display, and
+ * writes results back to the archive.
+ *
+ * WHY enquirer prompt: Allows users to selectively run expensive plugins
+ * (e.g. Lighthouse) without re-running everything. The `--all` flag
+ * bypasses the prompt for CI/automation use cases.
+ * @param args - Positional arguments; first argument is the `.nitpicker` file path
+ * @param flags - Parsed CLI flags from the `analyze` command
+ */
+export declare function analyze(args: string[], flags: AnalyzeFlags): Promise<void>;
+export {};

package/lib/commands/analyze.js

@@ -0,0 +1,86 @@
+import path from 'node:path';
+import { Lanes } from '@d-zero/dealer';
+import { Nitpicker, readPluginLabels } from '@nitpicker/core';
+import enquirer from 'enquirer';
+import { log } from '../analyze/log.js';
+const { prompt } = enquirer;
+/**
+ * Command definition for the `analyze` sub-command.
+ * @see {@link analyze} for the main entry point
+ */
+export const commandDef = {
+    desc: 'Analyze a .nitpicker archive',
+    flags: {
+        all: {
+            type: 'boolean',
+            desc: 'Run all analysis plugins',
+        },
+        verbose: {
+            type: 'boolean',
+            desc: 'Output logs verbosely',
+        },
+    },
+};
+/**
+ * Main entry point for the `analyze` CLI command.
+ *
+ * Opens a `.nitpicker` archive, loads the configured analyze plugins,
+ * presents an interactive multi-select prompt (unless `--all` is specified),
+ * runs the selected plugins with per-plugin Lanes progress display, and
+ * writes results back to the archive.
+ *
+ * WHY enquirer prompt: Allows users to selectively run expensive plugins
+ * (e.g. Lighthouse) without re-running everything. The `--all` flag
+ * bypasses the prompt for CI/automation use cases.
+ * @param args - Positional arguments; first argument is the `.nitpicker` file path
+ * @param flags - Parsed CLI flags from the `analyze` command
+ */
+export async function analyze(args, flags) {
+    const filePath = args[0];
+    if (!filePath) {
+        return;
+    }
+    const isTTY = process.stdout.isTTY;
+    const absFilePath = path.isAbsolute(filePath)
+        ? filePath
+        : path.resolve(process.cwd(), filePath);
+    // eslint-disable-next-line no-console
+    console.log(`  📦 Extracting archive: ${absFilePath}`);
+    const nitpicker = await Nitpicker.open(absFilePath);
+    const config = await nitpicker.getConfig();
+    const plugins = config.analyze || [];
+    const pluginNameList = plugins.map((plugin) => plugin.name);
+    if (pluginNameList.length === 0) {
+        // eslint-disable-next-line no-console
+        console.error('No analyze plugins found. Install @nitpicker/analyze-* packages or configure them in .nitpickerrc.');
+        return;
+    }
+    let filter;
+    if (!flags.all) {
+        const labels = await readPluginLabels(plugins);
+        const choices = plugins.map((plugin) => ({
+            name: plugin.name,
+            message: labels.get(plugin.name) || plugin.name,
+        }));
+        const res = await prompt([
+            {
+                message: 'What do you analyze?',
+                name: 'filter',
+                type: 'multiselect',
+                choices,
+            },
+        ]);
+        filter = res.filter;
+    }
+    const siteUrl = (await nitpicker.archive.getUrl()) || '<Unknown URL>';
+    log(nitpicker, [`🥢 ${siteUrl} (${filePath})`, `  📤 Read file: ${absFilePath}`]);
+    const lanes = new Lanes({ verbose: !isTTY, indent: '  ' });
+    try {
+        await nitpicker.analyze(filter, { lanes, verbose: !isTTY });
+    }
+    finally {
+        lanes.close();
+    }
+    await nitpicker.write();
+    await nitpicker.archive.close();
+}

package/lib/commands/crawl.d.ts

@@ -0,0 +1,125 @@
+import type { InferFlags } from '@d-zero/roar';
+/**
+ * Command definition for the `crawl` sub-command.
+ * Defines all CLI flags with their types, defaults, and descriptions.
+ * @see {@link crawl} for the main entry point that dispatches to startCrawl/resumeCrawl/diff
+ */
+export declare const commandDef: {
+    readonly desc: "Crawl a website";
+    readonly flags: {
+        readonly resume: {
+            readonly type: "string";
+            readonly shortFlag: "R";
+            readonly desc: "Resume crawling from a stub file";
+        };
+        readonly interval: {
+            readonly type: "number";
+            readonly shortFlag: "I";
+            readonly desc: "An interval time on request when crawles";
+        };
+        readonly image: {
+            readonly type: "boolean";
+            readonly default: true;
+            readonly desc: "Getting images (use --no-image to disable)";
+        };
+        readonly fetchExternal: {
+            readonly type: "boolean";
+            readonly default: true;
+            readonly desc: "Fetch external links (use --no-fetch-external to disable)";
+        };
+        readonly parallels: {
+            readonly type: "number";
+            readonly shortFlag: "P";
+            readonly desc: "Number of parallel scraping";
+        };
+        readonly recursive: {
+            readonly type: "boolean";
+            readonly default: true;
+            readonly desc: "Recursive crawling (use --no-recursive to disable)";
+        };
+        readonly scope: {
+            readonly type: "string";
+            readonly desc: "Set hosts and URLs as scope";
+        };
+        readonly exclude: {
+            readonly type: "string";
+            readonly isMultiple: true;
+            readonly desc: "Excluding page URL path (glob pattern)";
+        };
+        readonly excludeKeyword: {
+            readonly type: "string";
+            readonly isMultiple: true;
+            readonly desc: "Exclude keyword in document of page";
+        };
+        readonly excludeUrl: {
+            readonly type: "string";
+            readonly isMultiple: true;
+            readonly desc: "Exclude external URL prefix";
+        };
+        readonly disableQueries: {
+            readonly type: "boolean";
+            readonly shortFlag: "Q";
+            readonly desc: "Disable queries that the URL has";
+        };
+        readonly imageFileSizeThreshold: {
+            readonly type: "number";
+            readonly desc: "Image file size threshold";
+        };
+        readonly single: {
+            readonly type: "boolean";
+            readonly desc: "Single page mode";
+        };
+        readonly maxExcludedDepth: {
+            readonly type: "number";
+            readonly desc: "Avoid crawling depths above a set number";
+        };
+        readonly retry: {
+            readonly type: "number";
+            readonly default: 3;
+            readonly desc: "Number of retry attempts per URL on scrape failure";
+        };
+        readonly list: {
+            readonly type: "string";
+            readonly isMultiple: true;
+            readonly desc: "Running only each page from the list";
+        };
+        readonly listFile: {
+            readonly type: "string";
+            readonly desc: "Running only each page from the list file";
+        };
+        readonly userAgent: {
+            readonly type: "string";
+            readonly desc: "Custom User-Agent string for HTTP requests";
+        };
+        readonly ignoreRobots: {
+            readonly type: "boolean";
+            readonly desc: "Ignore robots.txt restrictions (use responsibly)";
+        };
+        readonly verbose: {
+            readonly type: "boolean";
+            readonly desc: "Output verbose log to standard out";
+        };
+        readonly silent: {
+            readonly type: "boolean";
+            readonly desc: "No output log to standard out";
+        };
+        readonly diff: {
+            readonly type: "boolean";
+            readonly desc: "Diff mode";
+        };
+    };
+};
+type CrawlFlags = InferFlags<typeof commandDef.flags>;
+/**
+ * Main entry point for the `crawl` CLI command.
+ *
+ * Dispatches to one of four modes based on the flags:
+ * 1. `--diff` mode: Compares two archive files and outputs URL lists
+ * 2. `--resume` mode: Resumes a previously interrupted crawl
+ * 3. `--list-file` / `--list` mode: Crawls a pre-defined URL list (non-recursive)
+ * 4. Default mode: Crawls from a single root URL
+ * @param args - Positional arguments (typically one or two URLs/file paths)
+ * @param flags - Parsed CLI flags from the `crawl` command
+ */
+export declare function crawl(args: string[], flags: CrawlFlags): Promise<void>;
+export {};