@riebeckite/plugin-changelog 0.0.29 → 0.0.31
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 +2 -2
- package/README_ja.md +3 -3
- package/dist/src/types.d.ts +3 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -50,8 +50,8 @@ export default defineConfig({
|
|
|
50
50
|
| `dateFormat` | `"iso" \| "long" \| "short"` | `"iso"` | How dates are rendered |
|
|
51
51
|
| `locale` | `string` | `"en"` | Locale for `"long"` / `"short"` dates |
|
|
52
52
|
| `perNote` | `boolean` | `true` | Add a history section to every public note |
|
|
53
|
-
| `siteWide` | `boolean` | `false` | Build
|
|
54
|
-
| `siteWideSlug` | `string` | `"changelog"` |
|
|
53
|
+
| `siteWide` | `boolean` | `false` | Build the site-wide changelog dataset |
|
|
54
|
+
| `siteWideSlug` | `string` | `"changelog"` | Slug associated with the site-wide changelog |
|
|
55
55
|
| `maxPerNote` | `number` | `10` | Maximum commits listed per note |
|
|
56
56
|
| `maxSiteWide` | `number` | `50` | Maximum commits listed site-wide |
|
|
57
57
|
| `showAuthor` | `boolean` | `true` | Show the commit author |
|
package/README_ja.md
CHANGED
|
@@ -40,8 +40,8 @@ export default defineConfig({
|
|
|
40
40
|
| `dateFormat` | `"iso" \| "long" \| "short"` | `"iso"` | 日付の表示形式 |
|
|
41
41
|
| `locale` | `string` | `"en"` | `"long"` / `"short"` のロケール |
|
|
42
42
|
| `perNote` | `boolean` | `true` | 公開ノートごとに履歴セクションを追加する |
|
|
43
|
-
| `siteWide` | `boolean` | `false` |
|
|
44
|
-
| `siteWideSlug` | `string` | `"changelog"` |
|
|
43
|
+
| `siteWide` | `boolean` | `false` | サイト全体の変更履歴データセットを生成する |
|
|
44
|
+
| `siteWideSlug` | `string` | `"changelog"` | サイト全体の変更履歴に対応する slug |
|
|
45
45
|
| `maxPerNote` | `number` | `10` | ノートごとに表示するコミット上限 |
|
|
46
46
|
| `maxSiteWide` | `number` | `50` | サイト全体で表示するコミット上限 |
|
|
47
47
|
| `showAuthor` | `boolean` | `true` | コミット作成者を表示する |
|
|
@@ -58,7 +58,7 @@ export default defineConfig({
|
|
|
58
58
|
|
|
59
59
|
## アプリ側の接続（サイト全体の変更履歴）
|
|
60
60
|
|
|
61
|
-
|
|
61
|
+
サイト全体の一覧はページではなくデータです。ルートはアプリが所有します。プラグインはデータセットを生成し、アプリがエクスポートされた renderer を使って描画します。
|
|
62
62
|
|
|
63
63
|
## 失敗時の挙動
|
|
64
64
|
|
package/dist/src/types.d.ts
CHANGED
|
@@ -21,12 +21,11 @@ export type ChangelogOptions = {
|
|
|
21
21
|
/** Render a per-note history section on every public note. Defaults to `true`. */
|
|
22
22
|
perNote?: boolean;
|
|
23
23
|
/**
|
|
24
|
-
* Build the site-wide changelog
|
|
25
|
-
*
|
|
26
|
-
* the plugin only fills its body slot.
|
|
24
|
+
* Build the site-wide changelog dataset. Defaults to `false`. The route is
|
|
25
|
+
* owned by the app; the plugin only produces the dataset.
|
|
27
26
|
*/
|
|
28
27
|
siteWide?: boolean;
|
|
29
|
-
/** Slug
|
|
28
|
+
/** Slug associated with the site-wide changelog. Defaults to `"changelog"`. */
|
|
30
29
|
siteWideSlug?: string;
|
|
31
30
|
/** Maximum commits listed per note. Defaults to `10`. */
|
|
32
31
|
maxPerNote?: number;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@riebeckite/plugin-changelog",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.31",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
24
|
"hono": "^4.12.25",
|
|
25
|
-
"@riebeckite/core": "0.0.
|
|
25
|
+
"@riebeckite/core": "0.0.31"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@types/node": "^24.5.2",
|