Skip to content

feat(blog): allow processing blog posts through a processBlogPosts function #9886

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

Merged
slorber merged 18 commits into from
Mar 5, 2024
Merged

feat(blog): allow processing blog posts through a processBlogPosts function #9886

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
7a76d9b
feat(blog): allow process blog posts through a options.processBlogPos…
OzakIOne Feb 23, 2024
29b29ae
wip: config option, test doesn't
OzakIOne Feb 24, 2024
3afcdfe
fix and try to improve tests
OzakIOne Feb 26, 2024
6019b81
fix type and add test
OzakIOne Feb 26, 2024
64e5f47
processBlogPosts async function & tests
OzakIOne Feb 26, 2024
0d8777c
wip: loadcontent test
OzakIOne Feb 26, 2024
c737407
refactor(theme): dates should be formatted on the client-side instead…
OzakIOne Feb 23, 2024
062569f
perf: optimize getFileCommitDate, make it async (#9890)
slorber Feb 24, 2024
2bafacd
wip tests
OzakIOne Feb 28, 2024
cd9a79c
Revert "perf: optimize getFileCommitDate, make it async (#9890)"
OzakIOne Mar 4, 2024
13c4b5e
Revert "refactor(theme): dates should be formatted on the client-side…
OzakIOne Mar 4, 2024
3c4cf8c
add back formattedDate
OzakIOne Mar 4, 2024
0162aac
Merge branch 'main' into ozaki/processBlogPosts
OzakIOne Mar 4, 2024
f57b020
removed formattedDate & fix insecure type
OzakIOne Mar 4, 2024
f95c993
simplify test
OzakIOne Mar 5, 2024
d554527
use markdown links for broken link checker
OzakIOne Mar 5, 2024
69ea576
add doc
OzakIOne Mar 5, 2024
2bc22d3
fix build
OzakIOne Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/docusaurus-plugin-content-blog/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,8 @@
},
"engines": {
"node": ">=18.0"
},
"devDependencies": {
"@total-typescript/shoehorn": "^0.1.2"
}
}
3 changes: 0 additions & 3 deletions packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/index.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ exports[`blog plugin process blog posts load content 2`] = `
"date": 2020-08-15T00:00:00.000Z,
"description": "simple url slug",
"editUrl": "https://baseEditUrl.com/edit/blog/another-simple-slug-with-tags.md",
"formattedDate": "August 15, 2020",
"frontMatter": {
"author": "Sébastien Lorber",
"author_title": "Docusaurus maintainer",
Expand Down Expand Up @@ -163,7 +162,6 @@ exports[`blog plugin process blog posts load content 2`] = `
"date": 2020-08-15T00:00:00.000Z,
"description": "with tag",
"editUrl": "https://baseEditUrl.com/edit/blog/another-with-tags.md",
"formattedDate": "August 15, 2020",
"frontMatter": {
"date": 2020-08-15T00:00:00.000Z,
"slug": "/another/tags",
Expand Down Expand Up @@ -207,7 +205,6 @@ exports[`blog plugin process blog posts load content 2`] = `
"date": 2020-08-15T00:00:00.000Z,
"description": "with tag",
"editUrl": "https://baseEditUrl.com/edit/blog/another-with-tags2.md",
"formattedDate": "August 15, 2020",
"frontMatter": {
"date": 2020-08-15T00:00:00.000Z,
"slug": "/another/tags2",
Expand Down
2 changes: 0 additions & 2 deletions ...ages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/translations.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ exports[`translateContent falls back when translation is incomplete 1`] = `
"authors": [],
"date": 2021-07-19T00:00:00.000Z,
"description": "/blog/2021/06/19/hello",
"formattedDate": "June 19, 2021",
"frontMatter": {},
"hasTruncateMarker": true,
"permalink": "/blog/2021/06/19/hello",
Expand Down Expand Up @@ -94,7 +93,6 @@ exports[`translateContent returns translated loaded 1`] = `
"authors": [],
"date": 2021-07-19T00:00:00.000Z,
"description": "/blog/2021/06/19/hello",
"formattedDate": "June 19, 2021",
"frontMatter": {},
"hasTruncateMarker": true,
"permalink": "/blog/2021/06/19/hello",
Expand Down
16 changes: 3 additions & 13 deletions packages/docusaurus-plugin-content-blog/src/__tests__/blogUtils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import {jest} from '@jest/globals';
import fs from 'fs-extra';
import path from 'path';
import {fromPartial} from '@total-typescript/shoehorn';
import {
truncate,
parseBlogFileName,
Expand Down Expand Up @@ -238,7 +239,6 @@ describe('linkify', () => {
hasTruncateMarker: false,
frontMatter: {},
authors: [],
formattedDate: '',
unlisted: false,
},
content: '',
Expand Down Expand Up @@ -301,19 +301,9 @@ describe('linkify', () => {

const createBlogPost = (args: DeepPartial<BlogPost>): BlogPost => ({
id: '',
metadata: {
source: '',
title: '',
formattedDate: '',
permalink: '',
description: '',
hasTruncateMarker: false,
authors: [],
frontMatter: {},
tags: [],
unlisted: false,
metadata: fromPartial({
...args.metadata,
} as BlogPost['metadata'],
}),
content: args.content || '',
});

Expand Down
1 change: 0 additions & 1 deletion packages/docusaurus-plugin-content-blog/src/__tests__/translations.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ const sampleBlogPosts: BlogPost[] = [
source: '/blog/2021/06/19/hello',
description: '/blog/2021/06/19/hello',
date: new Date(2021, 6, 19),
formattedDate: 'June 19, 2021',
tags: [],
title: 'Hello',
hasTruncateMarker: true,
Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2977,6 +2977,11 @@
resolved "https://registry.yarnpkg.com/@tootallnate/once/-/once-2.0.0.tgz#f544a148d3ab35801c1f633a7441fd87c2e484bf"
integrity sha512-XCuKFP5PS55gnMVu3dty8KPatLqUoy/ZYzDzAGCQ8JNFCkLXzmI7vNHCR+XpbZaMWQK/vQubr7PkYq8g470J/A==

"@total-typescript/shoehorn@^0.1.2":
version "0.1.2"
resolved "https://registry.yarnpkg.com/@total-typescript/shoehorn/-/shoehorn-0.1.2.tgz#a0c095ce8cb9b4ae3556bcff42702ddb072e9d18"
integrity sha512-p7nNZbOZIofpDNyP0u1BctFbjxD44Qc+oO5jufgQdFdGIXJLc33QRloJpq7k5T59CTgLWfQSUxsuqLcmeurYRw==

"@trysound/sax@0.2.0":
version "0.2.0"
resolved "https://registry.yarnpkg.com/@trysound/sax/-/sax-0.2.0.tgz#cccaab758af56761eb7bf37af6f03f326dd798ad"
Expand Down