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

package/src/__tests__/lastUpdate.test.ts

@@ -1,69 +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';
-import path from 'path';
-import shell from 'shelljs';
-
-import {getFileLastUpdate} from '../lastUpdate';
-
-describe('lastUpdate', () => {
-  const existingFilePath = path.join(
-    __dirname,
-    '__fixtures__/simple-site/docs/hello.md',
-  );
-  test('existing test file in repository with Git timestamp', async () => {
-    const lastUpdateData = await getFileLastUpdate(existingFilePath);
-    expect(lastUpdateData).not.toBeNull();
-
-    const {author, timestamp} = lastUpdateData;
-    expect(author).not.toBeNull();
-    expect(typeof author).toBe('string');
-
-    expect(timestamp).not.toBeNull();
-    expect(typeof timestamp).toBe('number');
-  });
-
-  test('non-existing file', async () => {
-    const consoleMock = jest.spyOn(console, 'error');
-    consoleMock.mockImplementation();
-    const nonExistingFileName = '.nonExisting';
-    const nonExistingFilePath = path.join(
-      __dirname,
-      '__fixtures__',
-      nonExistingFileName,
-    );
-    expect(await getFileLastUpdate(nonExistingFilePath)).toBeNull();
-    expect(consoleMock).toHaveBeenCalledTimes(1);
-    expect(consoleMock.mock.calls[0][0].message).toContain(
-      `Command failed with exit code 128: git log -1 --format=%ct, %an ${nonExistingFileName}`,
-    );
-    expect(await getFileLastUpdate(null)).toBeNull();
-    expect(await getFileLastUpdate(undefined)).toBeNull();
-    consoleMock.mockRestore();
-  });
-
-  test('temporary created file that has no git timestamp', async () => {
-    const tempFilePath = path.join(__dirname, '__fixtures__', '.temp');
-    fs.writeFileSync(tempFilePath, 'Lorem ipsum :)');
-    expect(await getFileLastUpdate(tempFilePath)).toBeNull();
-    fs.unlinkSync(tempFilePath);
-  });
-
-  test('Git does not exist', async () => {
-    const mock = jest.spyOn(shell, 'which').mockImplementationOnce(() => null);
-    const consoleMock = jest.spyOn(console, 'warn').mockImplementation();
-    const lastUpdateData = await getFileLastUpdate(existingFilePath);
-    expect(lastUpdateData).toBeNull();
-    expect(consoleMock).toHaveBeenLastCalledWith(
-      'Sorry, the docs plugin last update options require Git.',
-    );
-
-    consoleMock.mockRestore();
-    mock.mockRestore();
-  });
-});

package/src/__tests__/numberPrefix.test.ts

@@ -1,199 +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 {
-  DefaultNumberPrefixParser,
-  DisabledNumberPrefixParser,
-  stripNumberPrefix,
-  stripPathNumberPrefixes,
-} from '../numberPrefix';
-
-const IgnoredNumberPrefixPatterns = [
-  // Patterns without number prefix
-  'MyDoc',
-  'a1-My Doc',
-  'My Doc-000',
-  'My Doc - 1',
-  'My Doc - 02',
-  'Hey - 03 - My Doc',
-  '00abc01-My Doc',
-  'My 001- Doc',
-  'My -001 Doc',
-  // ignore common date-like patterns: https://github.com/facebook/docusaurus/issues/4640
-  '2021-01-31 - Doc',
-  '31-01-2021 - Doc',
-  '2021_01_31 - Doc',
-  '31_01_2021 - Doc',
-  '2021.01.31 - Doc',
-  '31.01.2021 - Doc',
-  '2021-01 - Doc',
-  '2021_01 - Doc',
-  '2021.01 - Doc',
-  '01-2021 - Doc',
-  '01_2021 - Doc',
-  '01.2021 - Doc',
-  // date patterns without suffix
-  '2021-01-31',
-  '2021-01',
-  '21-01-31',
-  '21-01',
-  '2021_01_31',
-  '2021_01',
-  '21_01_31',
-  '21_01',
-  '01_31',
-  '01',
-  '2021',
-  '01',
-  // ignore common versioning patterns: https://github.com/facebook/docusaurus/issues/4653
-  '8.0',
-  '8.0.0',
-  '14.2.16',
-  '18.2',
-  '8.0 - Doc',
-  '8.0.0 - Doc',
-  '8_0',
-  '8_0_0',
-  '14_2_16',
-  '18_2',
-  '8.0 - Doc',
-  '8.0.0 - Doc',
-];
-
-describe('stripNumberPrefix', () => {
-  function stripNumberPrefixDefault(str: string) {
-    return stripNumberPrefix(str, DefaultNumberPrefixParser);
-  }
-
-  test('should strip number prefix if present', () => {
-    expect(stripNumberPrefixDefault('1-My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('01-My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001-My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001 - My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001      -    My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('999      -        My Doc')).toEqual(
-      'My Doc',
-    );
-    //
-    expect(stripNumberPrefixDefault('1---My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('01---My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001---My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001 --- My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001      ---    My Doc')).toEqual(
-      'My Doc',
-    );
-    expect(stripNumberPrefixDefault('999      ---        My Doc')).toEqual(
-      'My Doc',
-    );
-    //
-    expect(stripNumberPrefixDefault('1___My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('01___My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001___My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001 ___ My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001      ___    My Doc')).toEqual(
-      'My Doc',
-    );
-    expect(stripNumberPrefixDefault('999      ___        My Doc')).toEqual(
-      'My Doc',
-    );
-    //
-    expect(stripNumberPrefixDefault('1.My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('01.My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001.My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001 . My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('001      .    My Doc')).toEqual('My Doc');
-    expect(stripNumberPrefixDefault('999      .       My Doc')).toEqual(
-      'My Doc',
-    );
-  });
-
-  test('should not strip number prefix if pattern does not match', () => {
-    IgnoredNumberPrefixPatterns.forEach((badPattern) => {
-      expect(stripNumberPrefixDefault(badPattern)).toEqual(badPattern);
-    });
-  });
-});
-
-describe('stripPathNumberPrefix', () => {
-  test('should strip number prefixes in paths', () => {
-    expect(
-      stripPathNumberPrefixes(
-        '0-MyRootFolder0/1 - MySubFolder1/2.  MyDeepFolder2/3 _MyDoc3',
-        DefaultNumberPrefixParser,
-      ),
-    ).toEqual('MyRootFolder0/MySubFolder1/MyDeepFolder2/MyDoc3');
-  });
-
-  test('should strip number prefixes in paths with custom parser', () => {
-    function stripPathNumberPrefixCustom(str: string) {
-      return {
-        filename: str.substring(1, str.length),
-        numberPrefix: 0,
-      };
-    }
-
-    expect(
-      stripPathNumberPrefixes('aaaa/bbbb/cccc', stripPathNumberPrefixCustom),
-    ).toEqual('aaa/bbb/ccc');
-  });
-
-  test('should strip number prefixes in paths with disabled parser', () => {
-    expect(
-      stripPathNumberPrefixes(
-        '0-MyRootFolder0/1 - MySubFolder1/2.  MyDeepFolder2/3 _MyDoc3',
-        DisabledNumberPrefixParser,
-      ),
-    ).toEqual('0-MyRootFolder0/1 - MySubFolder1/2.  MyDeepFolder2/3 _MyDoc3');
-  });
-});
-
-describe('DefaultNumberPrefixParser', () => {
-  test('should extract number prefix if present', () => {
-    expect(DefaultNumberPrefixParser('0-My Doc')).toEqual({
-      filename: 'My Doc',
-      numberPrefix: 0,
-    });
-    expect(DefaultNumberPrefixParser('1-My Doc')).toEqual({
-      filename: 'My Doc',
-      numberPrefix: 1,
-    });
-    expect(DefaultNumberPrefixParser('01-My Doc')).toEqual({
-      filename: 'My Doc',
-      numberPrefix: 1,
-    });
-    expect(DefaultNumberPrefixParser('001-My Doc')).toEqual({
-      filename: 'My Doc',
-      numberPrefix: 1,
-    });
-    expect(DefaultNumberPrefixParser('001 - My Doc')).toEqual({
-      filename: 'My Doc',
-      numberPrefix: 1,
-    });
-    expect(DefaultNumberPrefixParser('001      -    My Doc')).toEqual({
-      filename: 'My Doc',
-      numberPrefix: 1,
-    });
-    expect(DefaultNumberPrefixParser('999      -        My Doc')).toEqual({
-      filename: 'My Doc',
-      numberPrefix: 999,
-    });
-
-    expect(DefaultNumberPrefixParser('0046036 - My Doc')).toEqual({
-      filename: 'My Doc',
-      numberPrefix: 46036,
-    });
-  });
-
-  test('should not extract number prefix if pattern does not match', () => {
-    IgnoredNumberPrefixPatterns.forEach((badPattern) => {
-      expect(DefaultNumberPrefixParser(badPattern)).toEqual({
-        filename: badPattern,
-        numberPrefix: undefined,
-      });
-    });
-  });
-});

package/src/__tests__/options.test.ts

@@ -1,272 +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 {OptionsSchema, DEFAULT_OPTIONS, validateOptions} from '../options';
-import {normalizePluginOptions} from '@docusaurus/utils-validation';
-import {DefaultSidebarItemsGenerator} from '../sidebarItemsGenerator';
-import {
-  DefaultNumberPrefixParser,
-  DisabledNumberPrefixParser,
-} from '../numberPrefix';
-import {GlobExcludeDefault} from '@docusaurus/utils';
-import {PluginOptions} from '../types';
-
-// the type of remark/rehype plugins is function
-const markdownPluginsFunctionStub = () => {};
-const markdownPluginsObjectStub = {};
-
-function testValidateOptions(options: Partial<PluginOptions>) {
-  return validateOptions({
-    options: {
-      ...DEFAULT_OPTIONS,
-      ...options,
-    },
-    validate: normalizePluginOptions,
-  });
-}
-
-describe('normalizeDocsPluginOptions', () => {
-  test('should return default options for undefined user options', async () => {
-    const {value, error} = await OptionsSchema.validate({});
-    expect(value).toEqual(DEFAULT_OPTIONS);
-    expect(error).toBe(undefined);
-  });
-
-  test('should accept correctly defined user options', async () => {
-    const userOptions = {
-      path: 'my-docs', // Path to data on filesystem, relative to site dir.
-      routeBasePath: 'my-docs', // URL Route.
-      homePageId: 'home', // Document id for docs home page.
-      include: ['**/*.{md,mdx}'], // Extensions to include.
-      exclude: GlobExcludeDefault,
-      sidebarPath: 'my-sidebar', // Path to sidebar configuration for showing a list of markdown pages.
-      sidebarItemsGenerator: DefaultSidebarItemsGenerator,
-      numberPrefixParser: DefaultNumberPrefixParser,
-      docLayoutComponent: '@theme/DocPage',
-      docItemComponent: '@theme/DocItem',
-      remarkPlugins: [markdownPluginsObjectStub],
-      rehypePlugins: [markdownPluginsFunctionStub],
-      beforeDefaultRehypePlugins: [],
-      beforeDefaultRemarkPlugins: [],
-      showLastUpdateTime: true,
-      showLastUpdateAuthor: true,
-      admonitions: {},
-      includeCurrentVersion: false,
-      disableVersioning: true,
-      editCurrentVersion: true,
-      editLocalizedFiles: true,
-      versions: {
-        current: {
-          path: 'next',
-          label: 'next',
-        },
-        version1: {
-          path: 'hello',
-          label: 'world',
-        },
-      },
-      sidebarCollapsible: false,
-      sidebarCollapsed: false,
-    };
-    const {value, error} = await OptionsSchema.validate(userOptions);
-    expect(value).toEqual(userOptions);
-    expect(error).toBe(undefined);
-  });
-
-  test('should accept correctly defined remark and rehype plugin options', async () => {
-    const userOptions = {
-      ...DEFAULT_OPTIONS,
-      beforeDefaultRemarkPlugins: [],
-      beforeDefaultRehypePlugins: [markdownPluginsFunctionStub],
-      remarkPlugins: [[markdownPluginsFunctionStub, {option1: '42'}]],
-      rehypePlugins: [
-        markdownPluginsObjectStub,
-        [markdownPluginsFunctionStub, {option1: '42'}],
-      ],
-    };
-    const {value, error} = await OptionsSchema.validate(userOptions);
-    expect(value).toEqual(userOptions);
-    expect(error).toBe(undefined);
-  });
-
-  test('should accept admonitions false', async () => {
-    const admonitionsFalse = {
-      ...DEFAULT_OPTIONS,
-      admonitions: false,
-    };
-    const {value, error} = OptionsSchema.validate(admonitionsFalse);
-    expect(value).toEqual(admonitionsFalse);
-    expect(error).toBe(undefined);
-  });
-
-  test('should accept numberPrefixParser function', () => {
-    function customNumberPrefixParser() {}
-    expect(
-      normalizePluginOptions(OptionsSchema, {
-        ...DEFAULT_OPTIONS,
-        numberPrefixParser: customNumberPrefixParser,
-      }),
-    ).toEqual({
-      ...DEFAULT_OPTIONS,
-      id: 'default',
-      numberPrefixParser: customNumberPrefixParser,
-    });
-  });
-
-  test('should accept numberPrefixParser false', () => {
-    expect(
-      normalizePluginOptions(OptionsSchema, {
-        ...DEFAULT_OPTIONS,
-        numberPrefixParser: false,
-      }),
-    ).toEqual({
-      ...DEFAULT_OPTIONS,
-      id: 'default',
-      numberPrefixParser: DisabledNumberPrefixParser,
-    });
-  });
-
-  test('should accept numberPrefixParser true', () => {
-    expect(
-      normalizePluginOptions(OptionsSchema, {
-        ...DEFAULT_OPTIONS,
-        numberPrefixParser: true,
-      }),
-    ).toEqual({
-      ...DEFAULT_OPTIONS,
-      id: 'default',
-      numberPrefixParser: DefaultNumberPrefixParser,
-    });
-  });
-
-  test('should reject admonitions true', async () => {
-    const admonitionsTrue = {
-      ...DEFAULT_OPTIONS,
-      admonitions: true,
-    };
-    const {error} = OptionsSchema.validate(admonitionsTrue);
-    expect(error).toMatchInlineSnapshot(
-      `[ValidationError: "admonitions" contains an invalid value]`,
-    );
-  });
-
-  test('should reject invalid remark plugin options', () => {
-    expect(() => {
-      normalizePluginOptions(OptionsSchema, {
-        remarkPlugins: [[{option1: '42'}, markdownPluginsFunctionStub]],
-      });
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"\\"remarkPlugins[0]\\" does not match any of the allowed types"`,
-    );
-  });
-
-  test('should reject invalid rehype plugin options', () => {
-    expect(() => {
-      normalizePluginOptions(OptionsSchema, {
-        rehypePlugins: [
-          [
-            markdownPluginsFunctionStub,
-            {option1: '42'},
-            markdownPluginsFunctionStub,
-          ],
-        ],
-      });
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"\\"rehypePlugins[0]\\" does not match any of the allowed types"`,
-    );
-  });
-
-  test('should reject bad path inputs', () => {
-    expect(() => {
-      normalizePluginOptions(OptionsSchema, {
-        path: 2,
-      });
-    }).toThrowErrorMatchingInlineSnapshot(`"\\"path\\" must be a string"`);
-  });
-
-  test('should reject bad include inputs', () => {
-    expect(() => {
-      normalizePluginOptions(OptionsSchema, {
-        include: '**/*.{md,mdx}',
-      });
-    }).toThrowErrorMatchingInlineSnapshot(`"\\"include\\" must be an array"`);
-  });
-
-  test('should reject bad showLastUpdateTime inputs', () => {
-    expect(() => {
-      normalizePluginOptions(OptionsSchema, {
-        showLastUpdateTime: 'true',
-      });
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"\\"showLastUpdateTime\\" must be a boolean"`,
-    );
-  });
-
-  test('should reject bad remarkPlugins input', () => {
-    expect(() => {
-      normalizePluginOptions(OptionsSchema, {
-        remarkPlugins: 'remark-math',
-      });
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"\\"remarkPlugins\\" must be an array"`,
-    );
-  });
-
-  test('should reject bad lastVersion', () => {
-    expect(() => {
-      normalizePluginOptions(OptionsSchema, {
-        lastVersion: false,
-      });
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"\\"lastVersion\\" must be a string"`,
-    );
-  });
-
-  test('should reject bad versions', () => {
-    expect(() => {
-      normalizePluginOptions(OptionsSchema, {
-        versions: {
-          current: {
-            hey: 3,
-          },
-          version1: {
-            path: 'hello',
-            label: 'world',
-          },
-        },
-      });
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"\\"versions.current.hey\\" is not allowed"`,
-    );
-  });
-
-  test('should handle sidebarCollapsed option inconsistencies', () => {
-    expect(
-      testValidateOptions({
-        ...DEFAULT_OPTIONS,
-        sidebarCollapsible: true,
-        sidebarCollapsed: undefined,
-      }).sidebarCollapsed,
-    ).toEqual(true);
-
-    expect(
-      testValidateOptions({
-        ...DEFAULT_OPTIONS,
-        sidebarCollapsible: false,
-        sidebarCollapsed: undefined,
-      }).sidebarCollapsed,
-    ).toEqual(false);
-
-    expect(
-      testValidateOptions({
-        ...DEFAULT_OPTIONS,
-        sidebarCollapsible: false,
-        sidebarCollapsed: true,
-      }).sidebarCollapsed,
-    ).toEqual(false);
-  });
-});