@riebeckite/plugin-diagnostics 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   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,126 @@
+# @riebeckite/plugin-diagnostics
+
+Content diagnostics for Obsidian vaults / Riebeckite content: broken links,
+frontmatter issues, orphan notes, unused assets, and more. Usable as a build
+plugin, a programmatic API, and a CLI.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`diagnostics()` analyzes the content directory and reports problems as
+diagnostics during the build. The same checks are available through
+`runDiagnostics()` and the `riebeckite-diagnostics` CLI.
+
+## Usage (plugin)
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { diagnostics } from "@riebeckite/plugin-diagnostics";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    diagnostics({
+      reportUnusedAssets: true,
+      reportOrphans: true,
+      requiredFrontmatter: ["title"],
+    }),
+  ],
+});
+```
+
+- `addDiagnostics` — runs the analysis at build time; results go to
+  `manifest.diagnostics`
+- `onBuildEnd` — with `failOnError: true`, throws `DiagnosticsFailure` when
+  error-level diagnostics exist
+
+## Checks
+
+| Code | Default severity | What it detects |
+| ---- | ---------------- | --------------- |
+| `broken-wikilink` | `error` | Wikilink target or fragment does not resolve |
+| `broken-image` | `error` | Embedded image or image link does not exist |
+| `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 |
+| `publish-conflict` | `warning` | `publish: true` combined with `draft: true` / `private: true` |
+| `duplicate-title` | `warning` | Multiple published notes share a title |
+| `slug-collision` | `error` | Slugs collide case-insensitively |
+| `excluded-public` | `warning` | Excluded note is marked `publish: true` |
+| `publish-boundary` | `warning` | Published content links to or embeds non-published content |
+| `internal-error` | `error` | Content analysis failed |
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `failOnError` | `boolean` | `false` | Fail the build on error-level diagnostics |
+| `reportUnusedAssets` | `boolean` | `false` | Report unreferenced images |
+| `reportOrphans` | `boolean` | `false` | Report published notes without incoming links |
+| `requiredFrontmatter` | `string[]` | `[]` | Required frontmatter fields |
+| `severity` | `Partial<Record<DiagnosticCode, DiagnosticSeverity>>` | table above | Override severity per code |
+| `exclude` | `string[]` | `[]` | Extra exclude globs |
+| `publishStrategy` | `"explicit" \| "selective"` | from config | Publication filter strategy |
+
+## CLI
+
+```bash
+riebeckite-diagnostics --config riebeckite.config.ts
+riebeckite-diagnostics --content ./content --report-orphans
+```
+
+| Option | Description |
+| ------ | ----------- |
+| `--config <path>` | Path to `riebeckite.config.ts` (loaded under tsx) |
+| `--content <dir>` | Content directory to analyze (default: `.`) |
+| `--exclude <glob>` | Extra exclude glob (repeatable) |
+| `--publish-strategy <mode>` | `explicit` \| `selective` (default: `selective`) |
+| `--report-unused-assets` | Report images never referenced by any note |
+| `--report-orphans` | Report published notes with no incoming links |
+| `--required-frontmatter <f>` | Comma-separated required frontmatter fields |
+| `--fail-on-error` | Exit with code 1 when errors are found (default) |
+| `--exit-on <severity>` | Exit with code 1 at/above severity (`info` \| `warning` \| `error`) |
+| `--format <text\|json>` | Output format (default: `text`) |
+| `--no-color` | Disable ANSI colors |
+| `-h`, `--help` | Show help |
+
+Exit codes: `0` no errors, `1` errors reported (or `--exit-on` threshold met),
+`2` invalid arguments.
+
+With `--config`, options from the config's `diagnostics` plugin are used as
+defaults; explicit CLI flags override them, and `exclude` lists are merged.
+
+## Programmatic API
+
+```ts
+import {
+  assertNoErrors,
+  formatDiagnostics,
+  runDiagnostics,
+} from "@riebeckite/plugin-diagnostics";
+
+const report = await runDiagnostics("./content", { reportOrphans: true });
+console.log(formatDiagnostics(report));
+assertNoErrors(report);
+```
+
+`runDiagnostics(config | path, options?)` returns a `DiagnosticsReport` with
+`diagnostics`, `errors`, `warnings`, `infos`, `hasErrors`, `hasWarnings`,
+`summary`, and `byCode`.
+
+## Exports
+
+- `diagnostics(options?)` / `diagnosticsPlugin` — plugin factory
+- `runDiagnostics(target, options?)` — run the analysis directly
+- `analyzeContent(config, options?)` — raw analysis returning `Diagnostic[]`
+- Report helpers: `buildReport`, `formatDiagnostics`, `groupByCode`,
+  `summarize`, `assertNoErrors`, `DiagnosticsFailure`
+- Types: `DiagnosticsOptions`, `DiagnosticsReport`, `DiagnosticsSummary`,
+  `AnalyzerContentConfig`
+- CLI: `riebeckite-diagnostics`
+
+## See also
+
+- [Plugin guide](../../docs/plugins_en.md)

package/README_ja.md

@@ -0,0 +1,98 @@
+# @riebeckite/plugin-diagnostics
+
+コンテンツのリンク切れ、公開設定の矛盾、frontmatter の不足などを検出するプラグインです。ビルド時の診断だけでなく、CLI とプログラムからの実行にも対応します。
+
+[English](./README.md)
+
+## まずはビルドに診断を加える
+
+通常は `diagnostics()` を設定に登録します。診断結果は manifest に入り、`failOnError` を有効にするとエラーがあったビルドを失敗させられます。
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { diagnostics } from "@riebeckite/plugin-diagnostics";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    diagnostics({
+      reportUnusedAssets: true,
+      reportOrphans: true,
+      requiredFrontmatter: ["title"],
+    }),
+  ],
+});
+```
+
+## 検出する問題
+
+| コード | 既定の重要度 | 内容 |
+| --- | --- | --- |
+| `broken-wikilink` | error | Wikiリンクの参照先またはフラグメントを解決できない |
+| `broken-image` | error | 埋め込み画像または画像リンクの参照先がない |
+| `broken-link` | error | Markdown リンクが存在しない、または除外されたノートを指す |
+| `unused-asset` | warning | どのノートからも参照されない画像 |
+| `orphan-note` | info | 公開ノートのうち、他のノートからリンクされていないもの |
+| `missing-frontmatter` | warning | frontmatter がない、または必須フィールドが欠けている |
+| `publish-conflict` | warning | `publish: true` と `draft: true` または `private: true` が同居している |
+| `duplicate-title` | warning | 公開ノート同士でタイトルが重複している |
+| `slug-collision` | error | 大文字・小文字を区別しない slug が衝突している |
+| `excluded-public` | warning | 除外されたノートに `publish: true` が指定されている |
+| `publish-boundary` | warning | 公開コンテンツから非公開コンテンツへリンク・埋め込みしている |
+| `internal-error` | error | コンテンツ解析中に処理できないエラーが発生した |
+
+未使用アセットと孤立ノートは、明示的に有効化した場合だけ確認します。意図的に孤立させるトップページなどがあるなら、`reportOrphans` の結果を公開方針と照らして判断してください。
+
+## 設定項目
+
+| 項目 | 既定値 | 説明 |
+| --- | --- | --- |
+| `failOnError` | `false` | error レベルの診断があればビルドを失敗させる |
+| `reportUnusedAssets` | `false` | 未参照画像を報告する |
+| `reportOrphans` | `false` | 孤立した公開ノートを報告する |
+| `requiredFrontmatter` | `[]` | 必須にする frontmatter フィールド |
+| `severity` | コードごとの既定値 | 診断コード別の重要度を上書きする |
+| `exclude` | `[]` | 解析対象から追加で除外する glob |
+| `publishStrategy` | 設定ファイルの値 | 公開ノートの判定方法 |
+
+## CI や編集時には CLI を使う
+
+設定を読み込んで実行する場合は、次のようにします。
+
+```bash
+riebeckite-diagnostics --config riebeckite.config.ts
+riebeckite-diagnostics --content ./content --report-orphans
+```
+
+`--format json` は機械処理用、`--exit-on warning` は警告以上を CI の失敗条件にしたい場合に使います。終了コードは、問題なしが `0`、指定したしきい値以上の診断があれば `1`、引数の誤りは `2` です。`--config` 使用時は設定内のオプションを既定値にし、CLI で明示した値を優先します。
+
+## アプリケーションから実行する
+
+エディタ連携や独自のレポートには `runDiagnostics()` を使えます。
+
+```ts
+import {
+  assertNoErrors,
+  formatDiagnostics,
+  runDiagnostics,
+} from "@riebeckite/plugin-diagnostics";
+
+const report = await runDiagnostics("./content", { reportOrphans: true });
+console.log(formatDiagnostics(report));
+assertNoErrors(report);
+```
+
+`DiagnosticsReport` には診断の一覧に加え、エラー・警告・情報の件数、コード別の集計、`hasErrors` と `hasWarnings` が入ります。
+
+## 主なエクスポート
+
+- `diagnostics(options?)` / `diagnosticsPlugin`: プラグインを作成する
+- `runDiagnostics(target, options?)`: 診断と集計を実行する
+- `analyzeContent(config, options?)`: 生の `Diagnostic[]` を取得する
+- `formatDiagnostics`、`summarize`、`groupByCode`、`assertNoErrors`: レポート処理用の補助関数
+- `DiagnosticsFailure`: `failOnError` または `assertNoErrors` が送出するエラー
+- `riebeckite-diagnostics`: CLI
+
+## 関連資料
+
+- [プラグインシステム](../../../docs/ja/plugin-system.md)

package/dist/bin.d.ts

@@ -0,0 +1 @@
+export declare function main(argv: string[]): Promise<number>;