@riebeckite/plugin-diagnostics 0.0.14 → 0.0.16

package/README.md

@@ -44,9 +44,9 @@ export default defineConfig({
 | `broken-link` | `error` | Markdown link points to a missing or excluded note/file |
 | `unused-asset` | `warning` | Image never referenced by any note (`reportUnusedAssets`) |
 | `orphan-note` | `info` | Published note has no incoming links (`reportOrphans`) |
-| `missing-frontmatter` | `warning` | No frontmatter, or required fields missing |
+| `missing-frontmatter` | `warning` | A required frontmatter field is missing |
 | `publish-conflict` | `warning` | `publish: true` combined with `draft: true` / `private: true` |
-| `duplicate-title` | `warning` | Multiple published notes share a title |
+| `duplicate-title` | `warning` | Multiple published notes share a title within the same language |
 | `slug-collision` | `error` | Slugs collide case-insensitively |
 | `duplicate-content-id` | `error` | Published notes share a stable content ID (`id`/`uid`) |
 | `invalid-content-id` | `error` | `id`/`uid` frontmatter violates the stable content ID contract |
@@ -80,7 +80,10 @@ the existing plugin output/asset contracts so integrity checks can treat them as
 valid public targets.
 
 `runDiagnostics()` and the standalone CLI still use the filesystem/content-source
-analyzer because no full manifest is available in that mode.
+analyzer because no full manifest is available in that mode. As a result,
+`orphan-note` and `unused-asset` are reported only by `runDiagnostics()` and the
+standalone CLI; during a build they are omitted because link relationships come
+from the manifest.
 
 ## Options
 
@@ -156,4 +159,5 @@ assertNoErrors(report);
 
 ## See also
 
-- [Plugin guide](../../../docs/en/reference/plugin-api.md)
+- [Plugin guide](../../../docs/en/docs/reference/plugin-api.md)
+

package/README_ja.md

@@ -28,22 +28,22 @@ export default defineConfig({
 
 | コード | 既定の重要度 | 内容 |
 | --- | --- | --- |
-| `broken-wikilink` | error | Wikiリンクの参照先またはフラグメントを解決できない |
+| `broken-wikilink` | error | Wiki リンクの参照先またはフラグメントを解決できない |
 | `broken-image` | error | 埋め込み画像または画像リンクの参照先がない |
 | `broken-link` | error | Markdown リンクが存在しない、または除外されたノートを指す |
 | `unused-asset` | warning | どのノートからも参照されない画像 |
 | `orphan-note` | info | 公開ノートのうち、他のノートからリンクされていないもの |
-| `missing-frontmatter` | warning | frontmatter がない、または必須フィールドが欠けている |
+| `missing-frontmatter` | warning | 必須フィールドが欠けている |
 | `publish-conflict` | warning | `publish: true` と `draft: true` または `private: true` が同居している |
-| `duplicate-title` | warning | 公開ノート同士でタイトルが重複している |
+| `duplicate-title` | warning | 同じ言語の公開ノート同士でタイトルが重複している |
 | `slug-collision` | error | 大文字・小文字を区別しない slug が衝突している |
 | `duplicate-content-id` | error | 公開ノート同士で安定コンテンツ ID（`id`/`uid`）が重複している |
-| `invalid-content-id` | error | `id`/`uid` の frontmatter が安定コンテンツ ID の契約を満たしていない |
+| `invalid-content-id` | error | `id`/`uid` の frontmatter が安定コンテンツ ID の要件を満たしていない |
 | `excluded-public` | warning | 除外されたノートに `publish: true` が指定されている |
 | `publish-boundary` | warning | 公開コンテンツから非公開コンテンツへリンク・埋め込みしている |
 | `analytics-untracked` | info | 安定 `id` のない公開ノートは analytics プラグインで計測されない（`reportAnalyticsCoverage` で有効化。設定で analytics プラグインが有効な場合は自動で有効化） |
 | `content-integrity:broken-link` | warning | 公開ページが、公開または登録されていないサイト内経路へリンクしている |
-| `content-integrity:unresolved-wikilink` | warning | 公開ページ内の Wikiリンクを、設定済みの解決規則で解決できない |
+| `content-integrity:unresolved-wikilink` | warning | 公開ページ内の Wiki リンクを、設定済みの解決規則で解決できない |
 | `content-integrity:broken-asset` | warning | 公開ページが、解決済みアセット・プラグインアセット・生成出力・公開経路のいずれにもないローカルアセットを参照している |
 | `content-integrity:duplicate-public-location` | error | 複数の公開コンテンツまたは生成経路が、同じ最終公開パスを所有している |
 | `content-integrity:redirect-target-missing` | warning | 公開リダイレクトの転送先コンテンツが公開されない |
@@ -57,9 +57,9 @@ export default defineConfig({
 
 Riebeckite のプラグインとして使う場合、リンク関係の検査はコンテンツを再走査せず、解決済み manifest から行います。`publicEntries`、解決済み `ContentLink`、`ContentPublicLocation`、`publicRedirects`、プラグインページのパス、プラグインアセット、生成出力を参照します。これにより permalink、alias、rename によるリダイレクト、l10n、公開・除外設定、Page System の扱いがビルド処理と揃います。
 
-外部 URL の疎通確認、SEO、スペルチェック、Lighthouse、自動修復は行いません。`http:`、`https:`、`mailto:`、`tel:`、`data:`、プロトコル相対 URL、ページ内フラグメントだけのリンクは対象外です。経路の存在確認では、クエリ文字列とフラグメントを除いて判定します。生成ページや生成アセットを提供するプラグインは、Page Type、生成出力、アセット登録の既存契約を使ってください。登録されていれば、整合性検査でも有効な公開先として扱われます。
+外部 URL の疎通確認、SEO、スペルチェック、Lighthouse、自動修復は行いません。`http:`、`https:`、`mailto:`、`tel:`、`data:`、プロトコル相対 URL、ページ内フラグメントだけのリンクは対象外です。経路の存在確認では、クエリ文字列とフラグメントを除いて判定します。生成ページや生成アセットを提供するプラグインは、Page Type、生成出力、アセット登録の既存の仕組みを使ってください。登録されていれば、整合性検査でも有効な公開先として扱われます。
 
-`runDiagnostics()` と単体 CLI は、完全な manifest を持たないため、従来の content source 解析を使います。
+`runDiagnostics()` と単体 CLI は、完全な manifest を持たないため、従来の content source 解析を使います。そのため `orphan-note` と `unused-asset` は `runDiagnostics()` と単体 CLI でのみ報告されます。ビルド時はリンク関係を manifest から解決するため、これらは出力しません。
 
 ## 設定項目
 
@@ -115,4 +115,5 @@ assertNoErrors(report);
 
 ## 関連資料
 
-- [プラグインシステム](../../../docs/ja/reference/plugin-api.md)
+- [プラグインシステム](../../../docs/ja/docs/reference/plugin-api.md)
+

package/dist/bin.js

@@ -258,6 +258,7 @@ async function scanVault(config) {
       const note = {
         relativePath: relative,
         slug,
+        language: resolveNoteLanguage(relative, config.languages),
         markdown,
         fm,
         headings: extractHeadings(markdown),
@@ -416,6 +417,12 @@ function fragmentExists(note, fragment) {
 function normalizeMarkdown(markdown) {
   return markdown.replace(/\r\n/g, "\n");
 }
+function resolveNoteLanguage(relativePath, languages) {
+  if (!languages || languages.length === 0) return void 0;
+  const segment = relativePath.split("/")[0]?.toLowerCase();
+  if (!segment) return void 0;
+  return languages.find((language) => language.toLowerCase() === segment);
+}
 function getExtension(filePath) {
   const lastSegment = filePath.split("/").pop() ?? filePath;
   const dotIndex = lastSegment.lastIndexOf(".");
@@ -444,17 +451,7 @@ function normalizeRelativePath(parts) {
 function checkFrontmatter(note, source, state, options, diagnostics) {
   const location = { slug: note.slug, filePath: note.relativePath };
   const values = note.fm.values;
-  if (!note.fm.hasFrontmatter) {
-    pushDiagnostic(
-      diagnostics,
-      options,
-      location,
-      "missing-frontmatter",
-      "note has no frontmatter",
-      note.slug,
-      "add frontmatter with the required fields"
-    );
-  } else {
+  if (note.fm.hasFrontmatter) {
     for (const field of options.requiredFrontmatter) {
       if (!hasField(values, field))
         pushDiagnostic(
@@ -467,6 +464,16 @@ function checkFrontmatter(note, source, state, options, diagnostics) {
           `add "${field}" to the frontmatter`
         );
     }
+  } else if (options.requiredFrontmatter.length > 0) {
+    pushDiagnostic(
+      diagnostics,
+      options,
+      location,
+      "missing-frontmatter",
+      "note has no frontmatter",
+      note.slug,
+      "add frontmatter with the required fields"
+    );
   }
   if (values.publish === true && values.draft === true)
     pushDiagnostic(
@@ -629,10 +636,11 @@ function checkSlugCollisions(source, options, diagnostics) {
 function checkDuplicateTitles(source, options, diagnostics) {
   const byTitle = groupNotes(
     source.includedNotes.filter((note) => note.published),
-    (note) => getNoteTitle(note.fm.values, note.slug).toLowerCase()
+    (note) => `${note.language ?? ""}\0${getNoteTitle(note.fm.values, note.slug).toLowerCase()}`
   );
-  for (const [title, notes] of byTitle) {
+  for (const [groupKey, notes] of byTitle) {
     if (notes.length < 2) continue;
+    const title = groupKey.slice(groupKey.indexOf("\0") + 1);
     const slugs = notes.map((note) => note.slug).join(", ");
     for (const note of notes)
       pushDiagnostic(
@@ -833,8 +841,10 @@ async function analyzeContent(config, options = {}) {
   checkSlugCollisions(source, normalizedOptions, diagnostics);
   checkDuplicateTitles(source, normalizedOptions, diagnostics);
   checkContentIdIntegrity(source, normalizedOptions, diagnostics);
-  checkOrphans(source, state, normalizedOptions, diagnostics);
-  checkUnusedAssets(source, state, normalizedOptions, diagnostics);
+  if (!options.skipReferenceIntegrity) {
+    checkOrphans(source, state, normalizedOptions, diagnostics);
+    checkUnusedAssets(source, state, normalizedOptions, diagnostics);
+  }
   checkExcludedPublic(source, normalizedOptions, diagnostics);
   if (!options.skipReferenceIntegrity)
     checkPublishBoundary(source, normalizedOptions, diagnostics);
@@ -978,6 +988,7 @@ async function runDiagnostics(target, options = {}) {
   }
 }
 var ANALYTICS_PLUGIN_NAME = "analytics";
+var L10N_PLUGIN_NAME = "l10n";
 function hasEnabledAnalyticsPlugin(config) {
   return config?.plugins.some(
     (plugin) => plugin.name === ANALYTICS_PLUGIN_NAME && plugin.enabled !== false
@@ -1007,9 +1018,19 @@ function toAnalyzerConfig(target, options) {
       target.content.exclude
     ),
     exclude: [...target.content.exclude, ...options.exclude ?? []],
-    publishStrategy: target.content.filters.publishStrategy
+    publishStrategy: target.content.filters.publishStrategy,
+    languages: resolveLanguages(target)
   };
 }
+function resolveLanguages(config) {
+  const plugin = config.plugins.find(
+    (entry) => entry.name === L10N_PLUGIN_NAME && entry.enabled !== false
+  );
+  const languages = plugin?.options?.languages;
+  return Array.isArray(languages) ? languages.filter(
+    (language) => typeof language === "string"
+  ) : [];
+}
 
 // bin.ts
 var HELP = `riebeckite-diagnostics

package/dist/index.js

@@ -254,6 +254,7 @@ async function scanVault(config) {
       const note = {
         relativePath: relative,
         slug,
+        language: resolveNoteLanguage(relative, config.languages),
         markdown,
         fm,
         headings: extractHeadings(markdown),
@@ -412,6 +413,12 @@ function fragmentExists(note, fragment) {
 function normalizeMarkdown(markdown) {
   return markdown.replace(/\r\n/g, "\n");
 }
+function resolveNoteLanguage(relativePath, languages) {
+  if (!languages || languages.length === 0) return void 0;
+  const segment = relativePath.split("/")[0]?.toLowerCase();
+  if (!segment) return void 0;
+  return languages.find((language) => language.toLowerCase() === segment);
+}
 function getExtension(filePath) {
   const lastSegment = filePath.split("/").pop() ?? filePath;
   const dotIndex = lastSegment.lastIndexOf(".");
@@ -440,17 +447,7 @@ function normalizeRelativePath(parts) {
 function checkFrontmatter(note, source, state, options, diagnostics2) {
   const location = { slug: note.slug, filePath: note.relativePath };
   const values = note.fm.values;
-  if (!note.fm.hasFrontmatter) {
-    pushDiagnostic(
-      diagnostics2,
-      options,
-      location,
-      "missing-frontmatter",
-      "note has no frontmatter",
-      note.slug,
-      "add frontmatter with the required fields"
-    );
-  } else {
+  if (note.fm.hasFrontmatter) {
     for (const field of options.requiredFrontmatter) {
       if (!hasField(values, field))
         pushDiagnostic(
@@ -463,6 +460,16 @@ function checkFrontmatter(note, source, state, options, diagnostics2) {
           `add "${field}" to the frontmatter`
         );
     }
+  } else if (options.requiredFrontmatter.length > 0) {
+    pushDiagnostic(
+      diagnostics2,
+      options,
+      location,
+      "missing-frontmatter",
+      "note has no frontmatter",
+      note.slug,
+      "add frontmatter with the required fields"
+    );
   }
   if (values.publish === true && values.draft === true)
     pushDiagnostic(
@@ -625,10 +632,11 @@ function checkSlugCollisions(source, options, diagnostics2) {
 function checkDuplicateTitles(source, options, diagnostics2) {
   const byTitle = groupNotes(
     source.includedNotes.filter((note) => note.published),
-    (note) => getNoteTitle(note.fm.values, note.slug).toLowerCase()
+    (note) => `${note.language ?? ""}\0${getNoteTitle(note.fm.values, note.slug).toLowerCase()}`
   );
-  for (const [title, notes] of byTitle) {
+  for (const [groupKey, notes] of byTitle) {
     if (notes.length < 2) continue;
+    const title = groupKey.slice(groupKey.indexOf("\0") + 1);
     const slugs = notes.map((note) => note.slug).join(", ");
     for (const note of notes)
       pushDiagnostic(
@@ -829,8 +837,10 @@ async function analyzeContent(config, options = {}) {
   checkSlugCollisions(source, normalizedOptions, diagnostics2);
   checkDuplicateTitles(source, normalizedOptions, diagnostics2);
   checkContentIdIntegrity(source, normalizedOptions, diagnostics2);
-  checkOrphans(source, state, normalizedOptions, diagnostics2);
-  checkUnusedAssets(source, state, normalizedOptions, diagnostics2);
+  if (!options.skipReferenceIntegrity) {
+    checkOrphans(source, state, normalizedOptions, diagnostics2);
+    checkUnusedAssets(source, state, normalizedOptions, diagnostics2);
+  }
   checkExcludedPublic(source, normalizedOptions, diagnostics2);
   if (!options.skipReferenceIntegrity)
     checkPublishBoundary(source, normalizedOptions, diagnostics2);
@@ -985,7 +995,8 @@ var DEFAULT_SEVERITY2 = {
   "content-integrity:duplicate-public-location": "error",
   "content-integrity:redirect-target-missing": "warning",
   "content-integrity:redirect-cycle": "error",
-  "content-integrity:redirect-public-location-conflict": "error"
+  "content-integrity:redirect-public-location-conflict": "error",
+  "content-integrity:ambiguous-folder-page-owner": "warning"
 };
 function checkSiteIntegrity(manifest, options = {}) {
   const diagnostics2 = [];
@@ -999,8 +1010,9 @@ function checkSiteIntegrity(manifest, options = {}) {
     checkResolvedLinks(entry, publicSlugs, assetPaths, diagnostics2, options);
     checkHtmlReferences(entry, publicRoutes, assetPaths, diagnostics2, options);
   }
-  checkRedirectTargets(manifest, publicRoutes, diagnostics2, options);
+  checkRedirectTargets(manifest, diagnostics2, options);
   checkRedirectCycles(manifest, diagnostics2, options);
+  checkAmbiguousFolderPageOwners(manifest, diagnostics2, options);
   return diagnostics2;
 }
 function buildRouteOwners(manifest, diagnostics2, options) {
@@ -1019,14 +1031,24 @@ function buildRouteOwners(manifest, diagnostics2, options) {
       kind: "redirect"
     });
   }
-  const pagePaths = manifest.pagePaths ?? [];
-  for (const path of pagePaths) {
+  const pageRoutes = manifest.pageRoutes ?? [];
+  for (const route of pageRoutes) {
     reserveRoute(owners, diagnostics2, options, {
-      path: normalizeRoutePath(path),
-      slug: "(plugin-page)",
-      kind: "page"
+      path: normalizeRoutePath(route.pathname),
+      slug: `(plugin-page:${route.pluginName}:${route.pageType})`,
+      kind: "page",
+      producer: `${route.pluginName}:${route.pageType}`
     });
   }
+  if (pageRoutes.length === 0) {
+    for (const path of manifest.pagePaths ?? []) {
+      reserveRoute(owners, diagnostics2, options, {
+        path: normalizeRoutePath(path),
+        slug: "(plugin-page)",
+        kind: "page"
+      });
+    }
+  }
   for (const output of manifest.generatedOutputs ?? []) {
     reserveRoute(owners, diagnostics2, options, {
       path: normalizeRoutePath(output.path),
@@ -1139,11 +1161,12 @@ function checkHtmlReferences(entry, publicRoutes, assetPaths, diagnostics2, opti
     );
   }
 }
-function checkRedirectTargets(manifest, publicRoutes, diagnostics2, options) {
-  for (const [path, redirect] of manifest.publicRedirects) {
+function checkRedirectTargets(manifest, diagnostics2, options) {
+  for (const [path, redirect] of manifest.redirects) {
     const owner = manifest.bySlug.get(redirect.slug);
     const target = owner ? normalizeRoutePath(owner.publicLocation.permalink) : null;
-    if (target && publicRoutes.has(target)) continue;
+    if (target && manifest.byRoutablePermalink.get(target)?.slug === redirect.slug)
+      continue;
     diagnostics2.push(
       diagnostic(options, {
         code: "content-integrity:redirect-target-missing",
@@ -1253,7 +1276,43 @@ function normalizeRoutePath(value) {
   return path === "/" ? path : path.replace(/\/$/, "");
 }
 function describeOwner(owner) {
-  return `${owner.kind} "${owner.slug}"`;
+  return `${owner.kind} "${owner.producer ?? owner.slug}"`;
+}
+function checkAmbiguousFolderPageOwners(manifest, diagnostics2, options) {
+  const candidates = /* @__PURE__ */ new Map();
+  for (const entry of manifest.entries) {
+    const basename = entry.slug.split("/").at(-1);
+    if (basename !== "README" && basename !== "index") continue;
+    const folder = entry.slug.split("/").slice(0, -1).join("/");
+    if (!folder) continue;
+    const folderCandidates = candidates.get(folder) ?? {};
+    folderCandidates[basename] = entry;
+    candidates.set(folder, folderCandidates);
+  }
+  for (const [folder, entries] of candidates) {
+    const readme = entries.README;
+    const index = entries.index;
+    if (!readme || !index) continue;
+    diagnostics2.push(
+      diagnostic(options, {
+        code: "content-integrity:ambiguous-folder-page-owner",
+        target: folder,
+        message: `Folder "${folder}" has both README and index Folder Page candidates.`,
+        suggestion: "Keep either README or index so the Folder Page owner is unambiguous.",
+        meta: {
+          folder,
+          readme: {
+            slug: readme.slug,
+            permalink: readme.publicLocation.permalink
+          },
+          index: {
+            slug: index.slug,
+            permalink: index.publicLocation.permalink
+          }
+        }
+      })
+    );
+  }
 }
 function canonicalCycleKey(cycle) {
   const closed = cycle.at(0) === cycle.at(-1) ? cycle.slice(0, -1) : [...cycle];
@@ -1314,6 +1373,7 @@ function diagnostics(options = {}) {
 }
 var diagnosticsPlugin = diagnostics;
 var ANALYTICS_PLUGIN_NAME = "analytics";
+var L10N_PLUGIN_NAME = "l10n";
 function hasEnabledAnalyticsPlugin(config) {
   return config?.plugins.some(
     (plugin) => plugin.name === ANALYTICS_PLUGIN_NAME && plugin.enabled !== false
@@ -1349,9 +1409,19 @@ function toAnalyzerConfig(target, options) {
       target.content.exclude
     ),
     exclude: [...target.content.exclude, ...options.exclude ?? []],
-    publishStrategy: target.content.filters.publishStrategy
+    publishStrategy: target.content.filters.publishStrategy,
+    languages: resolveLanguages(target)
   };
 }
+function resolveLanguages(config) {
+  const plugin = config.plugins.find(
+    (entry) => entry.name === L10N_PLUGIN_NAME && entry.enabled !== false
+  );
+  const languages = plugin?.options?.languages;
+  return Array.isArray(languages) ? languages.filter(
+    (language) => typeof language === "string"
+  ) : [];
+}
 export {
   DiagnosticsFailure,
   analyzeContent,

package/dist/src/types.d.ts

@@ -31,4 +31,5 @@ export type AnalyzerContentConfig = {
     source?: ContentSource;
     exclude: string[];
     publishStrategy: "explicit" | "selective";
+    languages?: readonly string[];
 };

package/dist/src/vault.d.ts

@@ -3,6 +3,7 @@ import type { AnalyzerContentConfig } from "./types.js";
 export type ScannedNote = {
     relativePath: string;
     slug: string;
+    language?: string;
     markdown: string;
     fm: ParsedFrontmatter;
     headings: Set<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-diagnostics",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -20,7 +20,7 @@
     "remark-parse": "^11.0.0",
     "unified": "^11.0.5",
     "unist-util-visit": "^5.1.0",
-    "@riebeckite/core": "0.0.14"
+    "@riebeckite/core": "0.0.16"
   },
   "devDependencies": {
     "@types/mdast": "^4.0.4",