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

package/src/__tests__/cli.test.ts

@@ -1,337 +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 {cliDocsVersionCommand} from '../cli';
-import {PathOptions, SidebarOptions} from '../types';
-import fs from 'fs-extra';
-import {
-  getVersionedDocsDirPath,
-  getVersionsFilePath,
-  getVersionedSidebarsDirPath,
-} from '../versions';
-import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
-
-const fixtureDir = path.join(__dirname, '__fixtures__');
-
-describe('docsVersion', () => {
-  const simpleSiteDir = path.join(fixtureDir, 'simple-site');
-  const versionedSiteDir = path.join(fixtureDir, 'versioned-site');
-
-  const DEFAULT_OPTIONS: PathOptions & SidebarOptions = {
-    path: 'docs',
-    sidebarPath: '',
-    sidebarCollapsed: true,
-    sidebarCollapsible: true,
-  };
-
-  test('no version tag provided', () => {
-    expect(() =>
-      cliDocsVersionCommand(
-        null,
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: no version tag specified! Pass the version you wish to create as an argument, for example: 1.0.0."`,
-    );
-    expect(() =>
-      cliDocsVersionCommand(
-        undefined,
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: no version tag specified! Pass the version you wish to create as an argument, for example: 1.0.0."`,
-    );
-    expect(() =>
-      cliDocsVersionCommand(
-        '',
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: no version tag specified! Pass the version you wish to create as an argument, for example: 1.0.0."`,
-    );
-  });
-
-  test('version tag should not have slash', () => {
-    expect(() =>
-      cliDocsVersionCommand(
-        'foo/bar',
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\\\). Try something like: 1.0.0."`,
-    );
-    expect(() =>
-      cliDocsVersionCommand(
-        'foo\\bar',
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\\\). Try something like: 1.0.0."`,
-    );
-  });
-
-  test('version tag should not be too long', () => {
-    expect(() =>
-      cliDocsVersionCommand(
-        'a'.repeat(255),
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: invalid version tag specified! Length cannot exceed 32 characters. Try something like: 1.0.0."`,
-    );
-  });
-
-  test('version tag should not be a dot or two dots', () => {
-    expect(() =>
-      cliDocsVersionCommand(
-        '..',
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: invalid version tag specified! Do not name your version \\".\\" or \\"..\\". Try something like: 1.0.0."`,
-    );
-    expect(() =>
-      cliDocsVersionCommand(
-        '.',
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: invalid version tag specified! Do not name your version \\".\\" or \\"..\\". Try something like: 1.0.0."`,
-    );
-  });
-
-  test('version tag should be a valid pathname', () => {
-    expect(() =>
-      cliDocsVersionCommand(
-        '<foo|bar>',
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: invalid version tag specified! Please ensure its a valid pathname too. Try something like: 1.0.0."`,
-    );
-    expect(() =>
-      cliDocsVersionCommand(
-        'foo\x00bar',
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: invalid version tag specified! Please ensure its a valid pathname too. Try something like: 1.0.0."`,
-    );
-    expect(() =>
-      cliDocsVersionCommand(
-        'foo:bar',
-        simpleSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: invalid version tag specified! Please ensure its a valid pathname too. Try something like: 1.0.0."`,
-    );
-  });
-
-  test('version tag already exist', () => {
-    expect(() =>
-      cliDocsVersionCommand(
-        '1.0.0',
-        versionedSiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: this version already exists! Use a version tag that does not already exist."`,
-    );
-  });
-
-  test('no docs file to version', () => {
-    const emptySiteDir = path.join(fixtureDir, 'empty-site');
-    expect(() =>
-      cliDocsVersionCommand(
-        '1.0.0',
-        emptySiteDir,
-        DEFAULT_PLUGIN_ID,
-        DEFAULT_OPTIONS,
-      ),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"[docs]: there is no docs to version!"`,
-    );
-  });
-
-  test('first time versioning', () => {
-    const copyMock = jest.spyOn(fs, 'copySync').mockImplementation();
-    const ensureMock = jest.spyOn(fs, 'ensureDirSync').mockImplementation();
-    const writeMock = jest.spyOn(fs, 'writeFileSync');
-    let versionedSidebar;
-    let versionedSidebarPath;
-    writeMock.mockImplementationOnce((filepath, content) => {
-      versionedSidebarPath = filepath;
-      versionedSidebar = JSON.parse(content as string);
-    });
-    let versionsPath;
-    let versions;
-    writeMock.mockImplementationOnce((filepath, content) => {
-      versionsPath = filepath;
-      versions = JSON.parse(content as string);
-    });
-    const consoleMock = jest.spyOn(console, 'log').mockImplementation();
-    const options = {
-      ...DEFAULT_OPTIONS,
-      sidebarPath: path.join(simpleSiteDir, 'sidebars.json'),
-    };
-    cliDocsVersionCommand('1.0.0', simpleSiteDir, DEFAULT_PLUGIN_ID, options);
-    expect(copyMock).toHaveBeenCalledWith(
-      path.join(simpleSiteDir, options.path),
-      path.join(
-        getVersionedDocsDirPath(simpleSiteDir, DEFAULT_PLUGIN_ID),
-        'version-1.0.0',
-      ),
-    );
-    expect(versionedSidebar).toMatchSnapshot();
-    expect(versionedSidebarPath).toEqual(
-      path.join(
-        getVersionedSidebarsDirPath(simpleSiteDir, DEFAULT_PLUGIN_ID),
-        'version-1.0.0-sidebars.json',
-      ),
-    );
-    expect(versionsPath).toEqual(
-      getVersionsFilePath(simpleSiteDir, DEFAULT_PLUGIN_ID),
-    );
-    expect(versions).toEqual(['1.0.0']);
-    expect(consoleMock).toHaveBeenCalledWith('[docs]: version 1.0.0 created!');
-
-    copyMock.mockRestore();
-    writeMock.mockRestore();
-    consoleMock.mockRestore();
-    ensureMock.mockRestore();
-  });
-
-  test('not the first time versioning', () => {
-    const copyMock = jest.spyOn(fs, 'copySync').mockImplementation();
-    const ensureMock = jest.spyOn(fs, 'ensureDirSync').mockImplementation();
-    const writeMock = jest.spyOn(fs, 'writeFileSync');
-    let versionedSidebar;
-    let versionedSidebarPath;
-    writeMock.mockImplementationOnce((filepath, content) => {
-      versionedSidebarPath = filepath;
-      versionedSidebar = JSON.parse(content as string);
-    });
-    let versionsPath;
-    let versions;
-    writeMock.mockImplementationOnce((filepath, content) => {
-      versionsPath = filepath;
-      versions = JSON.parse(content as string);
-    });
-    const consoleMock = jest.spyOn(console, 'log').mockImplementation();
-    const options = {
-      ...DEFAULT_OPTIONS,
-      sidebarPath: path.join(versionedSiteDir, 'sidebars.json'),
-    };
-    cliDocsVersionCommand(
-      '2.0.0',
-      versionedSiteDir,
-      DEFAULT_PLUGIN_ID,
-      options,
-    );
-    expect(copyMock).toHaveBeenCalledWith(
-      path.join(versionedSiteDir, options.path),
-      path.join(
-        getVersionedDocsDirPath(versionedSiteDir, DEFAULT_PLUGIN_ID),
-        'version-2.0.0',
-      ),
-    );
-    expect(versionedSidebar).toMatchSnapshot();
-    expect(versionedSidebarPath).toEqual(
-      path.join(
-        getVersionedSidebarsDirPath(versionedSiteDir, DEFAULT_PLUGIN_ID),
-        'version-2.0.0-sidebars.json',
-      ),
-    );
-    expect(versionsPath).toEqual(
-      getVersionsFilePath(versionedSiteDir, DEFAULT_PLUGIN_ID),
-    );
-    expect(versions).toEqual(['2.0.0', '1.0.1', '1.0.0', 'withSlugs']);
-    expect(consoleMock).toHaveBeenCalledWith('[docs]: version 2.0.0 created!');
-
-    copyMock.mockRestore();
-    writeMock.mockRestore();
-    consoleMock.mockRestore();
-    ensureMock.mockRestore();
-  });
-
-  test('second docs instance versioning', () => {
-    const pluginId = 'community';
-
-    const copyMock = jest.spyOn(fs, 'copySync').mockImplementation();
-    const ensureMock = jest.spyOn(fs, 'ensureDirSync').mockImplementation();
-    const writeMock = jest.spyOn(fs, 'writeFileSync');
-    let versionedSidebar;
-    let versionedSidebarPath;
-    writeMock.mockImplementationOnce((filepath, content) => {
-      versionedSidebarPath = filepath;
-      versionedSidebar = JSON.parse(content as string);
-    });
-    let versionsPath;
-    let versions;
-    writeMock.mockImplementationOnce((filepath, content) => {
-      versionsPath = filepath;
-      versions = JSON.parse(content as string);
-    });
-    const consoleMock = jest.spyOn(console, 'log').mockImplementation();
-    const options = {
-      ...DEFAULT_OPTIONS,
-      path: 'community',
-      sidebarPath: path.join(versionedSiteDir, 'community_sidebars.json'),
-    };
-    cliDocsVersionCommand('2.0.0', versionedSiteDir, pluginId, options);
-    expect(copyMock).toHaveBeenCalledWith(
-      path.join(versionedSiteDir, options.path),
-      path.join(
-        getVersionedDocsDirPath(versionedSiteDir, pluginId),
-        'version-2.0.0',
-      ),
-    );
-    expect(versionedSidebar).toMatchSnapshot();
-    expect(versionedSidebarPath).toEqual(
-      path.join(
-        getVersionedSidebarsDirPath(versionedSiteDir, pluginId),
-        'version-2.0.0-sidebars.json',
-      ),
-    );
-    expect(versionsPath).toEqual(
-      getVersionsFilePath(versionedSiteDir, pluginId),
-    );
-    expect(versions).toEqual(['2.0.0', '1.0.0']);
-    expect(consoleMock).toHaveBeenCalledWith(
-      '[community]: version 2.0.0 created!',
-    );
-
-    copyMock.mockRestore();
-    writeMock.mockRestore();
-    consoleMock.mockRestore();
-    ensureMock.mockRestore();
-  });
-});

package/src/__tests__/docFrontMatter.test.ts

@@ -1,244 +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 {validateDocFrontMatter} from '../docFrontMatter';
-import {DocFrontMatter} from '../types';
-import escapeStringRegexp from 'escape-string-regexp';
-
-function testField(params: {
-  fieldName: keyof DocFrontMatter;
-  validFrontMatters: DocFrontMatter[];
-  convertibleFrontMatter?: [
-    ConvertableFrontMatter: Record<string, unknown>,
-    ConvertedFrontMatter: DocFrontMatter,
-  ][];
-  invalidFrontMatters?: [
-    InvalidFrontMatter: Record<string, unknown>,
-    ErrorMessage: string,
-  ][];
-}) {
-  describe(`"${params.fieldName}" field`, () => {
-    test('accept valid values', () => {
-      params.validFrontMatters.forEach((frontMatter) => {
-        expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
-      });
-    });
-
-    test('convert valid values', () => {
-      params.convertibleFrontMatter?.forEach(
-        ([convertibleFrontMatter, convertedFrontMatter]) => {
-          expect(validateDocFrontMatter(convertibleFrontMatter)).toEqual(
-            convertedFrontMatter,
-          );
-        },
-      );
-    });
-
-    test('throw error for values', () => {
-      params.invalidFrontMatters?.forEach(([frontMatter, message]) => {
-        try {
-          validateDocFrontMatter(frontMatter);
-          fail(
-            new Error(
-              `Doc 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('validateDocFrontMatter', () => {
-  test('accept empty object', () => {
-    const frontMatter: DocFrontMatter = {};
-    expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
-  });
-
-  test('accept unknown field', () => {
-    const frontMatter = {abc: '1'};
-    expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
-  });
-});
-
-describe('validateDocFrontMatter id', () => {
-  testField({
-    fieldName: 'id',
-    validFrontMatters: [{id: '123'}, {id: 'unique_id'}],
-    invalidFrontMatters: [[{id: ''}, 'is not allowed to be empty']],
-  });
-});
-
-describe('validateDocFrontMatter title', () => {
-  testField({
-    fieldName: 'title',
-    validFrontMatters: [
-      // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
-      {title: ''},
-      {title: 'title'},
-    ],
-  });
-});
-
-describe('validateDocFrontMatter hide_title', () => {
-  testField({
-    fieldName: 'hide_title',
-    validFrontMatters: [{hide_title: true}, {hide_title: false}],
-    convertibleFrontMatter: [
-      [{hide_title: 'true'}, {hide_title: true}],
-      [{hide_title: 'false'}, {hide_title: false}],
-    ],
-    invalidFrontMatters: [
-      [{hide_title: 'yes'}, 'must be a boolean'],
-      [{hide_title: 'no'}, 'must be a boolean'],
-      [{hide_title: ''}, 'must be a boolean'],
-    ],
-  });
-});
-
-describe('validateDocFrontMatter 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'],
-      [{hide_table_of_contents: ''}, 'must be a boolean'],
-    ],
-  });
-});
-
-describe('validateDocFrontMatter 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('validateDocFrontMatter image', () => {
-  testField({
-    fieldName: 'image',
-    validFrontMatters: [
-      {image: 'https://docusaurus.io/blog/image.png'},
-      {image: '/absolute/image.png'},
-      {image: '../relative/image.png'},
-    ],
-    invalidFrontMatters: [
-      [{image: ''}, 'does not match any of the allowed types'],
-    ],
-  });
-});
-
-describe('validateDocFrontMatter description', () => {
-  testField({
-    fieldName: 'description',
-    validFrontMatters: [
-      // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
-      {description: ''},
-      {description: 'description'},
-    ],
-  });
-});
-
-describe('validateDocFrontMatter slug', () => {
-  testField({
-    fieldName: 'slug',
-    validFrontMatters: [
-      {slug: '/'},
-      {slug: 'slug'},
-      {slug: '/slug/'},
-      {slug: './slug'},
-      {slug: '../../slug'},
-      {slug: '/api/plugins/@docusaurus'},
-      {slug: '@site/api/asset'},
-      {slug: 'slug1 slug2'},
-    ],
-    invalidFrontMatters: [[{slug: ''}, 'is not allowed to be empty']],
-  });
-});
-
-describe('validateDocFrontMatter sidebar_label', () => {
-  testField({
-    fieldName: 'sidebar_label',
-    validFrontMatters: [{sidebar_label: 'Awesome docs'}],
-    invalidFrontMatters: [[{sidebar_label: ''}, 'is not allowed to be empty']],
-  });
-});
-
-describe('validateDocFrontMatter sidebar_position', () => {
-  testField({
-    fieldName: 'sidebar_position',
-    validFrontMatters: [
-      {sidebar_position: -5},
-      {sidebar_position: -3.5},
-      {sidebar_position: 0},
-      {sidebar_position: 5},
-      {sidebar_position: 3.5},
-    ],
-    convertibleFrontMatter: [
-      [{sidebar_position: '-1.5'}, {sidebar_position: -1.5}],
-      [{sidebar_position: '1'}, {sidebar_position: 1}],
-      [{sidebar_position: '1.5'}, {sidebar_position: 1.5}],
-    ],
-  });
-});
-
-describe('validateDocFrontMatter custom_edit_url', () => {
-  testField({
-    fieldName: 'custom_edit_url',
-    validFrontMatters: [
-      // See https://github.com/demisto/content-docs/pull/616#issuecomment-827087566
-      {custom_edit_url: ''},
-      {custom_edit_url: null},
-      {custom_edit_url: 'https://github.com/facebook/docusaurus/markdown.md'},
-      {custom_edit_url: '../../api/docs/markdown.md'},
-      {custom_edit_url: '@site/api/docs/markdown.md'},
-    ],
-  });
-});
-
-describe('validateDocFrontMatter parse_number_prefixes', () => {
-  testField({
-    fieldName: 'parse_number_prefixes',
-    validFrontMatters: [
-      {parse_number_prefixes: true},
-      {parse_number_prefixes: false},
-    ],
-    convertibleFrontMatter: [
-      [{parse_number_prefixes: 'true'}, {parse_number_prefixes: true}],
-      [{parse_number_prefixes: 'false'}, {parse_number_prefixes: false}],
-    ],
-    invalidFrontMatters: [
-      [{parse_number_prefixes: 'yes'}, 'must be a boolean'],
-      [{parse_number_prefixes: 'no'}, 'must be a boolean'],
-      [{parse_number_prefixes: ''}, 'must be a boolean'],
-    ],
-  });
-});