@riebeckite/plugin-diagnostics 0.0.31 → 0.0.33

package/README.md

@@ -149,7 +149,7 @@ assertNoErrors(report);
 
 ## Exports
 
-- `diagnostics(options?)` / `diagnosticsPlugin` — plugin factory
+- `diagnostics(options?)` / `diagnostics` — plugin factory
 - `runDiagnostics(target, options?)` — run the analysis directly
 - `analyzeContent(config, options?)` — raw analysis returning `Diagnostic[]`
 - `hasEnabledAnalyticsPlugin(config?)` — whether the resolved config enables the analytics plugin

package/README_ja.md

@@ -6,9 +6,9 @@
 
 [English](./README.md)
 
-## まずはビルドに診断を加える
+## ビルドに診断を組み込む
 
-通常は `diagnostics()` を設定に登録します。診断結果は manifest に入り、`failOnError` を有効にするとエラーがあったビルドを失敗させられます。
+通常は `diagnostics()` を設定に登録します。診断結果はマニフェストに入り、`failOnError` を有効にするとエラーがあったビルドを失敗させられます。
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
@@ -26,7 +26,7 @@ export default defineConfig({
 });
 ```
 
-`failOnError: true` を指定すると、`buildEnd` で error レベルの Diagnostics が残っている場合に `DiagnosticsFailure` を送出します。
+`failOnError: true` を指定すると、`buildEnd` で error レベルの診断が残っている場合に `DiagnosticsFailure` を送出します。
 
 ## 検出する問題
 
@@ -34,7 +34,7 @@ export default defineConfig({
 | --- | --- | --- |
 | `broken-wikilink` | error | Wiki リンクの参照先またはフラグメントを解決できない |
 | `broken-image` | error | 埋め込み画像または画像リンクの参照先がない |
-| `broken-link` | error | Markdown リンクが存在しない、または除外されたノートを指す |
+| `broken-link` | error | Markdown リンクが存在しない、または除外されたノートやファイルを指す |
 | `unused-asset` | warning | どのノートからも参照されない画像 |
 | `orphan-note` | info | 公開ノートのうち、他のノートからリンクされていないもの |
 | `missing-frontmatter` | warning | 必須フィールドが欠けている |
@@ -45,9 +45,9 @@ export default defineConfig({
 | `invalid-content-id` | error | `id` の frontmatter が安定コンテンツ ID の要件を満たしていない |
 | `excluded-public` | warning | 除外されたノートに `publish: true` が指定されている |
 | `publish-boundary` | warning | 公開コンテンツから非公開コンテンツへリンク・埋め込みしている |
-| `analytics-untracked` | info | 安定 `id` のない公開ノートは analytics プラグインで計測されない（`reportAnalyticsCoverage` で有効化。設定で analytics プラグインが有効な場合は自動で有効化） |
+| `analytics-untracked` | info | 安定した `id` を持たない公開ノートは analytics プラグインで計測されない（`reportAnalyticsCoverage` で有効化。設定で analytics プラグインが有効な場合は自動的に有効） |
 | `content-integrity:broken-link` | warning | 公開ページが、公開または登録されていないサイト内経路へリンクしている |
-| `content-integrity:unresolved-wikilink` | warning | 公開ページ内の Wiki リンクを、設定済みの解決規則で解決できない |
+| `content-integrity:unresolved-wikilink` | warning | 公開ページ内の Wiki リンクを、設定済みの WikiLink / コンテンツインデックスの解決規則で解決できない |
 | `content-integrity:broken-asset` | warning | 公開ページが、解決済みアセット・プラグインアセット・生成出力・公開経路のいずれにもないローカルアセットを参照している |
 | `content-integrity:duplicate-public-location` | error | 複数の公開コンテンツまたは生成経路が、同じ最終公開パスを所有している |
 | `content-integrity:redirect-target-missing` | warning | 公開リダイレクトの転送先コンテンツが公開されない |
@@ -59,11 +59,11 @@ export default defineConfig({
 
 ## サイト全体の参照整合性
 
-Riebeckite のプラグインとして使う場合、リンク関係の検査はコンテンツを再走査せず、解決済み manifest から行います。`publicEntries`、解決済み `ContentLink`、`ContentPublicLocation`、`publicRedirects`、プラグインページのパス、プラグインアセット、生成出力を参照します。これにより permalink、alias、rename によるリダイレクト、l10n、公開・除外設定、Page System の扱いがビルド処理と揃います。
+Riebeckite のプラグインとして使う場合、リンク関係の検査はコンテンツを再走査せず、解決済みマニフェストから行います。`publicEntries`、解決済み `ContentLink`、`ContentPublicLocation`、`publicRedirects`、プラグインページのパス、プラグインアセット、生成出力を参照します。これにより、パーマリンク、エイリアス、リネームによるリダイレクト、l10n、公開・除外設定、Page System の扱いがビルド処理と一致します。
 
 外部 URL の疎通確認、SEO、スペルチェック、Lighthouse、自動修復は行いません。`http:`、`https:`、`mailto:`、`tel:`、`data:`、プロトコル相対 URL、ページ内フラグメントだけのリンクは対象外です。経路の存在確認では、クエリ文字列とフラグメントを除いて判定します。生成ページや生成アセットを提供するプラグインは、Page Type、生成出力、アセット登録の既存の仕組みを使ってください。登録されていれば、整合性検査でも有効な公開先として扱われます。
 
-`runDiagnostics()` と単体 CLI は、完全な manifest を持たないため、従来の content source 解析を使います。そのため `orphan-note` と `unused-asset` は `runDiagnostics()` と単体 CLI でのみ報告されます。ビルド時はリンク関係を manifest から解決するため、これらは出力しません。
+`runDiagnostics()` と単体 CLI は、完全なマニフェストを持たないため、従来のコンテンツソース解析を使います。そのため `orphan-note` と `unused-asset` は `runDiagnostics()` と単体 CLI でのみ報告されます。ビルド時はリンク関係をマニフェストから解決するので、これらは出力しません。
 
 ## 設定項目
 
@@ -78,7 +78,7 @@ Riebeckite のプラグインとして使う場合、リンク関係の検査は
 | `exclude` | `[]` | 解析対象から追加で除外する glob |
 | `publishStrategy` | 設定ファイルの値 | 公開ノートの判定方法 |
 
-## CI や編集時には CLI を使う
+## CI や編集時は CLI を使う
 
 設定を読み込んで実行する場合は、次のようにします。
 
@@ -87,7 +87,7 @@ riebeckite-diagnostics --config riebeckite.config.ts
 riebeckite-diagnostics --content ./content --report-orphans
 ```
 
-`--format json` は機械処理用、`--exit-on warning` は警告以上を CI の失敗条件にしたい場合に使います。終了コードは、問題なしが `0`、指定したしきい値以上の診断があれば `1`、引数の誤りは `2` です。`--config` 使用時は設定内のオプションを既定値にし、CLI で明示した値を優先します。
+`--format json` は機械処理用、`--exit-on warning` は警告以上を CI の失敗条件にしたい場合に使います。終了コードは、問題なしが `0`、指定したしきい値以上の診断があれば `1`、引数の誤りは `2` です。`--config` 使用時は設定内のオプションを既定値にし、CLI で明示した値を優先します。`exclude` の一覧は統合されます。
 
 | オプション | 内容 |
 | --- | --- |
@@ -121,11 +121,11 @@ console.log(formatDiagnostics(report));
 assertNoErrors(report);
 ```
 
-`DiagnosticsReport` には診断の一覧に加え、エラー・警告・情報の件数、コード別の集計、`hasErrors` と `hasWarnings` が入ります。
+`DiagnosticsReport` には診断の一覧に加え、エラー・警告・情報の件数、集計（`summary`）、コード別の集計（`byCode`）、`hasErrors`、`hasWarnings` が入ります。
 
 ## 主なエクスポート
 
-- `diagnostics(options?)` / `diagnosticsPlugin`: プラグインを作成する
+- `diagnostics(options?)` / `diagnostics`: プラグインを作成する
 - `runDiagnostics(target, options?)`: 診断と集計を実行する
 - `analyzeContent(config, options?)`: 生の `Diagnostic[]` を取得する
 - `hasEnabledAnalyticsPlugin(config?)`: 解決済み設定で analytics プラグインが有効かを判定する

package/dist/bin.js

@@ -3,7 +3,8 @@ import { fileURLToPath, pathToFileURL } from "node:url";
 import { resolveConfigModule } from "@riebeckite/core";
 
 // index.ts
-import { definePlugin, FileSystemContentSource as FileSystemContentSource2 } from "@riebeckite/core";
+import { definePlugin } from "@riebeckite/core";
+import { FileSystemContentSource as FileSystemContentSource2 } from "@riebeckite/node";
 
 // src/frontmatter.ts
 function parseFrontmatter(markdown) {
@@ -227,12 +228,12 @@ function checkExcludedPublic(source, options, diagnostics) {
 
 // src/vault.ts
 import {
-  FileSystemContentSource,
   IMAGE_EXTENSIONS,
   isAttachmentPath,
   isExcluded,
   isPublishable
 } from "@riebeckite/core";
+import { FileSystemContentSource } from "@riebeckite/node";
 var NOTE_EXTENSION = "md";
 var WIKILINK_TARGET_PATTERN = /(!)?\[\[([^\]|#^]+)(?:#(\^?[^\]|]+))?(?:\|[^\]]+)?\]\]/g;
 async function scanVault(config) {

package/dist/index.d.ts

@@ -5,7 +5,6 @@ export { assertNoErrors, buildReport, DiagnosticsFailure, formatDiagnostics, gro
 export type { AnalyzerContentConfig, DiagnosticsOptions, DiagnosticsReport, DiagnosticsSummary, } from "./src/types.js";
 export declare function runDiagnostics(target: ResolvedRiebeckiteConfig | string, options?: DiagnosticsOptions): Promise<DiagnosticsReport>;
 export declare function diagnostics(options?: DiagnosticsOptions): import("@riebeckite/core").RiebeckitePlugin<DiagnosticsOptions>;
-export declare const diagnosticsPlugin: typeof diagnostics;
 /**
  * Reports whether the resolved configuration enables the analytics plugin, so
  * the analytics coverage check turns itself on without coupling to the plugin.

package/dist/index.js

@@ -1,5 +1,6 @@
 // index.ts
-import { definePlugin, FileSystemContentSource as FileSystemContentSource2 } from "@riebeckite/core";
+import { definePlugin } from "@riebeckite/core";
+import { FileSystemContentSource as FileSystemContentSource2 } from "@riebeckite/node";
 
 // src/frontmatter.ts
 function parseFrontmatter(markdown) {
@@ -223,12 +224,12 @@ function checkExcludedPublic(source, options, diagnostics2) {
 
 // src/vault.ts
 import {
-  FileSystemContentSource,
   IMAGE_EXTENSIONS,
   isAttachmentPath,
   isExcluded,
   isPublishable
 } from "@riebeckite/core";
+import { FileSystemContentSource } from "@riebeckite/node";
 var NOTE_EXTENSION = "md";
 var WIKILINK_TARGET_PATTERN = /(!)?\[\[([^\]|#^]+)(?:#(\^?[^\]|]+))?(?:\|[^\]]+)?\]\]/g;
 async function scanVault(config) {
@@ -1435,7 +1436,6 @@ function diagnostics(options = {}) {
     }
   });
 }
-var diagnosticsPlugin = diagnostics;
 var ANALYTICS_PLUGIN_NAME = "analytics";
 var L10N_PLUGIN_NAME = "l10n";
 function hasEnabledAnalyticsPlugin(config) {
@@ -1492,7 +1492,6 @@ export {
   assertNoErrors,
   buildReport,
   diagnostics,
-  diagnosticsPlugin,
   formatDiagnostics,
   groupByCode,
   hasEnabledAnalyticsPlugin,

package/dist/src/location.d.ts

@@ -1,4 +1,4 @@
-export type SourcePosition = {
+type SourcePosition = {
     line: number;
     column: number;
 };
@@ -7,3 +7,4 @@ export declare class LineMapper {
     constructor(text: string);
     positionAt(index: number): SourcePosition;
 }
+export {};

package/dist/src/markdown_links.d.ts

@@ -1,7 +1,8 @@
-export type MarkdownReference = {
+type MarkdownReference = {
     kind: "link" | "image";
     url: string;
     line: number;
     column: number;
 };
 export declare function extractMarkdownReferences(markdown: string): MarkdownReference[];
+export {};

package/dist/src/site_integrity.d.ts

@@ -1,5 +1,6 @@
 import type { ContentManifest, Diagnostic, DiagnosticCode, DiagnosticSeverity } from "@riebeckite/core";
-export type SiteIntegrityOptions = {
+type SiteIntegrityOptions = {
     readonly severity?: Partial<Record<DiagnosticCode, DiagnosticSeverity>>;
 };
 export declare function checkSiteIntegrity(manifest: ContentManifest, options?: SiteIntegrityOptions): Diagnostic[];
+export {};

package/dist/src/vault.d.ts

@@ -11,7 +11,7 @@ export type ScannedNote = {
     excluded: boolean;
     published: boolean;
 };
-export type ScannedAsset = {
+type ScannedAsset = {
     relativePath: string;
     extension: string;
 };
@@ -25,12 +25,12 @@ export type ScanResult = {
     filePaths: Set<string>;
     targetIndex: Map<string, ResolvedTarget>;
 };
-export type TargetKind = "note" | "image" | "attachment";
-export type ResolvedTarget = {
+type TargetKind = "note" | "image" | "attachment";
+type ResolvedTarget = {
     kind: TargetKind;
     value: string;
 };
-export type WikilinkMatch = {
+type WikilinkMatch = {
     embed: boolean;
     target: string;
     fragment: string | null;
@@ -43,7 +43,6 @@ export declare function isImageTarget(target: string): boolean;
 export declare function isAssetTarget(target: string): boolean;
 export declare function resolveLocalReference(noteSlug: string, url: string): string | null;
 export declare function resolveVaultRelative(value: string): string | null;
-export declare function extractHeadings(markdown: string): Set<string>;
-export declare function extractBlockIds(markdown: string): Set<string>;
 export declare function fragmentExists(note: ScannedNote, fragment: string): boolean;
 export declare function getExtension(filePath: string): string;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-diagnostics",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,10 +17,11 @@
     "riebeckite-diagnostics": "./dist/bin.js"
   },
   "dependencies": {
+    "@riebeckite/core": "0.0.33",
+    "@riebeckite/node": "0.0.33",
     "remark-parse": "^11.0.0",
     "unified": "^11.0.5",
-    "unist-util-visit": "^5.1.0",
-    "@riebeckite/core": "0.0.31"
+    "unist-util-visit": "^5.1.0"
   },
   "devDependencies": {
     "@types/mdast": "^4.0.4",