Merge pull request #198 from ut-code/add-sitemap

sitemap, robots.txt, commits.ymlを追加

Author: na-trium-144

app/lib/docs.ts

@@ -95,6 +95,9 @@ export interface RevisionYmlEntry {
    * `langId/pageSlug`
    */
   page: string;
+  /**
+   * revisionのリストは末尾が最新のはず。
+   */
   rev: SectionRevision[];
 }
 export interface SectionRevision {
@@ -184,6 +187,25 @@ export async function getRevisions(
   ];
 }
 
+const commitDateCache = new Map<string, Promise<Date>>();
+export async function getCommitDate(id: string): Promise<Date> {
+  if (commitDateCache.has(id)) {
+    return commitDateCache.get(id)!;
+  }
+  const p = (async () => {
+    const commitInfoYml = await readPublicFile(`docs/commits.yml`);
+    const commitInfo = yaml.load(commitInfoYml) as Record<string, string>;
+    const timestamp = commitInfo[id];
+    if (timestamp) {
+      return new Date(timestamp);
+    } else {
+      throw new Error(`Commit date for id=${id} not found`);
+    }
+  })();
+  commitDateCache.set(id, p);
+  return p;
+}
+
 /**
  * public/docs/{lang}/{pageId}/ 以下のmdファイルを結合して MarkdownSection[] を返す。
  */

app/robots.ts

@@ -0,0 +1,15 @@
+import type { MetadataRoute } from "next";
+
+export const dynamic = "force-static";
+
+const origin = "https://my-code.utcode.net";
+
+export default function robots(): MetadataRoute.Robots {
+  return {
+    rules: {
+      userAgent: "*",
+      allow: "/",
+    },
+    sitemap: `${origin}/sitemap.xml`,
+  };
+}

app/sitemap.ts

@@ -0,0 +1,53 @@
+import type { MetadataRoute } from "next";
+import {
+  getCommitDate,
+  getMarkdownSections,
+  getPagesList,
+  getRevisions,
+} from "./lib/docs";
+
+export const dynamic = "force-static";
+
+const origin = "https://my-code.utcode.net";
+
+export default async function sitemap(): Promise<MetadataRoute.Sitemap> {
+  const pagesList = await getPagesList();
+
+  return [
+    {
+      url: origin,
+      changeFrequency: "monthly",
+      priority: 1,
+    },
+    ...(await Promise.all(
+      pagesList
+        .map((lang) =>
+          lang.pages.map(async (page) => {
+            const sections = await getMarkdownSections(lang.id, page.slug);
+            const sectionsDate = await Promise.all(
+              sections.map((s) =>
+                getRevisions(s.id)
+                  .then((revisions) => revisions?.rev.at(-1))
+                  .then((lastRev) =>
+                    lastRev ? getCommitDate(lastRev.git) : null
+                  )
+              )
+            );
+            return {
+              url: `${origin}/${lang.id}/${page.slug}`,
+              priority: 0.8,
+              changeFrequency: "monthly",
+              lastModified: sectionsDate.reduce(
+                (latest: Date, date: Date | null) => {
+                  if (!date) return latest;
+                  return date > latest ? date : latest;
+                },
+                new Date(0)
+              ),
+            } satisfies MetadataRoute.Sitemap[number];
+          })
+        )
+        .flat()
+    )),
+  ];
+}

public/docs/commits.yml

@@ -0,0 +1,2 @@
+# This file will be updated by CI. Do not edit manually.
+de11512: '2026-03-08T14:27:20+09:00'

scripts/checkDocs.ts

@@ -50,6 +50,8 @@ if (doWrite) {
   }).trim();
 }
 
+let hasNewRevision = false;
+
 const langEntries = await getPagesList();
 
 const revisionsPrevYml = existsSync(join(docsDir, "revisions.yml"))
@@ -70,6 +72,7 @@ for (const lang of langEntries) {
           // ドキュメントが変更された場合
           console.warn(`${section.id} has new md5: ${section.md5}`);
           if (doWrite) {
+            hasNewRevision = true;
             revisions[section.id].rev.push({
               md5: section.md5,
               git: commit,
@@ -83,6 +86,7 @@ for (const lang of langEntries) {
         // ドキュメントが新規追加された場合
         console.warn(`${section.id} is new section`);
         if (doWrite) {
+          hasNewRevision = true;
           revisions[section.id] = {
             rev: [
               {
@@ -142,4 +146,23 @@ if (doWrite) {
       revisionsYml,
     "utf-8"
   );
+
+  if (hasNewRevision) {
+    const commitsYml = yaml.load(
+      await readFile(join(docsDir, "commits.yml"), "utf-8")
+    ) as Record<string, string>;
+    commitsYml[commit] = execFileSync(
+      "git",
+      ["show", "-s", "--format=%cI", commit],
+      {
+        encoding: "utf8",
+      }
+    ).trim();
+    await writeFile(
+      join(docsDir, "commits.yml"),
+      "# This file will be updated by CI. Do not edit manually.\n" +
+        yaml.dump(commitsYml, { sortKeys: true }),
+      "utf-8"
+    );
+  }
 }