@nitpicker/core 0.12.0 → 0.13.0

package/README.md

@@ -1,14 +1,10 @@
 # @nitpicker/core
 
-プラグインベースのページ分析エンジン。
+`.nitpicker` アーカイブ内のページに対して analyze プラグインを実行する内部パッケージです。
 
-## 概要
+プラグインの読み込み、実行、結果の書き戻しを担当します。通常は [@nitpicker/cli](../cli/README.md) の `analyze` コマンドから利用します。
 
-`.nitpicker` アーカイブ内の各ページに対して、analyze プラグインを並列実行するためのエンジンです。プラグインの検出・読み込み・Worker スレッドプールでの実行を担当します。
-
-このパッケージは [Nitpicker](../../README.md) モノレポの内部パッケージです。単体での利用は想定していません。
-
-## プラグイン作者向け
+## プラグイン作者向けAPI
 
 analyze プラグインは `definePlugin()` で定義します。
 
@@ -23,14 +19,14 @@ export default definePlugin((options: Options) => {
 	return {
 		label: 'キーワード検索',
 		// 並列度を宣言できる。省略時は os.cpus().length
-		// 重いプラグイン（Chrome 起動など）は小さく設定する
+		// 重いプラグインは小さく設定する
 		concurrency: 4,
 		headers: {
 			found: 'Keywords Found',
 		},
 		async eachPage({ window }) {
 			const text = window.document.body.textContent ?? '';
-			const count = options.keywords.filter((k) => text.includes(k)).length;
+			const count = options.keywords.filter((keyword) => text.includes(keyword)).length;
 			return {
 				page: { found: { value: count } },
 			};
@@ -39,12 +35,14 @@ export default definePlugin((options: Options) => {
 });
 ```
 
-### `concurrency` の指針
+`concurrency` を省略するとCPUコア数が使われます。ChromeやPuppeteerなど重いプロセスを起動するプラグインでは、2〜4程度に絞ることを推奨します。
 
-- **省略**: `os.cpus().length`（CPU コア数）が使われる。軽量な DOM 解析のみのプラグインはこのままで良い
-- **小さく設定すべきケース**: Chrome や Puppeteer などの重いプロセスを起動するプラグインは 2〜4 程度に絞る。例えば `@nitpicker/analyze-lighthouse` は Chrome 1 プロセス ≒ 300〜500MB を消費するため `concurrency: 2`
+## 関連リンク
 
-詳細は [CONTRIBUTING.md](../../../CONTRIBUTING.md) と [ARCHITECTURE.md](../../../ARCHITECTURE.md) を参照。
+- [Nitpicker README](../../../README.md)
+- [CLI analyze docs](../cli/docs/analyze.md)
+- [CONTRIBUTING.md](../../../CONTRIBUTING.md)
+- [ARCHITECTURE.md](../../../ARCHITECTURE.md)
 
 ## ライセンス
 

package/lib/nitpicker.d.ts

@@ -8,7 +8,8 @@ export { definePlugin } from './hooks/define-plugin.js';
  * Nitpicker opens an existing archive (produced by the crawler), loads the
  * user's plugin configuration via cosmiconfig, then runs each plugin against
  * every page in the archive. Results are stored back into the archive as
- * `analysis/report`, `analysis/table`, and `analysis/violations`.
+ * `analysis/report`, `analysis/table`, and SQL-backed analysis violation
+ * tables via the archive facade.
  *
  * ## Architecture decisions
  *
@@ -76,9 +77,9 @@ export declare class Nitpicker extends EventEmitter<NitpickerEvent> {
      *    that don't need DOM access.
      *
      * On completion, three data entries are stored in the archive:
-     * - `analysis/report` - Full {@link Report} with headers, data, and violations
+     * - `analysis/report` - Full {@link Report} with headers and data
      * - `analysis/table` - The raw {@link Table} instance (serialized)
-     * - `analysis/violations` - Flat array of all {@link Violation} records
+     * - SQL-backed analysis violation tables - Flat {@link Violation} records
      * @param filter - Optional list of plugin module names to run.
      *   If omitted, all configured plugins are executed.
      * @param options - Optional settings for progress display.

package/lib/nitpicker.js

@@ -35,7 +35,8 @@ const DEFAULT_CONCURRENCY = Math.max(1, os.cpus().length);
  * Nitpicker opens an existing archive (produced by the crawler), loads the
  * user's plugin configuration via cosmiconfig, then runs each plugin against
  * every page in the archive. Results are stored back into the archive as
- * `analysis/report`, `analysis/table`, and `analysis/violations`.
+ * `analysis/report`, `analysis/table`, and SQL-backed analysis violation
+ * tables via the archive facade.
  *
  * ## Architecture decisions
  *
@@ -122,9 +123,9 @@ export class Nitpicker extends EventEmitter {
      *    that don't need DOM access.
      *
      * On completion, three data entries are stored in the archive:
-     * - `analysis/report` - Full {@link Report} with headers, data, and violations
+     * - `analysis/report` - Full {@link Report} with headers and data
      * - `analysis/table` - The raw {@link Table} instance (serialized)
-     * - `analysis/violations` - Flat array of all {@link Violation} records
+     * - SQL-backed analysis violation tables - Flat {@link Violation} records
      * @param filter - Optional list of plugin module names to run.
      *   If omitted, all configured plugins are executed.
      * @param options - Optional settings for progress display.
@@ -356,11 +357,10 @@ export class Nitpicker extends EventEmitter {
         const report = {
             name: 'general',
             pageData: table.toJSON(),
-            violations: allViolations,
         };
         await this.archive.setData('analysis/report', report);
         await this.archive.setData('analysis/table', table);
-        await this.archive.setData('analysis/violations', allViolations);
+        await this.archive.replaceAnalysisViolations(allViolations);
     }
     /**
      * Loads and caches the plugin configuration from the user's config file.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nitpicker/core",
-	"version": "0.12.0",
+	"version": "0.13.0",
 	"description": "Plugin-based page analysis engine for Nitpicker",
 	"author": "D-ZERO",
 	"license": "Apache-2.0",
@@ -27,13 +27,13 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/dealer": "1.9.3",
-		"@d-zero/shared": "0.22.1",
-		"@nitpicker/crawler": "0.12.0",
-		"@nitpicker/types": "0.12.0",
+		"@d-zero/dealer": "1.9.4",
+		"@d-zero/shared": "0.22.2",
+		"@nitpicker/crawler": "0.13.0",
+		"@nitpicker/types": "0.13.0",
 		"ansi-colors": "4.1.3",
 		"cosmiconfig": "9.0.2",
 		"jsdom": "29.1.1"
 	},
-	"gitHead": "58b68416e0b6e3dcdd92772bee754f186a35505f"
+	"gitHead": "2cd462ea6b183f4462b7caba27b4db04aaba7c70"
 }