@riebeckite/plugin-changelog 0.0.32 → 0.0.33

package/README.md

@@ -117,7 +117,7 @@ import "@riebeckite/plugin-changelog/style.css";
 ## Exports
 
 - `changelog(options?)` — plugin factory
-- `changelogPlugin` — alias of `changelog`
+- `changelog` — alias of `changelog`
 - `resolveChangelogOptions(options?)` — apply option defaults
 - `GitChangelogReader` — Git-backed history reader (`getFileHistory`,
   `getRecentCommits`, `isAvailable`)

package/README_ja.md

@@ -8,9 +8,9 @@
 
 ## できること
 
-`changelog()` は [`@riebeckite/plugin-diff`](../diff/README_ja.md) と同じ方法でローカル Git を読み取ります（`execFile` で `git` を実行し、失敗時は安全に縮退）。独自のファイルシステム層は作りません。
+`changelog()` は [`@riebeckite/plugin-diff`](../diff/README_ja.md) と同じ方法でローカル Git を読み取ります（`execFile` で `git` を実行し、失敗時は安全に縮退します）。独自のファイルシステム層は作りません。
 
-結果はプラグインの組み込み HTML レンダラーを通じて公開されます。公開エントリはそれぞれ変更履歴セクションを受け取り、サイト側のレイアウトが描画するかどうかを決めます。`siteWide` を有効にすると、サイト全体の変更履歴データセットがビルドされ、アプリが自身で描画できます。プラグインは manifest entry に markup を注入しません。描画する変更履歴セクションは Site が選びます。クライアントスクリプトは登録しません。
+結果はプラグインの組み込み HTML レンダラーを通じて公開されます。公開エントリはそれぞれ変更履歴セクションを受け取り、サイト側のレイアウトが描画するかどうかを決めます。`siteWide` を有効にすると、サイト全体の変更履歴データセットがビルドされ、アプリが自身で描画できます。プラグインはマニフェストエントリにマークアップを挿入しません。描画する変更履歴セクションはサイト側が選びます。クライアントスクリプトは登録しません。
 
 ## 使い方
 
@@ -22,7 +22,7 @@ export default defineConfig({
   // ...
   plugins: [
     changelog({
-      // ノートのリポジトリ上のパスが見えるよう、コンテンツのルートを指定します。
+      // Git からノートのリポジトリ上のパスが見えるよう、コンテンツルートを指定します。
       cwd: "./content",
       lookbackDays: 180,
       dateFormat: "iso",
@@ -33,7 +33,7 @@ export default defineConfig({
 
 ## オプション
 
-| オプション | 型 | 初期値 | 説明 |
+| オプション | 型 | 既定値 | 説明 |
 | --- | --- | --- | --- |
 | `cwd` | `string` | `config.content.directory`、無ければ `process.cwd()` | Git リポジトリを探すためのコンテンツルート |
 | `lookbackDays` | `number` | なし（全履歴） | 直近この日数以内のコミットだけを含める |
@@ -52,17 +52,17 @@ export default defineConfig({
 
 ## 表示
 
-各ノートの変更履歴セクションはビルド時の HTML として公開されます。`perNote` が有効な場合、記事の後に表示されます。サイト全体の変更履歴データセットはビルドされ、アプリが renderer を通じて描画できます。
+各ノートの変更履歴セクションはビルド時の HTML として公開されます。`perNote` が有効な場合、記事の後に表示されます。サイト全体の変更履歴データセットはビルドされ、アプリがエクスポートされたレンダラーを使って描画できます。
 
-`data-changelog-note` と `data-changelog-site` は、2 種類の断片をスタイリングと重複防止のために識別する属性です。
+`data-changelog-note` と `data-changelog-site` は、スタイリングと冪等性チェックのために 2 種類の断片を識別する属性です。
 
-## アプリ側の接続（サイト全体の変更履歴）
+## アプリへの組み込み（サイト全体の変更履歴）
 
-サイト全体の一覧はページではなくデータです。ルートはアプリが所有します。プラグインはデータセットを生成し、アプリがエクスポートされた renderer を使って描画します。
+サイト全体の一覧はページではなくデータです。ルートはアプリが所有します。プラグインはデータセットを生成し、アプリがエクスポートされたレンダラーを使って描画します。
 
 ## 失敗時の挙動
 
-`git` を起動できない場合は `changelog-git-unavailable` 警告診断、コンテンツディレクトリが Git ワーキングツリーの外にある場合は `changelog-content-outside-repository` 警告診断を出し、どちらの場合もロガー警告を伴い、ビルド成果物には何も加えません。履歴が取得できないことを理由にビルドが失敗することはなく、空のリポジトリでも同じです。
+`git` を起動できない場合は `changelog-git-unavailable`、コンテンツディレクトリが Git ワーキングツリーの外にある場合は `changelog-content-outside-repository` の警告診断を出します。どちらの場合もロガーにも警告を出し、ビルド成果物には何も加えません。履歴が取得できないことを理由にビルドが失敗することはなく、空のリポジトリでも同じです。
 
 ## スタイル
 
@@ -75,7 +75,7 @@ import "@riebeckite/plugin-changelog/style.css";
 ## 公開 API
 
 - `changelog(options?)`：プラグインファクトリ
-- `changelogPlugin`：`changelog` の別名
+- `changelog`：`changelog` の別名
 - `resolveChangelogOptions(options?)`：既定値を適用
 - `GitChangelogReader`：Git 履歴リーダー（`getFileHistory`、`getRecentCommits`、`isAvailable`）
 - `buildNoteChangeHistory(entry, commits, options)`：ノート単位のデータセット

package/dist/index.d.ts

@@ -25,5 +25,3 @@ export declare const CHANGELOG_PLUGIN_NAME = "changelog";
  * is reported instead of failing.
  */
 export declare function changelog(options?: ChangelogOptions): import("@riebeckite/core").RiebeckitePlugin<ChangelogOptions>;
-/** Alias matching the `*Plugin` suffix used by other plugin factories. */
-export declare const changelogPlugin: typeof changelog;

package/dist/index.js

@@ -88,8 +88,8 @@ function resolveCommitNotes(commit, byPath, bySlug) {
 function invertContentIndex(contentIndex, entries) {
   const byPath = /* @__PURE__ */ new Map();
   for (const entry of entries) {
-    const path3 = resolveContentFilePath(contentIndex, entry.slug);
-    if (path3) byPath.set(path3, entry.slug);
+    const path = resolveContentFilePath(contentIndex, entry.slug);
+    if (path) byPath.set(path, entry.slug);
   }
   return byPath;
 }
@@ -159,149 +159,36 @@ var getChangelog = async ({ view, entry, loadCommits, options }) => {
 };
 
 // src/git/history_reader.ts
-import path2 from "node:path";
-
-// src/git/repo_paths.ts
-import path from "node:path";
-
-// src/git/run_git.ts
-import { execFile } from "node:child_process";
-import { promisify } from "node:util";
-var execFileAsync = promisify(execFile);
-function isGitCommandFailure(result) {
-  return result.ok === false;
-}
-async function runGit(args, cwd) {
-  try {
-    const { stdout } = await execFileAsync(
-      "git",
-      ["-c", "core.quotePath=false", ...args],
-      {
-        ...cwd === void 0 ? {} : { cwd },
-        maxBuffer: 1024 * 1024 * 10
-      }
-    );
-    return { ok: true, stdout };
-  } catch (error) {
-    return {
-      ok: false,
-      spawnError: isSpawnFailure(readErrorCode(error)),
-      detail: describeGitFailure(error)
-    };
-  }
-}
-function readErrorCode(error) {
-  return typeof error === "object" && error !== null && "code" in error ? error.code : void 0;
-}
-function isSpawnFailure(code) {
-  return typeof code === "string" && !code.startsWith("ERR_");
-}
-function describeGitFailure(error) {
-  if (typeof error !== "object" || error === null) {
-    return error instanceof Error ? error.message : String(error);
-  }
-  const stderr = "stderr" in error ? error.stderr : void 0;
-  if (typeof stderr === "string" && stderr.trim()) return stderr.trim();
-  if (error instanceof Error) return error.message;
-  return String(error);
-}
-
-// src/git/repo_paths.ts
-async function resolveRepositoryPaths(contentRoot) {
-  const resolvedContentRoot = path.resolve(contentRoot);
-  const result = await runGit([
-    "-C",
-    resolvedContentRoot,
-    "rev-parse",
-    "--show-toplevel",
-    "--show-prefix"
-  ]);
-  if (isGitCommandFailure(result)) {
-    return result.spawnError ? { kind: "git-unavailable", detail: result.detail } : { kind: "content-outside-repository", detail: result.detail };
-  }
-  const [toplevel, prefix] = parseRevParseOutput(result.stdout);
-  if (!toplevel) {
-    return {
-      kind: "content-outside-repository",
-      detail: "git rev-parse reported no work tree root"
-    };
-  }
-  return {
-    kind: "resolved",
-    paths: {
-      repositoryRoot: toPosixPath(path.normalize(toplevel)),
-      contentRoot: toPosixPath(resolvedContentRoot),
-      contentPrefix: toPosixPath(prefix).replace(/\/+$/, "")
-    }
-  };
-}
-function toRepositoryPath(paths, contentRelativePath) {
-  const normalized = normalizeContentPath(contentRelativePath);
-  if (!paths.contentPrefix) return normalized;
-  if (!normalized) return paths.contentPrefix;
-  return `${paths.contentPrefix}/${normalized}`;
-}
-function toContentPath(paths, repositoryRelativePath) {
-  const normalized = normalizeContentPath(repositoryRelativePath);
-  if (!normalized) return null;
-  if (!paths.contentPrefix) return normalized;
-  if (!normalized.startsWith(`${paths.contentPrefix}/`)) return null;
-  return normalized.slice(paths.contentPrefix.length + 1);
-}
-function normalizeContentPath(value) {
-  return value.replace(/\\/g, "/").replace(/^\.\//, "");
-}
-function isResolvedRepository(resolution) {
-  return resolution.kind === "resolved";
-}
-function parseRevParseOutput(stdout) {
-  const [toplevel = "", prefix = ""] = stdout.split(/\r?\n/);
-  return [toplevel.trim(), prefix.trim()];
-}
-function toPosixPath(value) {
-  return value.replace(/\\/g, "/");
-}
-
-// src/git/history_reader.ts
+import {
+  GitRepository,
+  normalizeContentPath,
+  runGit,
+  toContentPath,
+  toRepositoryPath
+} from "@riebeckite/git-history";
 var fieldSeparator = "";
 var recordSeparator = "";
 var logFormat = ["%H", "%h", "%cI", "%s", "%an"].join(fieldSeparator);
 var GitChangelogReader = class {
-  #contentRoot;
+  #repository;
   #fileCache = /* @__PURE__ */ new Map();
   #recentCache;
-  #repository;
   constructor(options = {}) {
-    this.#contentRoot = path2.resolve(options.cwd ?? process.cwd());
+    this.#repository = new GitRepository(options);
   }
   /**
    * Resolves the Git work tree that owns the content directory, or the reason
    * it cannot be resolved. Memoized: every Git query reuses the same answer.
    */
   resolveRepository() {
-    this.#repository ??= resolveRepositoryPaths(this.#contentRoot);
-    return this.#repository;
+    return this.#repository.resolve();
   }
   /** True when the content directory lives inside a Git work tree. */
-  async isAvailable() {
-    return isResolvedRepository(await this.resolveRepository());
+  isAvailable() {
+    return this.#repository.isAvailable();
   }
-  async getStateFingerprint() {
-    const repository = await this.#resolvePaths();
-    if (!repository) return null;
-    const results = await Promise.all([
-      runGit(["rev-parse", "HEAD"], repository.repositoryRoot),
-      runGit(
-        ["status", "--porcelain=v1", "--untracked-files=all"],
-        repository.repositoryRoot
-      ),
-      runGit(
-        ["for-each-ref", "--format=%(refname):%(objectname)"],
-        repository.repositoryRoot
-      )
-    ]);
-    if (results.some((result) => !result.ok)) return null;
-    return results.filter((result) => result.ok).map((result) => result.stdout).join("");
+  getStateFingerprint() {
+    return this.#repository.getStateFingerprint();
   }
   /**
    * Commit history for one file, newest first, following renames.
@@ -355,10 +242,8 @@ var GitChangelogReader = class {
     }));
   }
   /** `null` when the content directory has no readable work tree. */
-  async #resolvePaths() {
-    const resolution = await this.resolveRepository();
-    if (!isResolvedRepository(resolution)) return null;
-    return resolution.paths;
+  #resolvePaths() {
+    return this.#repository.paths();
   }
 };
 function parseCommitRecords(stdout) {
@@ -439,7 +324,6 @@ function changelog(options = {}) {
     ]
   });
 }
-var changelogPlugin = changelog;
 function validateChangelogOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -504,7 +388,6 @@ export {
   buildNoteChangeHistory,
   buildSiteChangelog,
   changelog,
-  changelogPlugin,
   filterChangelogCommits,
   formatChangelogDate,
   getChangelog,

package/dist/src/git/history_reader.d.ts

@@ -1,5 +1,5 @@
+import { type RepositoryPathsResolution } from "@riebeckite/git-history";
 import type { ChangelogCommit, GitChangelogReaderOptions } from "../types.js";
-import { type RepositoryPathsResolution } from "./repo_paths.js";
 /** Optional window applied to a Git query. */
 export type GitLogWindow = {
     /** ISO timestamp passed to `git log --since`. */

package/dist/src/options.d.ts

@@ -1,12 +1,8 @@
-import type { ChangelogDateFormat, ChangelogOptions, ResolvedChangelogOptions } from "./types.js";
-export declare const DEFAULT_CHANGELOG_DATE_FORMAT: ChangelogDateFormat;
+import type { ChangelogOptions, ResolvedChangelogOptions } from "./types.js";
 export declare const DEFAULT_CHANGELOG_LOCALE = "en";
-export declare const DEFAULT_CHANGELOG_PER_NOTE = true;
-export declare const DEFAULT_CHANGELOG_SITE_WIDE = false;
 export declare const DEFAULT_CHANGELOG_SITE_WIDE_SLUG = "changelog";
 export declare const DEFAULT_CHANGELOG_MAX_PER_NOTE = 10;
 export declare const DEFAULT_CHANGELOG_MAX_SITE_WIDE = 50;
-export declare const DEFAULT_CHANGELOG_SHOW_AUTHOR = true;
 export declare const DEFAULT_CHANGELOG_HEADING = true;
 export declare const DEFAULT_CHANGELOG_PER_NOTE_HEADING = "Change history";
 export declare const DEFAULT_CHANGELOG_SITE_WIDE_HEADING = "Changelog";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-changelog",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,8 +21,9 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "hono": "^4.12.25",
-    "@riebeckite/core": "0.0.32"
+    "@riebeckite/core": "0.0.33",
+    "@riebeckite/git-history": "0.0.33",
+    "hono": "^4.12.25"
   },
   "devDependencies": {
     "@types/node": "^24.5.2",

package/dist/src/git/repo_paths.d.ts

@@ -1,76 +0,0 @@
-/**
- * The paths that locate a content directory inside a Git work tree.
- *
- * Every field is a POSIX-separated path (`git` prints and accepts those on every
- * platform, including Windows).
- */
-export type GitRepositoryPaths = {
-    /** Work tree root reported by `git rev-parse --show-toplevel`. */
-    repositoryRoot: string;
-    /** Absolute path of the content directory. */
-    contentRoot: string;
-    /**
-     * Content directory relative to `repositoryRoot`, without a trailing slash.
-     * Empty when the content directory is the work tree root itself.
-     */
-    contentPrefix: string;
-};
-/**
- * Why Git history cannot be read for a content directory.
- *
- * The reason is modelled explicitly so a plugin can report an actionable
- * diagnostic instead of quietly rendering nothing.
- */
-export type RepositoryPathsResolution = {
-    kind: "resolved";
-    paths: GitRepositoryPaths;
-}
-/** Git is not installed, or could not be started. */
- | {
-    kind: "git-unavailable";
-    detail: string;
-}
-/** Git ran, but the content directory does not live in a work tree. */
- | {
-    kind: "content-outside-repository";
-    detail: string;
-};
-/**
- * Locates the Git work tree that owns `contentRoot`.
- *
- * Both the work tree root and the content prefix come from Git itself, so their
- * casing and symlink resolution always agree with the paths `git log` prints —
- * the reason content-relative paths can be translated without guessing.
- *
- * The work tree is resolved through `git -C <contentRoot>` rather than by
- * running Git in `contentRoot`, so a missing directory surfaces as a Git
- * failure instead of an indistinguishable spawn failure.
- */
-export declare function resolveRepositoryPaths(contentRoot: string): Promise<RepositoryPathsResolution>;
-/**
- * Translates a content-relative path into the work tree-relative path that
- * `git log` pathspecs and `git show <rev>:<path>` expect.
- */
-export declare function toRepositoryPath(paths: GitRepositoryPaths, contentRelativePath: string): string;
-/**
- * Translates a work tree-relative path printed by `git` back into a
- * content-relative path, or returns `null` when the path lies outside the
- * content directory.
- */
-export declare function toContentPath(paths: GitRepositoryPaths, repositoryRelativePath: string): string | null;
-/** Normalizes a path to the POSIX form used for content and work tree paths. */
-export declare function normalizeContentPath(value: string): string;
-/**
- * True when the content directory has a usable work tree. Narrows the
- * resolution so callers can read `paths`.
- */
-export declare function isResolvedRepository(resolution: RepositoryPathsResolution): resolution is Extract<RepositoryPathsResolution, {
-    kind: "resolved";
-}>;
-/**
- * True when history cannot be read and a reason is available. Narrows the
- * resolution so callers can read `detail`.
- */
-export declare function isRepositoryUnavailable(resolution: RepositoryPathsResolution): resolution is Exclude<RepositoryPathsResolution, {
-    kind: "resolved";
-}>;

package/dist/src/git/run_git.d.ts

@@ -1,43 +0,0 @@
-/**
- * Result of a `git` invocation.
- *
- * Failures are returned instead of thrown: a site whose Git history cannot be
- * read must still build, so every caller decides what an unavailable repository
- * means for its own output.
- */
-export type GitCommandResult = {
-    ok: true;
-    stdout: string;
-}
-/**
- * `spawnError` separates "Git could not be started" (missing or unexecutable
- * binary) from "Git ran and rejected the command" (not a work tree, unknown
- * revision, unreadable path). The distinction drives which diagnostic a
- * plugin reports.
- */
- | {
-    ok: false;
-    spawnError: boolean;
-    detail: string;
-};
-/**
- * Narrows a failed command so its failure fields can be read.
- *
- * Type predicates are used instead of `result.ok` checks throughout this
- * package because the build type-checks without `strictNullChecks`, where
- * discriminant narrowing of an inline condition does not apply.
- */
-export declare function isGitCommandFailure(result: GitCommandResult): result is Extract<GitCommandResult, {
-    ok: false;
-}>;
-/**
- * Runs `git` with `args`.
- *
- * `core.quotePath=false` keeps non-ASCII paths verbatim so the printed paths
- * match the ones the content index reports; Git otherwise escapes them into
- * octal sequences that no path lookup can resolve.
- *
- * @param cwd Directory Git runs in. Omit when the command carries its own
- *   `-C <dir>` argument.
- */
-export declare function runGit(args: readonly string[], cwd?: string): Promise<GitCommandResult>;