Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 18 commits into from
Mar 20, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
9aa4804
move flattenRoutes() fn to docusaurus-utils
slorber Mar 15, 2024
3c73721
refactor sitemap plugin to use routes instead of routesPaths
slorber Mar 15, 2024
671a8e6
Merge branch 'main' into slorber/sitemap-lastmod
slorber Mar 19, 2024
5fb8c98
Add route metadata support to docs, blog and page plugins
slorber Mar 19, 2024
27aa218
refactor: apply lint autofix
slorber Mar 19, 2024
1762ea5
preliminary sitemap plugin refactor
slorber Mar 19, 2024
46c870b
Merge remote-tracking branch 'origin/slorber/sitemap-lastmod' into sl…
slorber Mar 19, 2024
cab78b8
refactor lastUpdateUtils
slorber Mar 19, 2024
6674d80
fix page sourceFilePath
slorber Mar 19, 2024
f8a6907
annoying eslint rule
slorber Mar 19, 2024
ed7b7f3
Add support for sitemap lastmod
slorber Mar 19, 2024
10c0b55
refactor: apply lint autofix
slorber Mar 19, 2024
a04c4f2
typo change
slorber Mar 20, 2024
33ddfc5
Merge remote-tracking branch 'origin/slorber/sitemap-lastmod' into sl…
slorber Mar 20, 2024
db54c3d
fix bad imports
slorber Mar 20, 2024
56f3459
remove log
slorber Mar 20, 2024
f8b53a7
Add sitemap lastmod doc + RouteConfig metadata doc
slorber Mar 20, 2024
d92d80d
simplify api table code blocks
slorber Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 2 additions & 4 deletions .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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},
Expand Down
19 changes: 9 additions & 10 deletions packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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');
Expand All @@ -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'),
Expand All @@ -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');
Expand Down Expand Up @@ -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();
});
Expand Down
18 changes: 17 additions & 1 deletion packages/docusaurus-plugin-content-blog/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
normalizeUrl,
docuHash,
aliasedSitePath,
aliasedSitePathToRelativePath,
getPluginI18nPath,
posixPath,
addTrailingPathSeparator,
Expand All @@ -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,
Expand Down Expand Up @@ -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) => {
Expand All @@ -292,6 +307,7 @@ export default async function pluginContentBlog(
sidebar: aliasedSource(sidebarProp),
content: metadata.source,
},
metadata: createBlogPostRouteMetadata(metadata),
context: {
blogMetadata: aliasedSource(blogMetadataPath),
},
Expand Down