revisionを生成するスクリプトを作成

Author: na-trium-144

app/lib/docs.ts

@@ -4,12 +4,15 @@ import { join } from "node:path";
 import yaml from "js-yaml";
 import { isCloudflare } from "./detectCloudflare";
 import { notFound } from "next/navigation";
+import crypto from "node:crypto";
 
 export interface MarkdownSection {
+  file: string; // ファイル名
   id: string;
   level: number;
   title: string;
   rawContent: string; // 見出しも含めたもとのmarkdownの内容
+  md5: string; // mdファイル全体のmd5
 }
 
 export interface PageEntry {
@@ -36,6 +39,17 @@ interface IndexYml {
   }[];
 }
 
+export interface RevisionYmlEntry {
+  lang?: string;
+  page?: string;
+  rev: SectionRevision[];
+}
+export interface SectionRevision {
+  md5: string; // mdファイル全体のmd5
+  commit: string;
+  path: string;
+}
+
 async function readPublicFile(path: string): Promise<string> {
   try {
     if (isCloudflare()) {
@@ -119,6 +133,16 @@ export async function getSectionsList(
       .sort(naturalSortMdFiles);
   }
 }
+
+export async function getRevisions(
+  sectionId: string
+): Promise<RevisionYmlEntry | undefined> {
+  const revisionsYml = await readPublicFile(`docs/revisions.yml`);
+  return (yaml.load(revisionsYml) as Record<string, RevisionYmlEntry>)[
+    sectionId
+  ];
+}
+
 /**
  * public/docs/{lang}/{pageId}/ 以下のmdファイルを結合して MarkdownSection[] を返す。
  */
@@ -134,10 +158,12 @@ export async function getMarkdownSections(
     if (file === "-intro.md") {
       // イントロセクションはフロントマターなし・見出しなし
       sections.push({
+        file,
         id: `${lang}-${pageId}-intro`,
         level: 1,
         title: "",
         rawContent: raw,
+        md5: "",
       });
     } else {
       sections.push(parseFrontmatter(raw, file));
@@ -166,9 +192,39 @@ function parseFrontmatter(content: string, file: string): MarkdownSection {
   // TODO: validation of frontmatter using zod
   const rawContent = content.slice(endIdx + 5);
   return {
+    file,
     id: fm?.id ?? "",
     title: fm?.title ?? "",
     level: fm?.level ?? 2,
     rawContent,
+    md5: crypto.createHash("md5").update(content).digest("base64"),
   };
 }
+
+export async function getRevisionOfMarkdownSection(
+  sectionId: string,
+  md5: string
+): Promise<MarkdownSection> {
+  const revisions = await getRevisions(sectionId);
+  const targetRevision = revisions?.rev.find((r) => r.md5 === md5);
+  if (targetRevision) {
+    const rawRes = await fetch(
+      `https://raw.githubusercontent.com/ut-code/my-code/${targetRevision.commit}/${targetRevision.path}`
+    );
+    if (rawRes.ok) {
+      const raw = await rawRes.text();
+      return parseFrontmatter(
+        raw,
+        `${targetRevision.commit}/${targetRevision.path}`
+      );
+    } else {
+      throw new Error(
+        `Failed to fetch ${targetRevision.commit}/${targetRevision.path}. ${rawRes.status}: ${await rawRes.text()}`
+      );
+    }
+  } else {
+    throw new Error(
+      `Revision for sectionId=${sectionId}, md5=${md5} not found`
+    );
+  }
+}

public/docs/ruby/6-classes/3-0-accessor.md

@@ -1,6 +1,6 @@
 ---
 id: ruby-classes-accessor
-title: '🔐 アクセサメソッド
+title: '🔐 アクセサメソッド'
 level: 2
 ---
 

scripts/updateDocsRevisions.ts

@@ -0,0 +1,75 @@
+import { readFile, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import {
+  getMarkdownSections,
+  getPagesList,
+  RevisionYmlEntry,
+} from "@/lib/docs";
+import yaml from "js-yaml";
+import { execFileSync } from "node:child_process";
+import { existsSync } from "node:fs";
+
+const docsDir = join(process.cwd(), "public", "docs");
+
+const commit = execFileSync("git", ["rev-parse", "--short", "HEAD"], {
+  encoding: "utf8",
+}).trim();
+
+const langEntries = await getPagesList();
+
+const revisionsPrevYml = existsSync(join(docsDir, "revisions.yml"))
+  ? await readFile(join(docsDir, "revisions.yml"), "utf-8")
+  : "{}";
+const revisions = yaml.load(revisionsPrevYml) as Record<
+  string,
+  RevisionYmlEntry
+>;
+
+for (const id in revisions) {
+  delete revisions[id].lang;
+  delete revisions[id].page;
+}
+
+for (const lang of langEntries) {
+  for (const page of lang.pages) {
+    const sections = await getMarkdownSections(lang.id, page.slug);
+    for (const section of sections) {
+      if (section.file === "-intro.md") continue;
+      if (section.id in revisions) {
+        revisions[section.id].lang = lang.id;
+        revisions[section.id].page = page.slug;
+        if (!revisions[section.id].rev.some((r) => r.md5 === section.md5)) {
+          // ドキュメントが変更された場合
+          console.log(`${section.id} has new md5: ${section.md5}`);
+          revisions[section.id].rev.push({
+            md5: section.md5,
+            commit,
+            path: `public/docs/${lang.id}/${page.slug}/${section.file}`,
+          });
+        }
+      } else {
+        // ドキュメントが新規追加された場合
+        console.log(`${section.id} is new, adding to revisions.yml`);
+        revisions[section.id] = {
+          lang: lang.id,
+          page: page.slug,
+          rev: [
+            {
+              md5: section.md5,
+              commit,
+              path: `public/docs/${lang.id}/${page.slug}/${section.file}`,
+            },
+          ],
+        };
+      }
+    }
+  }
+}
+
+const revisionsYml = yaml.dump(revisions);
+await writeFile(
+  join(docsDir, "revisions.yml"),
+  "# This file will be updated by scripts/updateDocsRevisions.ts. Do not edit manually.\n" +
+    revisionsYml,
+  "utf-8"
+);