@docusaurus/plugin-content-blog 2.0.0-beta.ff31de0ff → 2.0.1

package/lib/blogFrontMatter.d.ts

@@ -1,28 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import { Tag } from './types';
-export declare type BlogPostFrontMatter = {
-    id?: string;
-    title?: string;
-    description?: string;
-    tags?: (string | Tag)[];
-    slug?: string;
-    draft?: boolean;
-    date?: Date;
-    author?: string;
-    author_title?: string;
-    author_url?: string;
-    author_image_url?: string;
-    image?: string;
-    keywords?: string[];
-    hide_table_of_contents?: boolean;
-    /** @deprecated */
-    authorTitle?: string;
-    authorURL?: string;
-    authorImageURL?: string;
-};
-export declare function validateBlogPostFrontMatter(frontMatter: Record<string, unknown>): BlogPostFrontMatter;

package/lib/blogFrontMatter.js

@@ -1,50 +0,0 @@
-"use strict";
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateBlogPostFrontMatter = void 0;
-/* eslint-disable camelcase */
-const utils_validation_1 = require("@docusaurus/utils-validation");
-// NOTE: we don't add any default value on purpose here
-// We don't want default values to magically appear in doc metadatas and props
-// While the user did not provide those values explicitly
-// We use default values in code instead
-const BlogTagSchema = utils_validation_1.JoiFrontMatter.alternatives().try(utils_validation_1.JoiFrontMatter.string().required(), utils_validation_1.JoiFrontMatter.object({
-    label: utils_validation_1.JoiFrontMatter.string().required(),
-    permalink: utils_validation_1.JoiFrontMatter.string().required(),
-}));
-const BlogFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
-    id: utils_validation_1.JoiFrontMatter.string(),
-    title: utils_validation_1.JoiFrontMatter.string().allow(''),
-    description: utils_validation_1.JoiFrontMatter.string().allow(''),
-    tags: utils_validation_1.JoiFrontMatter.array().items(BlogTagSchema),
-    draft: utils_validation_1.JoiFrontMatter.boolean(),
-    date: utils_validation_1.JoiFrontMatter.date().raw(),
-    author: utils_validation_1.JoiFrontMatter.string(),
-    author_title: utils_validation_1.JoiFrontMatter.string(),
-    author_url: utils_validation_1.JoiFrontMatter.string().uri(),
-    author_image_url: utils_validation_1.JoiFrontMatter.string().uri(),
-    slug: utils_validation_1.JoiFrontMatter.string(),
-    image: utils_validation_1.JoiFrontMatter.string().uri({ relativeOnly: true }),
-    keywords: utils_validation_1.JoiFrontMatter.array().items(utils_validation_1.JoiFrontMatter.string().required()),
-    hide_table_of_contents: utils_validation_1.JoiFrontMatter.boolean(),
-    // TODO re-enable warnings later, our v1 blog posts use those older frontmatter fields
-    authorURL: utils_validation_1.JoiFrontMatter.string().uri(),
-    // .warning('deprecate.error', { alternative: '"author_url"'}),
-    authorTitle: utils_validation_1.JoiFrontMatter.string(),
-    // .warning('deprecate.error', { alternative: '"author_title"'}),
-    authorImageURL: utils_validation_1.JoiFrontMatter.string().uri(),
-    // .warning('deprecate.error', { alternative: '"author_image_url"'}),
-})
-    .unknown()
-    .messages({
-    'deprecate.error': '{#label} blog frontMatter field is deprecated. Please use {#alternative} instead.',
-});
-function validateBlogPostFrontMatter(frontMatter) {
-    return utils_validation_1.validateFrontMatter(frontMatter, BlogFrontMatterSchema);
-}
-exports.validateBlogPostFrontMatter = validateBlogPostFrontMatter;

package/lib/pluginOptionSchema.d.ts

@@ -1,33 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import { Joi } from '@docusaurus/utils-validation';
-export declare const DEFAULT_OPTIONS: {
-    feedOptions: {
-        type: string[];
-    };
-    beforeDefaultRehypePlugins: never[];
-    beforeDefaultRemarkPlugins: never[];
-    admonitions: {};
-    truncateMarker: RegExp;
-    rehypePlugins: never[];
-    remarkPlugins: never[];
-    showReadingTime: boolean;
-    blogTagsPostsComponent: string;
-    blogTagsListComponent: string;
-    blogPostComponent: string;
-    blogListComponent: string;
-    blogDescription: string;
-    blogTitle: string;
-    blogSidebarCount: number;
-    blogSidebarTitle: string;
-    postsPerPage: number;
-    include: string[];
-    routeBasePath: string;
-    path: string;
-    editLocalizedFiles: boolean;
-};
-export declare const PluginOptionSchema: Joi.ObjectSchema<any>;

package/src/__tests__/__fixtures__/website/blog/2018-12-14-Happy-First-Birthday-Slash.md

@@ -1,5 +0,0 @@
----
-title: Happy 1st Birthday Slash!
----
-
-Happy birthday!

package/src/__tests__/__fixtures__/website/blog/complex-slug.md

@@ -1,7 +0,0 @@
----
-slug: /hey/my super path/héllô
-title: Complex Slug
-date: 2020-08-16
----
-
-complex url slug

package/src/__tests__/__fixtures__/website/blog/date-matter.md

@@ -1,5 +0,0 @@
----
-date: 2019-01-01
----
-
-date inside front matter

package/src/__tests__/__fixtures__/website/blog/draft.md

@@ -1,6 +0,0 @@
----
-date: 2020-02-27
-draft: true
----
-
-this post should not be published yet

package/src/__tests__/__fixtures__/website/blog/heading-as-title.md

@@ -1,5 +0,0 @@
----
-date: 2019-01-02
----
-
-# some heading

package/src/__tests__/__fixtures__/website/blog/simple-slug.md

@@ -1,7 +0,0 @@
----
-slug: /simple/slug
-title: Simple Slug
-date: 2020-08-15
----
-
-simple url slug

package/src/__tests__/__fixtures__/website/blog-with-ref/2018-12-14-Happy-First-Birthday-Slash.md

@@ -1,5 +0,0 @@
----
-title: Happy 1st Birthday Slash!
----
-
-pattern name

package/src/__tests__/__fixtures__/website/blog-with-ref/post-with-broken-links.md

@@ -1,11 +0,0 @@
----
-title: This post links to another one!
----
-
-[Good link 1](2018-12-14-Happy-First-Birthday-Slash.md)
-
-[Good link 2](./2018-12-14-Happy-First-Birthday-Slash.md)
-
-[Bad link 1](postNotExist1.md)
-
-[Bad link 1](./postNotExist2.mdx)

package/src/__tests__/__fixtures__/website/blog-with-ref/post.md

@@ -1,5 +0,0 @@
----
-title: This post links to another one!
----
-
-[Linked post](2018-12-14-Happy-First-Birthday-Slash.md)

package/src/__tests__/__fixtures__/website/i18n/en/docusaurus-plugin-content-blog/2018-12-14-Happy-First-Birthday-Slash.md

@@ -1,5 +0,0 @@
----
-title: Happy 1st Birthday Slash! (translated)
----
-
-Happy birthday! (translated)

package/src/__tests__/__fixtures__/website-blog-without-date/blog/no date.md

@@ -1 +0,0 @@
-no date

package/src/__tests__/__snapshots__/generateBlogFeed.test.ts.snap

@@ -1,101 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`blogFeed atom can show feed without posts 1`] = `
-"<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
-<feed xmlns=\\"http://www.w3.org/2005/Atom\\">
-    <id>https://docusaurus.io/blog</id>
-    <title>Hello Blog</title>
-    <updated>2015-10-25T23:29:00.000Z</updated>
-    <generator>https://github.com/jpmonette/feed</generator>
-    <link rel=\\"alternate\\" href=\\"https://docusaurus.io/blog\\"/>
-    <subtitle>Hello Blog</subtitle>
-    <icon>https://docusaurus.io/image/favicon.ico</icon>
-    <rights>Copyright</rights>
-</feed>"
-`;
-
-exports[`blogFeed atom shows feed item for each post 1`] = `
-"<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
-<feed xmlns=\\"http://www.w3.org/2005/Atom\\">
-    <id>https://docusaurus.io/blog</id>
-    <title>Hello Blog</title>
-    <updated>2020-02-27T00:00:00.000Z</updated>
-    <generator>https://github.com/jpmonette/feed</generator>
-    <link rel=\\"alternate\\" href=\\"https://docusaurus.io/blog\\"/>
-    <subtitle>Hello Blog</subtitle>
-    <icon>https://docusaurus.io/image/favicon.ico</icon>
-    <rights>Copyright</rights>
-    <entry>
-        <title type=\\"html\\"><![CDATA[draft]]></title>
-        <id>draft</id>
-        <link href=\\"https://docusaurus.io/blog/draft\\"/>
-        <updated>2020-02-27T00:00:00.000Z</updated>
-        <summary type=\\"html\\"><![CDATA[this post should not be published yet]]></summary>
-    </entry>
-    <entry>
-        <title type=\\"html\\"><![CDATA[date-matter]]></title>
-        <id>date-matter</id>
-        <link href=\\"https://docusaurus.io/blog/date-matter\\"/>
-        <updated>2019-01-01T00:00:00.000Z</updated>
-        <summary type=\\"html\\"><![CDATA[date inside front matter]]></summary>
-    </entry>
-    <entry>
-        <title type=\\"html\\"><![CDATA[Happy 1st Birthday Slash! (translated)]]></title>
-        <id>Happy 1st Birthday Slash! (translated)</id>
-        <link href=\\"https://docusaurus.io/blog/2018/12/14/Happy-First-Birthday-Slash\\"/>
-        <updated>2018-12-14T00:00:00.000Z</updated>
-        <summary type=\\"html\\"><![CDATA[Happy birthday! (translated)]]></summary>
-    </entry>
-</feed>"
-`;
-
-exports[`blogFeed rss can show feed without posts 1`] = `
-"<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
-<rss version=\\"2.0\\">
-    <channel>
-        <title>Hello Blog</title>
-        <link>https://docusaurus.io/blog</link>
-        <description>Hello Blog</description>
-        <lastBuildDate>Sun, 25 Oct 2015 23:29:00 GMT</lastBuildDate>
-        <docs>https://validator.w3.org/feed/docs/rss2.html</docs>
-        <generator>https://github.com/jpmonette/feed</generator>
-        <copyright>Copyright</copyright>
-    </channel>
-</rss>"
-`;
-
-exports[`blogFeed rss shows feed item for each post 1`] = `
-"<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
-<rss version=\\"2.0\\">
-    <channel>
-        <title>Hello Blog</title>
-        <link>https://docusaurus.io/blog</link>
-        <description>Hello Blog</description>
-        <lastBuildDate>Thu, 27 Feb 2020 00:00:00 GMT</lastBuildDate>
-        <docs>https://validator.w3.org/feed/docs/rss2.html</docs>
-        <generator>https://github.com/jpmonette/feed</generator>
-        <copyright>Copyright</copyright>
-        <item>
-            <title><![CDATA[draft]]></title>
-            <link>https://docusaurus.io/blog/draft</link>
-            <guid>draft</guid>
-            <pubDate>Thu, 27 Feb 2020 00:00:00 GMT</pubDate>
-            <description><![CDATA[this post should not be published yet]]></description>
-        </item>
-        <item>
-            <title><![CDATA[date-matter]]></title>
-            <link>https://docusaurus.io/blog/date-matter</link>
-            <guid>date-matter</guid>
-            <pubDate>Tue, 01 Jan 2019 00:00:00 GMT</pubDate>
-            <description><![CDATA[date inside front matter]]></description>
-        </item>
-        <item>
-            <title><![CDATA[Happy 1st Birthday Slash! (translated)]]></title>
-            <link>https://docusaurus.io/blog/2018/12/14/Happy-First-Birthday-Slash</link>
-            <guid>Happy 1st Birthday Slash! (translated)</guid>
-            <pubDate>Fri, 14 Dec 2018 00:00:00 GMT</pubDate>
-            <description><![CDATA[Happy birthday! (translated)]]></description>
-        </item>
-    </channel>
-</rss>"
-`;

package/src/__tests__/__snapshots__/linkify.test.ts.snap

@@ -1,24 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`report broken markdown links 1`] = `
-"---
-title: This post links to another one!
----
-
-[Good link 1](/blog/2018/12/14/Happy-First-Birthday-Slash)
-
-[Good link 2](/blog/2018/12/14/Happy-First-Birthday-Slash)
-
-[Bad link 1](postNotExist1.md)
-
-[Bad link 1](./postNotExist2.mdx)
-"
-`;
-
-exports[`transform to correct link 1`] = `
-"---
-title: This post links to another one!
----
-
-[Linked post](/blog/2018/12/14/Happy-First-Birthday-Slash)"
-`;

package/src/__tests__/__snapshots__/pluginOptionSchema.test.ts.snap

@@ -1,5 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`should throw Error in case of invalid feedtype 1`] = `[ValidationError: "feedOptions.type" does not match any of the allowed types]`;
-
-exports[`should throw Error in case of invalid options 1`] = `[ValidationError: "postsPerPage" must be greater than or equal to 1]`;

package/src/__tests__/blogFrontMatter.test.ts

@@ -1,265 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import {
-  BlogPostFrontMatter,
-  validateBlogPostFrontMatter,
-} from '../blogFrontMatter';
-
-function testField(params: {
-  fieldName: keyof BlogPostFrontMatter;
-  validFrontMatters: BlogPostFrontMatter[];
-  convertibleFrontMatter?: [
-    ConvertableFrontMatter: Record<string, unknown>,
-    ConvertedFrontMatter: BlogPostFrontMatter,
-  ][];
-  invalidFrontMatters?: [
-    InvalidFrontMatter: Record<string, unknown>,
-    ErrorMessage: string,
-  ][];
-}) {
-  describe(`"${params.fieldName}" field`, () => {
-    test('accept valid values', () => {
-      params.validFrontMatters.forEach((frontMatter) => {
-        expect(validateBlogPostFrontMatter(frontMatter)).toEqual(frontMatter);
-      });
-    });
-
-    test('convert valid values', () => {
-      params.convertibleFrontMatter?.forEach(
-        ([convertibleFrontMatter, convertedFrontMatter]) => {
-          expect(validateBlogPostFrontMatter(convertibleFrontMatter)).toEqual(
-            convertedFrontMatter,
-          );
-        },
-      );
-    });
-
-    test('throw error for values', () => {
-      params.invalidFrontMatters?.forEach(([frontMatter, message]) => {
-        expect(() => validateBlogPostFrontMatter(frontMatter)).toThrow(message);
-      });
-    });
-  });
-}
-
-describe('validateBlogPostFrontMatter', () => {
-  test('accept empty object', () => {
-    const frontMatter = {};
-    expect(validateBlogPostFrontMatter(frontMatter)).toEqual(frontMatter);
-  });
-
-  test('accept unknown field', () => {
-    const frontMatter = {abc: '1'};
-    expect(validateBlogPostFrontMatter(frontMatter)).toEqual(frontMatter);
-  });
-
-  testField({
-    fieldName: 'description',
-    validFrontMatters: [
-      // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
-      {description: ''},
-      {description: 'description'},
-    ],
-  });
-
-  testField({
-    fieldName: 'title',
-    validFrontMatters: [
-      // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
-      {title: ''},
-      {title: 'title'},
-    ],
-  });
-
-  testField({
-    fieldName: 'id',
-    validFrontMatters: [{id: '123'}, {id: 'id'}],
-    invalidFrontMatters: [[{id: ''}, 'is not allowed to be empty']],
-  });
-
-  testField({
-    fieldName: 'author',
-    validFrontMatters: [{author: '123'}, {author: 'author'}],
-    invalidFrontMatters: [[{author: ''}, 'is not allowed to be empty']],
-  });
-
-  testField({
-    fieldName: 'authorTitle',
-    validFrontMatters: [{authorTitle: '123'}, {authorTitle: 'authorTitle'}],
-    invalidFrontMatters: [[{authorTitle: ''}, 'is not allowed to be empty']],
-  });
-
-  testField({
-    fieldName: 'author_title',
-    validFrontMatters: [{author_title: '123'}, {author_title: 'author_title'}],
-    invalidFrontMatters: [[{author_title: ''}, 'is not allowed to be empty']],
-  });
-
-  testField({
-    fieldName: 'authorURL',
-    validFrontMatters: [{authorURL: 'https://docusaurus.io'}],
-    invalidFrontMatters: [
-      [{authorURL: ''}, 'is not allowed to be empty'],
-      [{authorURL: '@site/api/author'}, 'must be a valid uri'],
-      [{authorURL: '../../api/author'}, 'must be a valid uri'],
-    ],
-  });
-
-  testField({
-    fieldName: 'author_url',
-    validFrontMatters: [{author_url: 'https://docusaurus.io'}],
-    invalidFrontMatters: [
-      [{author_url: ''}, 'is not allowed to be empty'],
-      [{author_url: '@site/api/author'}, 'must be a valid uri'],
-      [{author_url: '../../api/author'}, 'must be a valid uri'],
-    ],
-  });
-
-  testField({
-    fieldName: 'authorImageURL',
-    validFrontMatters: [
-      {authorImageURL: 'https://docusaurus.io/asset/image.png'},
-    ],
-    invalidFrontMatters: [
-      [{authorImageURL: ''}, 'is not allowed to be empty'],
-      [{authorImageURL: '@site/api/asset/image.png'}, 'must be a valid uri'],
-      [{authorImageURL: '../../api/asset/image.png'}, 'must be a valid uri'],
-    ],
-  });
-
-  testField({
-    fieldName: 'author_image_url',
-    validFrontMatters: [
-      {author_image_url: 'https://docusaurus.io/asset/image.png'},
-    ],
-    invalidFrontMatters: [
-      [{author_image_url: ''}, 'is not allowed to be empty'],
-      [{author_image_url: '@site/api/asset/image.png'}, 'must be a valid uri'],
-      [{author_image_url: '../../api/asset/image.png'}, 'must be a valid uri'],
-    ],
-  });
-
-  testField({
-    fieldName: 'slug',
-    validFrontMatters: [
-      {slug: 'blog/'},
-      {slug: '/blog'},
-      {slug: '/blog/'},
-      {slug: './blog'},
-      {slug: '../blog'},
-      {slug: '../../blog'},
-      {slug: '/api/plugins/@docusaurus/plugin-debug'},
-      {slug: '@site/api/asset/image.png'},
-    ],
-    invalidFrontMatters: [[{slug: ''}, 'is not allowed to be empty']],
-  });
-
-  testField({
-    fieldName: 'image',
-    validFrontMatters: [
-      {image: 'blog/'},
-      {image: '/blog'},
-      {image: '/blog/'},
-      {image: './blog'},
-      {image: '../blog'},
-      {image: '../../blog'},
-      {image: '/api/plugins/@docusaurus/plugin-debug'},
-      {image: '@site/api/asset/image.png'},
-    ],
-    invalidFrontMatters: [
-      [{image: ''}, 'is not allowed to be empty'],
-      [{image: 'https://docusaurus.io'}, 'must be a valid relative uri'],
-      [
-        {image: 'https://docusaurus.io/blog/image.png'},
-        'must be a valid relative uri',
-      ],
-    ],
-  });
-
-  testField({
-    fieldName: 'tags',
-    validFrontMatters: [
-      {tags: []},
-      {tags: ['hello']},
-      {tags: ['hello', 'world']},
-      {tags: ['hello', 'world']},
-      {tags: ['hello', {label: 'tagLabel', permalink: '/tagPermalink'}]},
-    ],
-    invalidFrontMatters: [
-      [{tags: ''}, 'must be an array'],
-      [{tags: ['']}, 'is not allowed to be empty'],
-    ],
-    // See https://github.com/facebook/docusaurus/issues/4642
-    convertibleFrontMatter: [
-      [{tags: [42]}, {tags: ['42']}],
-      [
-        {tags: [{label: 84, permalink: '/tagPermalink'}]},
-        {tags: [{label: '84', permalink: '/tagPermalink'}]},
-      ],
-    ],
-  });
-
-  testField({
-    fieldName: 'keywords',
-    validFrontMatters: [
-      {keywords: ['hello']},
-      {keywords: ['hello', 'world']},
-      {keywords: ['hello', 'world']},
-      {keywords: ['hello']},
-    ],
-    invalidFrontMatters: [
-      [{keywords: ''}, 'must be an array'],
-      [{keywords: ['']}, 'is not allowed to be empty'],
-      [{keywords: []}, 'does not contain 1 required value(s)'],
-    ],
-  });
-
-  testField({
-    fieldName: 'draft',
-    validFrontMatters: [{draft: true}, {draft: false}],
-    convertibleFrontMatter: [
-      [{draft: 'true'}, {draft: true}],
-      [{draft: 'false'}, {draft: false}],
-    ],
-    invalidFrontMatters: [
-      [{draft: 'yes'}, 'must be a boolean'],
-      [{draft: 'no'}, 'must be a boolean'],
-    ],
-  });
-
-  testField({
-    fieldName: 'hide_table_of_contents',
-    validFrontMatters: [
-      {hide_table_of_contents: true},
-      {hide_table_of_contents: false},
-    ],
-    convertibleFrontMatter: [
-      [{hide_table_of_contents: 'true'}, {hide_table_of_contents: true}],
-      [{hide_table_of_contents: 'false'}, {hide_table_of_contents: false}],
-    ],
-    invalidFrontMatters: [
-      [{hide_table_of_contents: 'yes'}, 'must be a boolean'],
-      [{hide_table_of_contents: 'no'}, 'must be a boolean'],
-    ],
-  });
-
-  testField({
-    fieldName: 'date',
-    validFrontMatters: [
-      {date: new Date('2020-01-01')},
-      // @ts-expect-error: string for test
-      {date: '2020-01-01'},
-      // @ts-expect-error: string for test
-      {date: '2020'},
-    ],
-    invalidFrontMatters: [
-      [{date: 'abc'}, 'must be a valid date'],
-      [{date: ''}, 'must be a valid date'],
-    ],
-  });
-});