@riebeckite/plugin-diagnostics 0.0.18 → 0.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/README_ja.md +19 -2
- package/package.json +2 -2
package/README.md
CHANGED
package/README_ja.md
CHANGED
|
@@ -87,6 +87,22 @@ riebeckite-diagnostics --content ./content --report-orphans
|
|
|
87
87
|
|
|
88
88
|
`--format json` は機械処理用、`--exit-on warning` は警告以上を CI の失敗条件にしたい場合に使います。終了コードは、問題なしが `0`、指定したしきい値以上の診断があれば `1`、引数の誤りは `2` です。`--config` 使用時は設定内のオプションを既定値にし、CLI で明示した値を優先します。
|
|
89
89
|
|
|
90
|
+
| オプション | 内容 |
|
|
91
|
+
| --- | --- |
|
|
92
|
+
| `--config <path>` | `riebeckite.config.ts` のパス（tsx で読み込む） |
|
|
93
|
+
| `--content <dir>` | 解析するコンテンツディレクトリ（既定: `.`） |
|
|
94
|
+
| `--exclude <glob>` | 追加の除外 glob（複数指定可） |
|
|
95
|
+
| `--publish-strategy <mode>` | `explicit` \| `selective`（既定: `selective`） |
|
|
96
|
+
| `--report-unused-assets` | 未参照の画像を報告する |
|
|
97
|
+
| `--report-orphans` | 被リンクのない公開ノートを報告する |
|
|
98
|
+
| `--report-analytics-coverage` | 安定コンテンツ ID のない公開ノートを報告する（`--config` 使用時に設定で analytics プラグインが有効なら自動で有効化） |
|
|
99
|
+
| `--required-frontmatter <f>` | 必須 frontmatter フィールド（カンマ区切り） |
|
|
100
|
+
| `--fail-on-error` | error があれば終了コード 1 で終了する（既定） |
|
|
101
|
+
| `--exit-on <severity>` | 指定した重要度以上で終了コード 1（`info` \| `warning` \| `error`） |
|
|
102
|
+
| `--format <text\|json>` | 出力形式（既定: `text`） |
|
|
103
|
+
| `--no-color` | ANSI カラーを無効化する |
|
|
104
|
+
| `-h`, `--help` | ヘルプを表示する |
|
|
105
|
+
|
|
90
106
|
## アプリケーションから実行する
|
|
91
107
|
|
|
92
108
|
エディタ連携や独自のレポートには `runDiagnostics()` を使えます。
|
|
@@ -111,10 +127,11 @@ assertNoErrors(report);
|
|
|
111
127
|
- `runDiagnostics(target, options?)`: 診断と集計を実行する
|
|
112
128
|
- `analyzeContent(config, options?)`: 生の `Diagnostic[]` を取得する
|
|
113
129
|
- `hasEnabledAnalyticsPlugin(config?)`: 解決済み設定で analytics プラグインが有効かを判定する
|
|
114
|
-
- `formatDiagnostics`、`summarize`、`groupByCode`、`assertNoErrors`: レポート処理用の補助関数
|
|
130
|
+
- `formatDiagnostics`、`buildReport`、`summarize`、`groupByCode`、`assertNoErrors`: レポート処理用の補助関数
|
|
115
131
|
- `DiagnosticsFailure`: `failOnError` または `assertNoErrors` が送出するエラー
|
|
132
|
+
- 型: `DiagnosticsOptions`、`DiagnosticsReport`、`DiagnosticsSummary`、`AnalyzerContentConfig`
|
|
116
133
|
- `riebeckite-diagnostics`: CLI
|
|
117
134
|
|
|
118
135
|
## 関連資料
|
|
119
136
|
|
|
120
|
-
- [プラグインシステム](../../../docs/docs/reference/plugin-api.md)
|
|
137
|
+
- [プラグインシステム](../../../docs/docs/reference/plugin-api.ja.md)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@riebeckite/plugin-diagnostics",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.20",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"remark-parse": "^11.0.0",
|
|
21
21
|
"unified": "^11.0.5",
|
|
22
22
|
"unist-util-visit": "^5.1.0",
|
|
23
|
-
"@riebeckite/core": "0.0.
|
|
23
|
+
"@riebeckite/core": "0.0.20"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
26
|
"@types/mdast": "^4.0.4",
|