Skip to content

fix(blog): normalize inline authors socials #10424

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 10 commits into from
Aug 29, 2024
Merged

fix(blog): normalize inline authors socials #10424

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f835217
fix: normalize inline authors socials
OzakIOne Aug 19, 2024
e2c4322
fix: conditionally normalize socials inline authors
OzakIOne Aug 19, 2024
b89513b
refactor and add tests
OzakIOne Aug 20, 2024
c7e9822
add tests
OzakIOne Aug 21, 2024
1e30108
refactor: apply lint autofix
OzakIOne Aug 21, 2024
58a350d
refactor
OzakIOne Aug 22, 2024
6451ac9
refactor: apply lint autofix
OzakIOne Aug 22, 2024
a689f96
Merge branch 'main' into ozaki/inlineAuthor
OzakIOne Aug 23, 2024
7e7b6ad
Merge branch 'main' into ozaki/inlineAuthor
slorber Aug 29, 2024
e8ac33e
fix tests
OzakIOne Aug 29, 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
56 changes: 50 additions & 6 deletions packages/docusaurus-plugin-content-blog/src/__tests__/authors.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,13 @@ describe('getBlogPostAuthors', () => {
expect(
getBlogPostAuthors({
frontMatter: {
authors: {name: 'Sébastien Lorber', title: 'maintainer'},
authors: {
name: 'Sébastien Lorber',
title: 'maintainer',
socials: {
github: 'slorber',
},
},
},
authorsMap: undefined,
baseUrl: '/',
Expand All @@ -282,6 +288,9 @@ describe('getBlogPostAuthors', () => {
name: 'Sébastien Lorber',
title: 'maintainer',
imageURL: undefined,
socials: {
github: 'https://github.com/slorber',
},
key: null,
page: null,
},
Expand All @@ -293,8 +302,19 @@ describe('getBlogPostAuthors', () => {
getBlogPostAuthors({
frontMatter: {
authors: [
{name: 'Sébastien Lorber', title: 'maintainer'},
{name: 'Yangshun Tay'},
{
name: 'Sébastien Lorber',
title: 'maintainer',
socials: {
github: 'slorber',
},
},
{
name: 'Yangshun Tay',
socials: {
github: 'https://github.com/yangshun',
},
},
],
},
authorsMap: undefined,
Expand All @@ -306,9 +326,20 @@ describe('getBlogPostAuthors', () => {
title: 'maintainer',
imageURL: undefined,
key: null,
socials: {
github: 'https://github.com/slorber',
},
page: null,
},
{name: 'Yangshun Tay', imageURL: undefined, key: null, page: null},
{
name: 'Yangshun Tay',
imageURL: undefined,
key: null,
page: null,
socials: {
github: 'https://github.com/yangshun',
},
},
]);
});

Expand All @@ -323,7 +354,12 @@ describe('getBlogPostAuthors', () => {
title: 'Yangshun title local override',
extra: 42,
},
{name: 'Alexey'},
{
name: 'Alexey',
socials: {
github: 'lex111',
},
},
],
},
authorsMap: {
Expand Down Expand Up @@ -358,7 +394,15 @@ describe('getBlogPostAuthors', () => {
imageURL: undefined,
page: null,
},
{name: 'Alexey', imageURL: undefined, key: null, page: null},
{
name: 'Alexey',
imageURL: undefined,
key: null,
page: null,
socials: {
github: 'https://github.com/lex111',
},
},
]);
});

Expand Down
10 changes: 9 additions & 1 deletion packages/docusaurus-plugin-content-blog/src/authors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import _ from 'lodash';
import {normalizeUrl} from '@docusaurus/utils';
import {normalizeSocials} from './authorsSocials';
import type {
Author,
AuthorsMap,
Expand Down Expand Up @@ -84,7 +85,14 @@ function getFrontMatterAuthors(params: AuthorsParam): Author[] {
// becoming a name and may end up unnoticed
return {key: authorInput};
}
return authorInput;
const normalizedSocials = normalizeSocials(authorInput.socials ?? {});

return {
...authorInput,
...(Object.keys(normalizedSocials).length > 0 && {
socials: normalizedSocials,
}),
};
}

return Array.isArray(frontMatter.authors)
Expand Down