Skip to content

feat(content-docs): last_update front matter #7461

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 17 commits into from
Jun 1, 2022
Merged

feat(content-docs): last_update front matter #7461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
9a9248d
feat(content-docs): add last update front matter
dpang314 May 22, 2022
b4d67e6
Merge branch 'facebook:main' into main
dpang314 May 23, 2022
e36a7f3
Merge branch 'facebook:main' into main
dpang314 May 23, 2022
1f4efc1
refactor: update last_update JSDoc
dpang314 May 23, 2022
c75a801
Merge branch 'main' of https://github.com/dpang314/docusaurus into main
dpang314 May 23, 2022
60f3c34
refactor: separate last_update JSDoc
dpang314 May 23, 2022
eac8588
refactor: move readLastUpdateData to doProcessDocMetadata
dpang314 May 23, 2022
aa2f8c5
refactor: change readLastUpdateData to synchronous
dpang314 May 24, 2022
8e9880f
Update packages/docusaurus-plugin-content-docs/src/docs.ts
dpang314 May 26, 2022
f6b0aa3
fix: front matter should work without Git history
dpang314 May 26, 2022
f146745
refactor: revert readLastUpdateData to async
dpang314 May 27, 2022
13f04f0
refactor: revert unnecessary async
dpang314 May 27, 2022
84433c8
refactor: avoid calling getFileLastUpdate unnecessarily
dpang314 May 27, 2022
f19e0ca
test: reject empty and invalid objects
dpang314 May 27, 2022
bfcb4d3
refactor: improve check for valid last_update object
dpang314 May 27, 2022
0223ab2
Merge branch 'main' into dpang314/main
slorber Jun 1, 2022
f43af83
fix test typo
slorber Jun 1, 2022
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
8 changes: 8 additions & 0 deletions ...in-content-docs/src/__tests__/__fixtures__/simple-site/docs/customLastUpdate.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions ...ontent-docs/src/__tests__/__fixtures__/simple-site/docs/lastUpdateAuthorOnly.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions ...-content-docs/src/__tests__/__fixtures__/simple-site/docs/lastUpdateDateOnly.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

55 changes: 50 additions & 5 deletions packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,24 @@
exports[`simple site custom pagination 1`] = `
{
"pagination": [
{
"id": "customLastUpdate",
"next": {
"permalink": "/docs/doc with space",
"title": "Hoo hoo, if this path tricks you...",
},
"prev": undefined,
},
{
"id": "doc with space",
"next": {
"permalink": "/docs/doc-draft",
"title": "doc-draft",
},
"prev": undefined,
"prev": {
"permalink": "/docs/customLastUpdate",
"title": "Custom Last Update",
},
},
{
"id": "doc-draft",
Expand Down Expand Up @@ -63,23 +74,45 @@ exports[`simple site custom pagination 1`] = `
{
"id": "ipsum",
"next": {
"permalink": "/docs/lorem",
"title": "lorem",
"permalink": "/docs/lastUpdateAuthorOnly",
"title": "Last Update Author Only",
},
"prev": {
"permalink": "/docs/",
"title": "Hello sidebar_label",
},
},
{
"id": "lastUpdateAuthorOnly",
"next": {
"permalink": "/docs/lastUpdateDateOnly",
"title": "Last Update Date Only",
},
"prev": {
"permalink": "/docs/ipsum",
"title": "ipsum",
},
},
{
"id": "lastUpdateDateOnly",
"next": {
"permalink": "/docs/lorem",
"title": "lorem",
},
"prev": {
"permalink": "/docs/lastUpdateAuthorOnly",
"title": "Last Update Author Only",
},
},
{
"id": "lorem",
"next": {
"permalink": "/docs/rootAbsoluteSlug",
"title": "rootAbsoluteSlug",
},
"prev": {
"permalink": "/docs/ipsum",
"title": "ipsum",
"permalink": "/docs/lastUpdateDateOnly",
"title": "Last Update Date Only",
},
},
{
Expand Down Expand Up @@ -170,6 +203,10 @@ exports[`simple site custom pagination 1`] = `
],
"sidebars": {
"defaultSidebar": [
{
"id": "customLastUpdate",
"type": "doc",
},
{
"id": "doc with space",
"type": "doc",
Expand Down Expand Up @@ -208,6 +245,14 @@ exports[`simple site custom pagination 1`] = `
"id": "ipsum",
"type": "doc",
},
{
"id": "lastUpdateAuthorOnly",
"type": "doc",
},
{
"id": "lastUpdateDateOnly",
"type": "doc",
},
{
"id": "lorem",
"type": "doc",
Expand Down
130 changes: 130 additions & 0 deletions packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,16 @@ These sidebar document ids do not exist:
- nonExistent

Available document ids are:
- customLastUpdate
- doc with space
- doc-draft
- foo/bar
- foo/baz
- headingAsTitle
- hello
- ipsum
- lastUpdateAuthorOnly
- lastUpdateDateOnly
- lorem
- rootAbsoluteSlug
- rootRelativeSlug
Expand Down Expand Up @@ -267,6 +270,11 @@ exports[`simple website content 5`] = `
"versions": [
{
"docs": [
{
"id": "customLastUpdate",
"path": "/docs/customLastUpdate",
"sidebar": undefined,
},
{
"id": "doc with space",
"path": "/docs/doc with space",
Expand Down Expand Up @@ -302,6 +310,16 @@ exports[`simple website content 5`] = `
"path": "/docs/ipsum",
"sidebar": undefined,
},
{
"id": "lastUpdateAuthorOnly",
"path": "/docs/lastUpdateAuthorOnly",
"sidebar": undefined,
},
{
"id": "lastUpdateDateOnly",
"path": "/docs/lastUpdateDateOnly",
"sidebar": undefined,
},
{
"id": "lorem",
"path": "/docs/lorem",
Expand Down Expand Up @@ -390,6 +408,26 @@ exports[`simple website content: data 1`] = `
"permalink": "/docs/rootAbsoluteSlug"
}
}
}",
"site-docs-custom-last-update-md-b8d.json": "{
"unversionedId": "customLastUpdate",
"id": "customLastUpdate",
"title": "Custom Last Update",
"description": "Custom last update",
"source": "@site/docs/customLastUpdate.md",
"sourceDirName": ".",
"slug": "/customLastUpdate",
"permalink": "/docs/customLastUpdate",
"draft": false,
"tags": [],
"version": "current",
"frontMatter": {
"title": "Custom Last Update",
"last_update": {
"author": "Custom Author",
"date": "1/1/2000"
}
}
}",
"site-docs-doc-draft-md-584.json": "{
"unversionedId": "doc-draft",
Expand Down Expand Up @@ -563,6 +601,44 @@ exports[`simple website content: data 1`] = `
"frontMatter": {
"custom_edit_url": null
}
}",
"site-docs-last-update-author-only-md-352.json": "{
"unversionedId": "lastUpdateAuthorOnly",
"id": "lastUpdateAuthorOnly",
"title": "Last Update Author Only",
"description": "Only custom author, so it will still use the date from Git",
"source": "@site/docs/lastUpdateAuthorOnly.md",
"sourceDirName": ".",
"slug": "/lastUpdateAuthorOnly",
"permalink": "/docs/lastUpdateAuthorOnly",
"draft": false,
"tags": [],
"version": "current",
"frontMatter": {
"title": "Last Update Author Only",
"last_update": {
"author": "Custom Author"
}
}
}",
"site-docs-last-update-date-only-md-987.json": "{
"unversionedId": "lastUpdateDateOnly",
"id": "lastUpdateDateOnly",
"title": "Last Update Date Only",
"description": "Only custom date, so it will still use the author from Git",
"source": "@site/docs/lastUpdateDateOnly.md",
"sourceDirName": ".",
"slug": "/lastUpdateDateOnly",
"permalink": "/docs/lastUpdateDateOnly",
"draft": false,
"tags": [],
"version": "current",
"frontMatter": {
"title": "Last Update Date Only",
"last_update": {
"date": "1/1/2000"
}
}
}",
"site-docs-lorem-md-b27.json": "{
"unversionedId": "lorem",
Expand Down Expand Up @@ -924,6 +1000,11 @@ exports[`simple website content: data 1`] = `
]
},
"docs": {
"customLastUpdate": {
"id": "customLastUpdate",
"title": "Custom Last Update",
"description": "Custom last update"
},
"doc with space": {
"id": "doc with space",
"title": "Hoo hoo, if this path tricks you...",
Expand Down Expand Up @@ -963,6 +1044,16 @@ exports[`simple website content: data 1`] = `
"title": "ipsum",
"description": "Lorem ipsum."
},
"lastUpdateAuthorOnly": {
"id": "lastUpdateAuthorOnly",
"title": "Last Update Author Only",
"description": "Only custom author, so it will still use the date from Git"
},
"lastUpdateDateOnly": {
"id": "lastUpdateDateOnly",
"title": "Last Update Date Only",
"description": "Only custom date, so it will still use the author from Git"
},
"lorem": {
"id": "lorem",
"title": "lorem",
Expand Down Expand Up @@ -1026,6 +1117,11 @@ exports[`simple website content: global data 1`] = `
"versions": [
{
"docs": [
{
"id": "customLastUpdate",
"path": "/docs/customLastUpdate",
"sidebar": undefined,
},
{
"id": "doc with space",
"path": "/docs/doc with space",
Expand Down Expand Up @@ -1061,6 +1157,16 @@ exports[`simple website content: global data 1`] = `
"path": "/docs/ipsum",
"sidebar": undefined,
},
{
"id": "lastUpdateAuthorOnly",
"path": "/docs/lastUpdateAuthorOnly",
"sidebar": undefined,
},
{
"id": "lastUpdateDateOnly",
"path": "/docs/lastUpdateDateOnly",
"sidebar": undefined,
},
{
"id": "lorem",
"path": "/docs/lorem",
Expand Down Expand Up @@ -1202,6 +1308,14 @@ exports[`simple website content: route config 1`] = `
"path": "/docs/category/slugs",
"sidebar": "docs",
},
{
"component": "@theme/DocItem",
"exact": true,
"modules": {
"content": "@site/docs/customLastUpdate.md",
},
"path": "/docs/customLastUpdate",
},
{
"component": "@theme/DocItem",
"exact": true,
Expand Down Expand Up @@ -1262,6 +1376,22 @@ exports[`simple website content: route config 1`] = `
},
"path": "/docs/ipsum",
},
{
"component": "@theme/DocItem",
"exact": true,
"modules": {
"content": "@site/docs/lastUpdateAuthorOnly.md",
},
"path": "/docs/lastUpdateAuthorOnly",
},
{
"component": "@theme/DocItem",
"exact": true,
"modules": {
"content": "@site/docs/lastUpdateDateOnly.md",
},
"path": "/docs/lastUpdateDateOnly",
},
{
"component": "@theme/DocItem",
"exact": true,
Expand Down
Loading