feat(sitemap): add support for "lastmod" (#9954)

facebook · Mar 20, 2024 · 9017fb9 · 9017fb9
1 parent 465cf4d
commit 9017fb9
Show file tree

Hide file tree

Showing 41 changed files with 1,445 additions and 355 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -85,6 +85,7 @@ module.exports = {
         ignorePattern: '(eslint-disable|@)',
       },
     ],
+    'arrow-body-style': OFF,
     'no-await-in-loop': OFF,
     'no-case-declarations': WARNING,
     'no-console': OFF,
@@ -347,10 +348,7 @@ module.exports = {
       ERROR,
       {'ts-expect-error': 'allow-with-description'},
     ],
-    '@typescript-eslint/consistent-indexed-object-style': [
-      WARNING,
-      'index-signature',
-    ],
+    '@typescript-eslint/consistent-indexed-object-style': OFF,
     '@typescript-eslint/consistent-type-imports': [
       WARNING,
       {disallowTypeAnnotations: false},

diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts
@@ -11,8 +11,7 @@ import {normalizePluginOptions} from '@docusaurus/utils-validation';
 import {
   posixPath,
   getFileCommitDate,
-  GIT_FALLBACK_LAST_UPDATE_DATE,
-  GIT_FALLBACK_LAST_UPDATE_AUTHOR,
+  LAST_UPDATE_FALLBACK,
 } from '@docusaurus/utils';
 import pluginContentBlog from '../index';
 import {validateOptions} from '../options';
@@ -554,14 +553,14 @@ describe('last update', () => {
 
     expect(blogPosts[0]?.metadata.lastUpdatedBy).toBe('seb');
     expect(blogPosts[0]?.metadata.lastUpdatedAt).toBe(
-      GIT_FALLBACK_LAST_UPDATE_DATE,
+      LAST_UPDATE_FALLBACK.lastUpdatedAt,
     );
 
     expect(blogPosts[1]?.metadata.lastUpdatedBy).toBe(
-      GIT_FALLBACK_LAST_UPDATE_AUTHOR,
+      LAST_UPDATE_FALLBACK.lastUpdatedBy,
     );
     expect(blogPosts[1]?.metadata.lastUpdatedAt).toBe(
-      GIT_FALLBACK_LAST_UPDATE_DATE,
+      LAST_UPDATE_FALLBACK.lastUpdatedAt,
     );
 
     expect(blogPosts[2]?.metadata.lastUpdatedBy).toBe('seb');
@@ -570,7 +569,7 @@ describe('last update', () => {
     );
 
     expect(blogPosts[3]?.metadata.lastUpdatedBy).toBe(
-      GIT_FALLBACK_LAST_UPDATE_AUTHOR,
+      LAST_UPDATE_FALLBACK.lastUpdatedBy,
     );
     expect(blogPosts[3]?.metadata.lastUpdatedAt).toBe(
       lastUpdateFor('2021-01-01'),
@@ -591,13 +590,13 @@ describe('last update', () => {
     expect(blogPosts[0]?.metadata.title).toBe('Author');
     expect(blogPosts[0]?.metadata.lastUpdatedBy).toBeUndefined();
     expect(blogPosts[0]?.metadata.lastUpdatedAt).toBe(
-      GIT_FALLBACK_LAST_UPDATE_DATE,
+      LAST_UPDATE_FALLBACK.lastUpdatedAt,
     );
 
     expect(blogPosts[1]?.metadata.title).toBe('Nothing');
     expect(blogPosts[1]?.metadata.lastUpdatedBy).toBeUndefined();
     expect(blogPosts[1]?.metadata.lastUpdatedAt).toBe(
-      GIT_FALLBACK_LAST_UPDATE_DATE,
+      LAST_UPDATE_FALLBACK.lastUpdatedAt,
     );
 
     expect(blogPosts[2]?.metadata.title).toBe('Both');
@@ -628,15 +627,15 @@ describe('last update', () => {
     expect(blogPosts[0]?.metadata.lastUpdatedAt).toBeUndefined();
 
     expect(blogPosts[1]?.metadata.lastUpdatedBy).toBe(
-      GIT_FALLBACK_LAST_UPDATE_AUTHOR,
+      LAST_UPDATE_FALLBACK.lastUpdatedBy,
     );
     expect(blogPosts[1]?.metadata.lastUpdatedAt).toBeUndefined();
 
     expect(blogPosts[2]?.metadata.lastUpdatedBy).toBe('seb');
     expect(blogPosts[2]?.metadata.lastUpdatedAt).toBeUndefined();
 
     expect(blogPosts[3]?.metadata.lastUpdatedBy).toBe(
-      GIT_FALLBACK_LAST_UPDATE_AUTHOR,
+      LAST_UPDATE_FALLBACK.lastUpdatedBy,
     );
     expect(blogPosts[3]?.metadata.lastUpdatedAt).toBeUndefined();
   });

diff --git a/packages/docusaurus-plugin-content-blog/src/index.ts b/packages/docusaurus-plugin-content-blog/src/index.ts
@@ -11,6 +11,7 @@ import {
   normalizeUrl,
   docuHash,
   aliasedSitePath,
+  aliasedSitePathToRelativePath,
   getPluginI18nPath,
   posixPath,
   addTrailingPathSeparator,
@@ -33,7 +34,12 @@ import {createBlogFeedFiles} from './feed';
 
 import {toTagProp, toTagsProp} from './props';
 import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
-import type {LoadContext, Plugin, HtmlTags} from '@docusaurus/types';
+import type {
+  LoadContext,
+  Plugin,
+  HtmlTags,
+  RouteMetadata,
+} from '@docusaurus/types';
 import type {
   PluginOptions,
   BlogPostFrontMatter,
@@ -273,6 +279,15 @@ export default async function pluginContentBlog(
         JSON.stringify(blogMetadata, null, 2),
       );
 
+      function createBlogPostRouteMetadata(
+        blogPostMeta: BlogPostMetadata,
+      ): RouteMetadata {
+        return {
+          sourceFilePath: aliasedSitePathToRelativePath(blogPostMeta.source),
+          lastUpdatedAt: blogPostMeta.lastUpdatedAt,
+        };
+      }
+
       // Create routes for blog entries.
       await Promise.all(
         blogPosts.map(async (blogPost) => {
@@ -292,6 +307,7 @@ export default async function pluginContentBlog(
               sidebar: aliasedSource(sidebarProp),
               content: metadata.source,
             },
+            metadata: createBlogPostRouteMetadata(metadata),
             context: {
               blogMetadata: aliasedSource(blogMetadataPath),
             },