introにもmd5を追加, ymlサイズ削減、page削除はエラーとする

Author: na-trium-144

app/lib/docs.ts

@@ -40,13 +40,12 @@ interface IndexYml {
 }
 
 export interface RevisionYmlEntry {
-  lang?: string;
-  page?: string;
+  page: string;
   rev: SectionRevision[];
 }
 export interface SectionRevision {
   md5: string; // mdファイル全体のmd5
-  commit: string;
+  git: string; // git上のコミットハッシュ
   path: string;
 }
 
@@ -163,7 +162,7 @@ export async function getMarkdownSections(
         level: 1,
         title: "",
         rawContent: raw,
-        md5: "",
+        md5: crypto.createHash("md5").update(raw).digest("base64"),
       });
     } else {
       sections.push(parseFrontmatter(raw, file));
@@ -197,7 +196,7 @@ function parseFrontmatter(content: string, file: string): MarkdownSection {
     title: fm?.title ?? "",
     level: fm?.level ?? 2,
     rawContent,
-    md5: crypto.createHash("md5").update(content).digest("base64"),
+    md5: crypto.createHash("md5").update(rawContent).digest("base64"),
   };
 }
 
@@ -209,17 +208,17 @@ export async function getRevisionOfMarkdownSection(
   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}`
+      `https://raw.githubusercontent.com/ut-code/my-code/${targetRevision.git}/${targetRevision.path}`
     );
     if (rawRes.ok) {
       const raw = await rawRes.text();
       return parseFrontmatter(
         raw,
-        `${targetRevision.commit}/${targetRevision.path}`
+        `${targetRevision.git}/${targetRevision.path}`
       );
     } else {
       throw new Error(
-        `Failed to fetch ${targetRevision.commit}/${targetRevision.path}. ${rawRes.status}: ${await rawRes.text()}`
+        `Failed to fetch ${targetRevision.git}/${targetRevision.path}. ${rawRes.status}: ${await rawRes.text()}`
       );
     }
   } else {

scripts/updateDocsRevisions.ts

@@ -25,25 +25,18 @@ const revisions = yaml.load(revisionsPrevYml) as Record<
   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;
+        revisions[section.id].page = `${lang.id}/${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,
+            git: commit,
             path: `public/docs/${lang.id}/${page.slug}/${section.file}`,
           });
         }
@@ -54,22 +47,33 @@ for (const lang of langEntries) {
           rev: [
             {
               md5: section.md5,
-              commit,
+              git: commit,
               path: `public/docs/${lang.id}/${page.slug}/${section.file}`,
             },
           ],
-          lang: lang.id,
-          page: page.slug,
+          page: `${lang.id}/${page.slug}`,
         };
       }
     }
   }
 }
 
-const revisionsYml = yaml.dump(revisions);
+for (const id in revisions) {
+  if (!existsSync(join(docsDir, revisions[id].page))) {
+    throw new Error(
+      `The page slug ${revisions[id].page} previously used by section ${id} does not exist. ` +
+        `Please replace 'page: ${revisions[id].page}' in public/docs/revisions.yml with new page path manually.`
+    );
+  }
+}
+
+const revisionsYml = yaml.dump(revisions, {
+  sortKeys: true,
+  noArrayIndent: true,
+});
 await writeFile(
   join(docsDir, "revisions.yml"),
-  "# This file will be updated by scripts/updateDocsRevisions.ts. Do not edit manually.\n" +
+  "# This file will be updated by CI. Do not edit manually, unless CI failed.\n" +
     revisionsYml,
   "utf-8"
 );