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(v2): enable feeds by default in blog plugin #3842

Merged
merged 7 commits into from
Dec 10, 2020
Merged

feat(v2): enable feeds by default in blog plugin #3842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
38af5f4
feat: enables feeds by default in blog
cindygu4 Nov 29, 2020
4f3199a
feat(v2): enable feeds by default
cindygu4 Nov 30, 2020
7f18351
feat(v2): enable feeds in blog plugin
cindygu4 Dec 4, 2020
9d2fe88
feat(v2): enable feeds by default in blog plugin
cindygu4 Dec 4, 2020
612687f
feat(v2): enable feeds by default in blog plugin
cindygu4 Dec 4, 2020
7ce4fec
feat(v2): enable feeds by default
cindygu4 Dec 7, 2020
0e25e50
feat(v2): enable feeds by default in blog plugin
cindygu4 Dec 7, 2020
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
28 changes: 28 additions & 0 deletions packages/docusaurus-plugin-content-blog/src/__tests__/pluginOptionSchema.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,34 @@ test('should convert all feed type to array with other feed type', () => {
});
});

test('should accept null type and return same', () => {
const {value, error} = PluginOptionSchema.validate({
feedOptions: {type: null},
});
expect(value).toEqual({
...DEFAULT_OPTIONS,
feedOptions: {type: null},
});
expect(error).toBe(undefined);
});

test('should contain array with rss + atom for missing feed type', () => {
const {value} = PluginOptionSchema.validate({
feedOptions: {},
});
expect(value).toEqual(DEFAULT_OPTIONS);
});

test('should have array with rss + atom, title for missing feed type', () => {
const {value} = PluginOptionSchema.validate({
feedOptions: {title: 'title'},
});
expect(value).toEqual({
...DEFAULT_OPTIONS,
feedOptions: {type: ['rss', 'atom'], title: 'title'},
});
});

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That looks good

Can you please add a test to ensure that type: null leads to type: null after validation? To ensure it's not using default values as a fallback?

describe('blog sidebar', () => {
test('should accept 0 sidebar count', () => {
const userOptions = {blogSidebarCount: 0};
Expand Down
22 changes: 15 additions & 7 deletions packages/docusaurus-plugin-content-blog/src/pluginOptionSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
} from '@docusaurus/utils-validation';

export const DEFAULT_OPTIONS = {
feedOptions: {},
feedOptions: {type: ['rss', 'atom']},
beforeDefaultRehypePlugins: [],
beforeDefaultRemarkPlugins: [],
admonitions: {},
Expand Down Expand Up @@ -76,12 +76,20 @@ export const PluginOptionSchema = Joi.object({
DEFAULT_OPTIONS.beforeDefaultRehypePlugins,
),
feedOptions: Joi.object({
type: Joi.alternatives().conditional(
Joi.string().equal('all', 'rss', 'atom'),
{
then: Joi.custom((val) => (val === 'all' ? ['rss', 'atom'] : [val])),
},
),
type: Joi.alternatives()
.try(
Joi.array().items(Joi.string()),
Joi.alternatives().conditional(
Joi.string().equal('all', 'rss', 'atom'),
{
then: Joi.custom((val) =>
val === 'all' ? ['rss', 'atom'] : [val],
),
},
),
)
.allow(null)
.default(DEFAULT_OPTIONS.feedOptions.type),
title: Joi.string().allow(''),
description: Joi.string().allow(''),
copyright: Joi.string(),
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-content-blog/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export interface PluginOptions {
truncateMarker: RegExp;
showReadingTime: boolean;
feedOptions: {
type: [FeedType];
type?: [FeedType] | null;
title?: string;
description?: string;
copyright: string;
Expand Down
4 changes: 2 additions & 2 deletions website/docs/blog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ Or this.

## Feed

You can generate RSS/ Atom feed by passing feedOptions.
You can generate RSS/Atom feed by passing feedOptions. By default, RSS and Atom feeds are generated. To disable feed generation, set `feedOptions.type` to `null`.

```ts
feedOptions?: {
type: 'rss' | 'atom' | 'all';
type?: 'rss' | 'atom' | 'all' | null;
title?: string;
description?: string;
copyright: string;
Expand Down