@docusaurus/plugin-content-blog 2.0.0-beta.fc64c12e4 → 2.0.0

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

@@ -1,116 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`blogFeed atom should not show feed without posts 1`] = `null`;
-
-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/myBaseUrl/blog</id>
-    <title>Hello Blog</title>
-    <updated>2020-08-16T00:00:00.000Z</updated>
-    <generator>https://github.com/jpmonette/feed</generator>
-    <link rel=\\"alternate\\" href=\\"https://docusaurus.io/myBaseUrl/blog\\"/>
-    <subtitle>Hello Blog</subtitle>
-    <icon>https://docusaurus.io/myBaseUrl/image/favicon.ico</icon>
-    <rights>Copyright</rights>
-    <entry>
-        <title type=\\"html\\"><![CDATA[Complex Slug]]></title>
-        <id>/hey/my super path/héllô</id>
-        <link href=\\"https://docusaurus.io/myBaseUrl/blog/hey/my super path/héllô\\"/>
-        <updated>2020-08-16T00:00:00.000Z</updated>
-        <summary type=\\"html\\"><![CDATA[complex url slug]]></summary>
-    </entry>
-    <entry>
-        <title type=\\"html\\"><![CDATA[Simple Slug]]></title>
-        <id>/simple/slug</id>
-        <link href=\\"https://docusaurus.io/myBaseUrl/blog/simple/slug\\"/>
-        <updated>2020-08-15T00:00:00.000Z</updated>
-        <summary type=\\"html\\"><![CDATA[simple url slug]]></summary>
-    </entry>
-    <entry>
-        <title type=\\"html\\"><![CDATA[draft]]></title>
-        <id>draft</id>
-        <link href=\\"https://docusaurus.io/myBaseUrl/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[some heading]]></title>
-        <id>some heading</id>
-        <link href=\\"https://docusaurus.io/myBaseUrl/blog/heading-as-title\\"/>
-        <updated>2019-01-02T00:00:00.000Z</updated>
-    </entry>
-    <entry>
-        <title type=\\"html\\"><![CDATA[date-matter]]></title>
-        <id>date-matter</id>
-        <link href=\\"https://docusaurus.io/myBaseUrl/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/myBaseUrl/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 should not show feed without posts 1`] = `null`;
-
-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/myBaseUrl/blog</link>
-        <description>Hello Blog</description>
-        <lastBuildDate>Sun, 16 Aug 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[Complex Slug]]></title>
-            <link>https://docusaurus.io/myBaseUrl/blog/hey/my super path/héllô</link>
-            <guid>/hey/my super path/héllô</guid>
-            <pubDate>Sun, 16 Aug 2020 00:00:00 GMT</pubDate>
-            <description><![CDATA[complex url slug]]></description>
-        </item>
-        <item>
-            <title><![CDATA[Simple Slug]]></title>
-            <link>https://docusaurus.io/myBaseUrl/blog/simple/slug</link>
-            <guid>/simple/slug</guid>
-            <pubDate>Sat, 15 Aug 2020 00:00:00 GMT</pubDate>
-            <description><![CDATA[simple url slug]]></description>
-        </item>
-        <item>
-            <title><![CDATA[draft]]></title>
-            <link>https://docusaurus.io/myBaseUrl/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[some heading]]></title>
-            <link>https://docusaurus.io/myBaseUrl/blog/heading-as-title</link>
-            <guid>some heading</guid>
-            <pubDate>Wed, 02 Jan 2019 00:00:00 GMT</pubDate>
-        </item>
-        <item>
-            <title><![CDATA[date-matter]]></title>
-            <link>https://docusaurus.io/myBaseUrl/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/myBaseUrl/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,317 +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';
-import escapeStringRegexp from 'escape-string-regexp';
-
-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]) => {
-        try {
-          validateBlogPostFrontMatter(frontMatter);
-          fail(
-            new Error(
-              `Blog frontmatter is expected to be rejected, but was accepted successfully:\n ${JSON.stringify(
-                frontMatter,
-                null,
-                2,
-              )}`,
-            ),
-          );
-        } catch (e) {
-          expect(e.message).toMatch(new RegExp(escapeStringRegexp(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);
-  });
-});
-
-describe('validateBlogPostFrontMatter description', () => {
-  testField({
-    fieldName: 'description',
-    validFrontMatters: [
-      // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
-      {description: ''},
-      {description: 'description'},
-    ],
-  });
-});
-
-describe('validateBlogPostFrontMatter title', () => {
-  testField({
-    fieldName: 'title',
-    validFrontMatters: [
-      // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
-      {title: ''},
-      {title: 'title'},
-    ],
-  });
-});
-
-describe('validateBlogPostFrontMatter id', () => {
-  testField({
-    fieldName: 'id',
-    validFrontMatters: [{id: '123'}, {id: 'id'}],
-    invalidFrontMatters: [[{id: ''}, 'is not allowed to be empty']],
-  });
-});
-
-describe('validateBlogPostFrontMatter author', () => {
-  testField({
-    fieldName: 'author',
-    validFrontMatters: [{author: '123'}, {author: 'author'}],
-    invalidFrontMatters: [[{author: ''}, 'is not allowed to be empty']],
-  });
-});
-
-describe('validateBlogPostFrontMatter author_title', () => {
-  testField({
-    fieldName: 'author_title',
-    validFrontMatters: [{author_title: '123'}, {author_title: 'author_title'}],
-    invalidFrontMatters: [[{author_title: ''}, 'is not allowed to be empty']],
-  });
-
-  testField({
-    fieldName: 'authorTitle',
-    validFrontMatters: [{authorTitle: '123'}, {authorTitle: 'authorTitle'}],
-    invalidFrontMatters: [[{authorTitle: ''}, 'is not allowed to be empty']],
-  });
-});
-
-describe('validateBlogPostFrontMatter author_url', () => {
-  testField({
-    fieldName: 'author_url',
-    validFrontMatters: [
-      {author_url: 'https://docusaurus.io'},
-      {author_url: '../../relative'},
-      {author_url: '/absolute'},
-    ],
-    invalidFrontMatters: [
-      [
-        {author_url: ''},
-        '"author_url" does not match any of the allowed types',
-      ],
-    ],
-  });
-
-  testField({
-    fieldName: 'authorURL',
-    validFrontMatters: [
-      {authorURL: 'https://docusaurus.io'},
-      {authorURL: '../../relative'},
-      {authorURL: '/absolute'},
-    ],
-
-    invalidFrontMatters: [
-      [{authorURL: ''}, '"authorURL" does not match any of the allowed types'],
-    ],
-  });
-});
-
-describe('validateBlogPostFrontMatter author_image_url', () => {
-  testField({
-    fieldName: 'author_image_url',
-    validFrontMatters: [
-      {author_image_url: 'https://docusaurus.io/asset/image.png'},
-      {author_image_url: '../../relative'},
-      {author_image_url: '/absolute'},
-    ],
-    invalidFrontMatters: [
-      [
-        {author_image_url: ''},
-        '"author_image_url" does not match any of the allowed types',
-      ],
-    ],
-  });
-
-  testField({
-    fieldName: 'authorImageURL',
-    validFrontMatters: [
-      {authorImageURL: 'https://docusaurus.io/asset/image.png'},
-      {authorImageURL: '../../relative'},
-      {authorImageURL: '/absolute'},
-    ],
-    invalidFrontMatters: [
-      [
-        {authorImageURL: ''},
-        '"authorImageURL" does not match any of the allowed types',
-      ],
-    ],
-  });
-});
-
-describe('validateBlogPostFrontMatter slug', () => {
-  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']],
-  });
-});
-
-describe('validateBlogPostFrontMatter image', () => {
-  testField({
-    fieldName: 'image',
-    validFrontMatters: [
-      {image: 'https://docusaurus.io/image.png'},
-      {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: ''}, '"image" does not match any of the allowed types'],
-    ],
-  });
-});
-
-describe('validateBlogPostFrontMatter tags', () => {
-  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'}]},
-      ],
-    ],
-  });
-});
-
-describe('validateBlogPostFrontMatter keywords', () => {
-  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)'],
-    ],
-  });
-});
-
-describe('validateBlogPostFrontMatter draft', () => {
-  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'],
-    ],
-  });
-});
-
-describe('validateBlogPostFrontMatter hide_table_of_contents', () => {
-  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'],
-    ],
-  });
-});
-
-describe('validateBlogPostFrontMatter date', () => {
-  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'],
-    ],
-  });
-});

package/src/__tests__/generateBlogFeed.test.ts

@@ -1,102 +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 path from 'path';
-import {generateBlogFeed} from '../blogUtils';
-import {LoadContext, I18n} from '@docusaurus/types';
-import {PluginOptions, BlogContentPaths} from '../types';
-import {DEFAULT_OPTIONS} from '../pluginOptionSchema';
-
-const DefaultI18N: I18n = {
-  currentLocale: 'en',
-  locales: ['en'],
-  defaultLocale: 'en',
-  localeConfigs: {},
-};
-
-function getBlogContentPaths(siteDir: string): BlogContentPaths {
-  return {
-    contentPath: path.resolve(siteDir, 'blog'),
-    contentPathLocalized: path.resolve(
-      siteDir,
-      'i18n',
-      'en',
-      'docusaurus-plugin-content-blog',
-    ),
-  };
-}
-
-describe('blogFeed', () => {
-  (['atom', 'rss'] as const).forEach((feedType) => {
-    describe(`${feedType}`, () => {
-      test('should not show feed without posts', async () => {
-        const siteDir = __dirname;
-        const siteConfig = {
-          title: 'Hello',
-          baseUrl: '/',
-          url: 'https://docusaurus.io',
-          favicon: 'image/favicon.ico',
-        };
-
-        const feed = await generateBlogFeed(
-          getBlogContentPaths(siteDir),
-          {
-            siteDir,
-            siteConfig,
-            i18n: DefaultI18N,
-          } as LoadContext,
-          {
-            path: 'invalid-blog-path',
-            routeBasePath: 'blog',
-            include: ['*.md', '*.mdx'],
-            feedOptions: {
-              type: [feedType],
-              copyright: 'Copyright',
-            },
-          } as PluginOptions,
-        );
-        const feedContent =
-          feed && (feedType === 'rss' ? feed.rss2() : feed.atom1());
-        expect(feedContent).toMatchSnapshot();
-      });
-
-      test('shows feed item for each post', async () => {
-        const siteDir = path.join(__dirname, '__fixtures__', 'website');
-        const generatedFilesDir = path.resolve(siteDir, '.docusaurus');
-        const siteConfig = {
-          title: 'Hello',
-          baseUrl: '/myBaseUrl/',
-          url: 'https://docusaurus.io',
-          favicon: 'image/favicon.ico',
-        };
-
-        const feed = await generateBlogFeed(
-          getBlogContentPaths(siteDir),
-          {
-            siteDir,
-            siteConfig,
-            generatedFilesDir,
-            i18n: DefaultI18N,
-          } as LoadContext,
-          {
-            path: 'blog',
-            routeBasePath: 'blog',
-            include: DEFAULT_OPTIONS.include,
-            exclude: DEFAULT_OPTIONS.exclude,
-            feedOptions: {
-              type: [feedType],
-              copyright: 'Copyright',
-            },
-          } as PluginOptions,
-        );
-        const feedContent =
-          feed && (feedType === 'rss' ? feed.rss2() : feed.atom1());
-        expect(feedContent).toMatchSnapshot();
-      });
-    });
-  });
-});