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

package/src/__tests__/generateBlogFeed.test.ts

@@ -1,100 +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';
-
-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('can 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: '/',
-          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: ['*r*.md', '*.mdx'], // skip no-date.md - it won't play nice with snapshots
-            feedOptions: {
-              type: [feedType],
-              copyright: 'Copyright',
-            },
-          } as PluginOptions,
-        );
-        const feedContent =
-          feed && (feedType === 'rss' ? feed.rss2() : feed.atom1());
-        expect(feedContent).toMatchSnapshot();
-      });
-    });
-  });
-});

package/src/__tests__/index.test.ts

@@ -1,336 +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.
- */
-
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-
-import fs from 'fs-extra';
-import path from 'path';
-import pluginContentBlog from '../index';
-import {DocusaurusConfig, LoadContext, I18n} from '@docusaurus/types';
-import {PluginOptionSchema} from '../pluginOptionSchema';
-import {PluginOptions, EditUrlFunction, BlogPost} from '../types';
-import {Joi} from '@docusaurus/utils-validation';
-
-function findByTitle(
-  blogPosts: BlogPost[],
-  title: string,
-): BlogPost | undefined {
-  return blogPosts.find((v) => v.metadata.title === title);
-}
-function getByTitle(blogPosts: BlogPost[], title: string): BlogPost {
-  const post = findByTitle(blogPosts, title);
-  if (!post) {
-    throw new Error(`can't find blog post with title ${title}.
-Available blog post titles are:\n- ${blogPosts
-      .map((p) => p.metadata.title)
-      .join('\n- ')}`);
-  }
-  return post;
-}
-
-function getI18n(locale: string): I18n {
-  return {
-    currentLocale: locale,
-    locales: [locale],
-    defaultLocale: locale,
-    localeConfigs: {},
-  };
-}
-
-const DefaultI18N: I18n = getI18n('en');
-
-function validateAndNormalize(
-  schema: Joi.ObjectSchema,
-  options: Partial<PluginOptions>,
-) {
-  const {value, error} = schema.validate(options);
-  if (error) {
-    throw error;
-  } else {
-    return value;
-  }
-}
-
-describe('loadBlog', () => {
-  const PluginPath = 'blog';
-
-  const BaseEditUrl = 'https://baseEditUrl.com/edit';
-
-  const getBlogPosts = async (
-    siteDir: string,
-    pluginOptions: Partial<PluginOptions> = {},
-    i18n: I18n = DefaultI18N,
-  ) => {
-    const generatedFilesDir: string = path.resolve(siteDir, '.docusaurus');
-    const siteConfig = {
-      title: 'Hello',
-      baseUrl: '/',
-      url: 'https://docusaurus.io',
-    } as DocusaurusConfig;
-    const plugin = pluginContentBlog(
-      {
-        siteDir,
-        siteConfig,
-        generatedFilesDir,
-        i18n,
-      } as LoadContext,
-      validateAndNormalize(PluginOptionSchema, {
-        path: PluginPath,
-        editUrl: BaseEditUrl,
-        ...pluginOptions,
-      }),
-    );
-    const {blogPosts} = (await plugin.loadContent!())!;
-
-    return blogPosts;
-  };
-
-  test('simple website', async () => {
-    const siteDir = path.join(__dirname, '__fixtures__', 'website');
-    const blogPosts = await getBlogPosts(siteDir);
-
-    expect({
-      ...getByTitle(blogPosts, 'date-matter').metadata,
-      ...{prevItem: undefined},
-    }).toEqual({
-      editUrl: `${BaseEditUrl}/blog/date-matter.md`,
-      permalink: '/blog/date-matter',
-      readingTime: 0.02,
-      source: path.posix.join('@site', PluginPath, 'date-matter.md'),
-      title: 'date-matter',
-      description: `date inside front matter`,
-      date: new Date('2019-01-01'),
-      formattedDate: 'January 1, 2019',
-      prevItem: undefined,
-      tags: [],
-      nextItem: {
-        permalink: '/blog/2018/12/14/Happy-First-Birthday-Slash',
-        title: 'Happy 1st Birthday Slash! (translated)',
-      },
-      truncated: false,
-    });
-
-    expect(
-      getByTitle(blogPosts, 'Happy 1st Birthday Slash! (translated)').metadata,
-    ).toEqual({
-      editUrl: `${BaseEditUrl}/blog/2018-12-14-Happy-First-Birthday-Slash.md`,
-      permalink: '/blog/2018/12/14/Happy-First-Birthday-Slash',
-      readingTime: 0.015,
-      source: path.posix.join(
-        '@site',
-        // pluginPath,
-        path.posix.join('i18n', 'en', 'docusaurus-plugin-content-blog'),
-        '2018-12-14-Happy-First-Birthday-Slash.md',
-      ),
-      title: 'Happy 1st Birthday Slash! (translated)',
-      description: `Happy birthday! (translated)`,
-      date: new Date('2018-12-14'),
-      formattedDate: 'December 14, 2018',
-      tags: [],
-      prevItem: {
-        permalink: '/blog/date-matter',
-        title: 'date-matter',
-      },
-      truncated: false,
-    });
-
-    expect({
-      ...getByTitle(blogPosts, 'Complex Slug').metadata,
-      ...{prevItem: undefined},
-    }).toEqual({
-      editUrl: `${BaseEditUrl}/blog/complex-slug.md`,
-      permalink: '/blog/hey/my super path/héllô',
-      readingTime: 0.015,
-      source: path.posix.join('@site', PluginPath, 'complex-slug.md'),
-      title: 'Complex Slug',
-      description: `complex url slug`,
-      prevItem: undefined,
-      nextItem: {
-        permalink: '/blog/simple/slug',
-        title: 'Simple Slug',
-      },
-      date: new Date('2020-08-16'),
-      formattedDate: 'August 16, 2020',
-      tags: [],
-      truncated: false,
-    });
-
-    expect({
-      ...getByTitle(blogPosts, 'Simple Slug').metadata,
-      ...{prevItem: undefined},
-    }).toEqual({
-      editUrl: `${BaseEditUrl}/blog/simple-slug.md`,
-      permalink: '/blog/simple/slug',
-      readingTime: 0.015,
-      source: path.posix.join('@site', PluginPath, 'simple-slug.md'),
-      title: 'Simple Slug',
-      description: `simple url slug`,
-      prevItem: undefined,
-      nextItem: {
-        permalink: '/blog/draft',
-        title: 'draft',
-      },
-      date: new Date('2020-08-15'),
-      formattedDate: 'August 15, 2020',
-      tags: [],
-      truncated: false,
-    });
-
-    expect({
-      ...getByTitle(blogPosts, 'some heading').metadata,
-      prevItem: undefined,
-    }).toEqual({
-      editUrl: `${BaseEditUrl}/blog/heading-as-title.md`,
-      permalink: '/blog/heading-as-title',
-      readingTime: 0,
-      source: path.posix.join('@site', PluginPath, 'heading-as-title.md'),
-      title: 'some heading',
-      description: '',
-      date: new Date('2019-01-02'),
-      formattedDate: 'January 2, 2019',
-      prevItem: undefined,
-      tags: [],
-      nextItem: {
-        permalink: '/blog/date-matter',
-        title: 'date-matter',
-      },
-      truncated: false,
-    });
-  });
-
-  test('simple website blog dates localized', async () => {
-    const siteDir = path.join(__dirname, '__fixtures__', 'website');
-    const blogPostsFrench = await getBlogPosts(siteDir, {}, getI18n('fr'));
-    expect(blogPostsFrench).toHaveLength(6);
-    expect(blogPostsFrench[0].metadata.formattedDate).toMatchInlineSnapshot(
-      `"16 août 2020"`,
-    );
-    expect(blogPostsFrench[1].metadata.formattedDate).toMatchInlineSnapshot(
-      `"15 août 2020"`,
-    );
-    expect(blogPostsFrench[2].metadata.formattedDate).toMatchInlineSnapshot(
-      `"27 février 2020"`,
-    );
-    expect(blogPostsFrench[3].metadata.formattedDate).toMatchInlineSnapshot(
-      `"2 janvier 2019"`,
-    );
-    expect(blogPostsFrench[4].metadata.formattedDate).toMatchInlineSnapshot(
-      `"1 janvier 2019"`,
-    );
-    expect(blogPostsFrench[5].metadata.formattedDate).toMatchInlineSnapshot(
-      `"14 décembre 2018"`,
-    );
-  });
-
-  test('edit url with editLocalizedBlogs true', async () => {
-    const siteDir = path.join(__dirname, '__fixtures__', 'website');
-    const blogPosts = await getBlogPosts(siteDir, {editLocalizedFiles: true});
-
-    const localizedBlogPost = blogPosts.find(
-      (v) => v.metadata.title === 'Happy 1st Birthday Slash! (translated)',
-    )!;
-
-    expect(localizedBlogPost.metadata.editUrl).toEqual(
-      `${BaseEditUrl}/i18n/en/docusaurus-plugin-content-blog/2018-12-14-Happy-First-Birthday-Slash.md`,
-    );
-  });
-
-  test('edit url with editUrl function', async () => {
-    const siteDir = path.join(__dirname, '__fixtures__', 'website');
-
-    const hardcodedEditUrl = 'hardcoded-edit-url';
-    const editUrlFunction: EditUrlFunction = jest.fn(() => hardcodedEditUrl);
-
-    const blogPosts = await getBlogPosts(siteDir, {editUrl: editUrlFunction});
-
-    blogPosts.forEach((blogPost) => {
-      expect(blogPost.metadata.editUrl).toEqual(hardcodedEditUrl);
-    });
-
-    expect(editUrlFunction).toHaveBeenCalledTimes(6);
-    expect(editUrlFunction).toHaveBeenCalledWith({
-      blogDirPath: 'blog',
-      blogPath: 'date-matter.md',
-      permalink: '/blog/date-matter',
-      locale: 'en',
-    });
-    expect(editUrlFunction).toHaveBeenCalledWith({
-      blogDirPath: 'blog',
-      blogPath: 'draft.md',
-      permalink: '/blog/draft',
-      locale: 'en',
-    });
-    expect(editUrlFunction).toHaveBeenCalledWith({
-      blogDirPath: 'blog',
-      blogPath: 'complex-slug.md',
-      permalink: '/blog/hey/my super path/héllô',
-      locale: 'en',
-    });
-    expect(editUrlFunction).toHaveBeenCalledWith({
-      blogDirPath: 'blog',
-      blogPath: 'simple-slug.md',
-      permalink: '/blog/simple/slug',
-      locale: 'en',
-    });
-    expect(editUrlFunction).toHaveBeenCalledWith({
-      blogDirPath: 'i18n/en/docusaurus-plugin-content-blog',
-      blogPath: '2018-12-14-Happy-First-Birthday-Slash.md',
-      permalink: '/blog/2018/12/14/Happy-First-Birthday-Slash',
-      locale: 'en',
-    });
-    expect(editUrlFunction).toHaveBeenCalledWith({
-      blogDirPath: 'blog',
-      blogPath: 'heading-as-title.md',
-      locale: 'en',
-      permalink: '/blog/heading-as-title',
-    });
-  });
-
-  test('draft blog post not exists in production build', async () => {
-    process.env.NODE_ENV = 'production';
-    const siteDir = path.join(__dirname, '__fixtures__', 'website');
-    const blogPosts = await getBlogPosts(siteDir);
-
-    expect(blogPosts.find((v) => v.metadata.title === 'draft')).toBeUndefined();
-  });
-
-  test('create blog post without date', async () => {
-    const siteDir = path.join(
-      __dirname,
-      '__fixtures__',
-      'website-blog-without-date',
-    );
-    const blogPosts = await getBlogPosts(siteDir);
-    const noDateSource = path.posix.join('@site', PluginPath, 'no date.md');
-    const noDateSourceBirthTime = (
-      await fs.stat(noDateSource.replace('@site', siteDir))
-    ).birthtime;
-    const formattedDate = Intl.DateTimeFormat('en', {
-      day: 'numeric',
-      month: 'long',
-      year: 'numeric',
-    }).format(noDateSourceBirthTime);
-
-    expect({
-      ...getByTitle(blogPosts, 'no date').metadata,
-      ...{prevItem: undefined},
-    }).toEqual({
-      editUrl: `${BaseEditUrl}/blog/no date.md`,
-      permalink: '/blog/no date',
-      readingTime: 0.01,
-      source: noDateSource,
-      title: 'no date',
-      description: `no date`,
-      date: noDateSourceBirthTime,
-      formattedDate,
-      tags: [],
-      prevItem: undefined,
-      nextItem: undefined,
-      truncated: false,
-    });
-  });
-});

package/src/__tests__/linkify.test.ts

@@ -1,93 +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 fs from 'fs-extra';
-import path from 'path';
-import {linkify, LinkifyParams, getSourceToPermalink} from '../blogUtils';
-import {BlogBrokenMarkdownLink, BlogContentPaths, BlogPost} from '../types';
-
-const siteDir = path.join(__dirname, '__fixtures__', 'website');
-const contentPaths: BlogContentPaths = {
-  contentPath: path.join(siteDir, 'blog-with-ref'),
-  contentPathLocalized: path.join(siteDir, 'blog-with-ref-localized'),
-};
-const pluginDir = 'blog-with-ref';
-const blogPosts: BlogPost[] = [
-  {
-    id: 'Happy 1st Birthday Slash!',
-    metadata: {
-      permalink: '/blog/2018/12/14/Happy-First-Birthday-Slash',
-      source: path.posix.join(
-        '@site',
-        pluginDir,
-        '2018-12-14-Happy-First-Birthday-Slash.md',
-      ),
-      title: 'Happy 1st Birthday Slash!',
-      description: `pattern name`,
-      date: new Date('2018-12-14'),
-      tags: [],
-      prevItem: {
-        permalink: '/blog/2019/01/01/date-matter',
-        title: 'date-matter',
-      },
-      truncated: false,
-    },
-  },
-];
-
-const transform = (filePath: string, options?: Partial<LinkifyParams>) => {
-  const fileContent = fs.readFileSync(filePath, 'utf-8');
-  const transformedContent = linkify({
-    filePath,
-    fileString: fileContent,
-    siteDir,
-    contentPaths,
-    sourceToPermalink: getSourceToPermalink(blogPosts),
-    onBrokenMarkdownLink: (brokenMarkdownLink) => {
-      throw new Error(
-        `Broken markdown link found: ${JSON.stringify(brokenMarkdownLink)}`,
-      );
-    },
-    ...options,
-  });
-  return [fileContent, transformedContent];
-};
-
-test('transform to correct link', () => {
-  const post = path.join(contentPaths.contentPath, 'post.md');
-  const [content, transformedContent] = transform(post);
-  expect(transformedContent).toMatchSnapshot();
-  expect(transformedContent).toContain(
-    '](/blog/2018/12/14/Happy-First-Birthday-Slash',
-  );
-  expect(transformedContent).not.toContain(
-    '](2018-12-14-Happy-First-Birthday-Slash.md)',
-  );
-  expect(content).not.toEqual(transformedContent);
-});
-
-test('report broken markdown links', () => {
-  const filePath = 'post-with-broken-links.md';
-  const folderPath = contentPaths.contentPath;
-  const postWithBrokenLinks = path.join(folderPath, filePath);
-  const onBrokenMarkdownLink = jest.fn();
-  const [, transformedContent] = transform(postWithBrokenLinks, {
-    onBrokenMarkdownLink,
-  });
-  expect(transformedContent).toMatchSnapshot();
-  expect(onBrokenMarkdownLink).toHaveBeenCalledTimes(2);
-  expect(onBrokenMarkdownLink).toHaveBeenNthCalledWith(1, {
-    filePath: path.resolve(folderPath, filePath),
-    contentPaths,
-    link: 'postNotExist1.md',
-  } as BlogBrokenMarkdownLink);
-  expect(onBrokenMarkdownLink).toHaveBeenNthCalledWith(2, {
-    filePath: path.resolve(folderPath, filePath),
-    contentPaths,
-    link: './postNotExist2.mdx',
-  } as BlogBrokenMarkdownLink);
-});

package/src/__tests__/pluginOptionSchema.test.ts

@@ -1,150 +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 {PluginOptionSchema, DEFAULT_OPTIONS} from '../pluginOptionSchema';
-
-// the type of remark/rehype plugins can be either function, object or array
-const markdownPluginsFunctionStub = () => {};
-const markdownPluginsObjectStub = {};
-
-test('should normalize options', () => {
-  const {value, error} = PluginOptionSchema.validate({});
-  expect(value).toEqual(DEFAULT_OPTIONS);
-  expect(error).toBe(undefined);
-});
-
-test('should accept correctly defined user options', () => {
-  const userOptions = {
-    ...DEFAULT_OPTIONS,
-    feedOptions: {type: 'rss', title: 'myTitle'},
-    path: 'not_blog',
-    routeBasePath: 'myBlog',
-    postsPerPage: 5,
-    include: ['api/*', 'docs/*'],
-  };
-  const {value, error} = PluginOptionSchema.validate(userOptions);
-  expect(value).toEqual({
-    ...userOptions,
-    feedOptions: {type: ['rss'], title: 'myTitle'},
-  });
-  expect(error).toBe(undefined);
-});
-
-test('should accept valid user options', async () => {
-  const userOptions = {
-    ...DEFAULT_OPTIONS,
-    routeBasePath: 'myBlog',
-    beforeDefaultRemarkPlugins: [],
-    beforeDefaultRehypePlugins: [markdownPluginsFunctionStub],
-    remarkPlugins: [[markdownPluginsFunctionStub, {option1: '42'}]],
-    rehypePlugins: [
-      markdownPluginsObjectStub,
-      [markdownPluginsFunctionStub, {option1: '42'}],
-    ],
-  };
-  const {value, error} = await PluginOptionSchema.validate(userOptions);
-  expect(value).toEqual(userOptions);
-  expect(error).toBe(undefined);
-});
-
-test('should throw Error in case of invalid options', () => {
-  const {error} = PluginOptionSchema.validate({
-    path: 'not_blog',
-    postsPerPage: -1,
-    include: ['api/*', 'docs/*'],
-    routeBasePath: 'not_blog',
-  });
-
-  expect(error).toMatchSnapshot();
-});
-
-test('should throw Error in case of invalid feedtype', () => {
-  const {error} = PluginOptionSchema.validate({
-    feedOptions: {
-      type: 'none',
-    },
-  });
-
-  expect(error).toMatchSnapshot();
-});
-
-test('should convert all feed type to array with other feed type', () => {
-  const {value} = PluginOptionSchema.validate({
-    feedOptions: {type: 'all'},
-  });
-  expect(value).toEqual({
-    ...DEFAULT_OPTIONS,
-    feedOptions: {type: ['rss', 'atom']},
-  });
-});
-
-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'},
-  });
-});
-
-describe('blog sidebar', () => {
-  test('should accept 0 sidebar count', () => {
-    const userOptions = {blogSidebarCount: 0};
-    const {value, error} = PluginOptionSchema.validate(userOptions);
-    expect(value).toEqual({...DEFAULT_OPTIONS, ...userOptions});
-    expect(error).toBe(undefined);
-  });
-
-  test('should accept "ALL" sidebar count', () => {
-    const userOptions = {blogSidebarCount: 'ALL'};
-    const {value, error} = PluginOptionSchema.validate(userOptions);
-    expect(value).toEqual({...DEFAULT_OPTIONS, ...userOptions});
-    expect(error).toBe(undefined);
-  });
-
-  test('should reject "abcdef" sidebar count', () => {
-    const userOptions = {blogSidebarCount: 'abcdef'};
-    const {error} = PluginOptionSchema.validate(userOptions);
-    expect(error).toMatchInlineSnapshot(
-      `[ValidationError: "blogSidebarCount" must be one of [ALL, number]]`,
-    );
-  });
-
-  test('should accept "all posts" sidebar title', () => {
-    const userOptions = {blogSidebarTitle: 'all posts'};
-    const {value, error} = PluginOptionSchema.validate(userOptions);
-    expect(value).toEqual({...DEFAULT_OPTIONS, ...userOptions});
-    expect(error).toBe(undefined);
-  });
-
-  test('should reject 42 sidebar title', () => {
-    const userOptions = {blogSidebarTitle: 42};
-    const {error} = PluginOptionSchema.validate(userOptions);
-    expect(error).toMatchInlineSnapshot(
-      `[ValidationError: "blogSidebarTitle" must be a string]`,
-    );
-  });
-});