@docusaurus/plugin-client-redirects 2.0.0-beta.2 → 2.0.0-beta.20

package/src/__tests__/extensionRedirects.test.ts

@@ -1,140 +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 {
-  createFromExtensionsRedirects,
-  createToExtensionsRedirects,
-} from '../extensionRedirects';
-
-describe('createToExtensionsRedirects', () => {
-  test('should reject empty extensions', () => {
-    expect(() => {
-      createToExtensionsRedirects(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\".html\\" contains a \\".\\" (dot) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with .', () => {
-    expect(() => {
-      createToExtensionsRedirects(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\".html\\" contains a \\".\\" (dot) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with /', () => {
-    expect(() => {
-      createToExtensionsRedirects(['/'], ['ht/ml']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\"ht/ml\\" contains a \\"/\\" (slash) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with illegal url char', () => {
-    expect(() => {
-      createToExtensionsRedirects(['/'], [',']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\",\\" contains invalid URI characters.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should create redirects from html/htm extensions', () => {
-    const ext = ['html', 'htm'];
-    expect(createToExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/abc.html'], ext)).toEqual([
-      {from: '/abc', to: '/abc.html'},
-    ]);
-    expect(createToExtensionsRedirects(['/abc.htm'], ext)).toEqual([
-      {from: '/abc', to: '/abc.htm'},
-    ]);
-    expect(createToExtensionsRedirects(['/abc.xyz'], ext)).toEqual([]);
-  });
-
-  test('should create "to" redirects when relativeRoutesPath contains a prefix', () => {
-    expect(
-      createToExtensionsRedirects(['/prefix/file.html'], ['html']),
-    ).toEqual([{from: '/prefix/file', to: '/prefix/file.html'}]);
-  });
-
-  test('should not create redirection for an empty extension array', () => {
-    const ext: string[] = [];
-    expect(createToExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/abc.html'], ext)).toEqual([]);
-  });
-});
-
-describe('createFromExtensionsRedirects', () => {
-  test('should reject empty extensions', () => {
-    expect(() => {
-      createFromExtensionsRedirects(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\".html\\" contains a \\".\\" (dot) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with .', () => {
-    expect(() => {
-      createFromExtensionsRedirects(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\".html\\" contains a \\".\\" (dot) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with /', () => {
-    expect(() => {
-      createFromExtensionsRedirects(['/'], ['ht/ml']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\"ht/ml\\" contains a \\"/\\" (slash) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with illegal url char', () => {
-    expect(() => {
-      createFromExtensionsRedirects(['/'], [',']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\",\\" contains invalid URI characters.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should create redirects to html/htm extensions', () => {
-    const ext = ['html', 'htm'];
-    expect(createFromExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/abc'], ext)).toEqual([
-      {from: '/abc.html', to: '/abc'},
-      {from: '/abc.htm', to: '/abc'},
-    ]);
-    expect(createFromExtensionsRedirects(['/def.html'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/def/'], ext)).toEqual([]);
-  });
-
-  test('should create "from" redirects when relativeRoutesPath contains a prefix', () => {
-    expect(createFromExtensionsRedirects(['/prefix/file'], ['html'])).toEqual([
-      {from: '/prefix/file.html', to: '/prefix/file'},
-    ]);
-  });
-
-  test('should not create redirection for an empty extension array', () => {
-    const ext: string[] = [];
-    expect(createFromExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/abc'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/def.html'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/def/'], ext)).toEqual([]);
-  });
-});

package/src/__tests__/normalizePluginOptions.test.ts

@@ -1,76 +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 normalizePluginOptions, {
-  DefaultPluginOptions,
-} from '../normalizePluginOptions';
-import {CreateRedirectsFnOption} from '../types';
-
-describe('normalizePluginOptions', () => {
-  test('should return default options for undefined user options', () => {
-    expect(normalizePluginOptions()).toEqual(DefaultPluginOptions);
-  });
-
-  test('should return default options for empty user options', () => {
-    expect(normalizePluginOptions()).toEqual(DefaultPluginOptions);
-  });
-
-  test('should override one default options with valid user options', () => {
-    expect(
-      normalizePluginOptions({
-        toExtensions: ['html'],
-      }),
-    ).toEqual({...DefaultPluginOptions, toExtensions: ['html']});
-  });
-
-  test('should override all default options with valid user options', () => {
-    const createRedirects: CreateRedirectsFnOption = (_routePath: string) => {
-      return [];
-    };
-    expect(
-      normalizePluginOptions({
-        fromExtensions: ['exe', 'zip'],
-        toExtensions: ['html'],
-        createRedirects,
-        redirects: [{from: '/x', to: '/y'}],
-      }),
-    ).toEqual({
-      id: 'default',
-      fromExtensions: ['exe', 'zip'],
-      toExtensions: ['html'],
-      createRedirects,
-      redirects: [{from: '/x', to: '/y'}],
-    });
-  });
-
-  test('should reject bad fromExtensions user inputs', () => {
-    expect(() =>
-      normalizePluginOptions({
-        fromExtensions: ([null, undefined, 123, true] as unknown) as string[],
-      }),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should reject bad toExtensions user inputs', () => {
-    expect(() =>
-      normalizePluginOptions({
-        toExtensions: ([null, undefined, 123, true] as unknown) as string[],
-      }),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should reject bad createRedirects user inputs', () => {
-    expect(() =>
-      normalizePluginOptions({
-        createRedirects: ([
-          'bad',
-          'value',
-        ] as unknown) as CreateRedirectsFnOption,
-      }),
-    ).toThrowErrorMatchingSnapshot();
-  });
-});

package/src/__tests__/redirectValidation.test.ts

@@ -1,66 +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 {validateRedirect} from '../redirectValidation';
-
-describe('validateRedirect', () => {
-  test('validate good redirects without throwing', () => {
-    validateRedirect({
-      from: '/fromSomePath',
-      to: '/toSomePath',
-    });
-    validateRedirect({
-      from: '/from/Some/Path',
-      to: '/toSomePath',
-    });
-    validateRedirect({
-      from: '/fromSomePath',
-      to: '/toSomePath',
-    });
-    validateRedirect({
-      from: '/fromSomePath',
-      to: '/to/Some/Path',
-    });
-  });
-
-  test('throw for bad redirects', () => {
-    expect(() =>
-      validateRedirect({
-        from: 'https://fb.com/fromSomePath',
-        to: '/toSomePath',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-
-    expect(() =>
-      validateRedirect({
-        from: '/fromSomePath',
-        to: 'https://fb.com/toSomePath',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-
-    expect(() =>
-      validateRedirect({
-        from: '/fromSomePath',
-        to: '/toSomePath?queryString=xyz',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-
-    expect(() =>
-      validateRedirect({
-        from: (null as unknown) as string,
-        to: '/toSomePath?queryString=xyz',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-
-    expect(() =>
-      validateRedirect({
-        from: (['heyho'] as unknown) as string,
-        to: '/toSomePath?queryString=xyz',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-  });
-});

package/src/__tests__/writeRedirectFiles.test.ts

@@ -1,203 +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 writeRedirectFiles, {
-  toRedirectFilesMetadata,
-  createToUrl,
-} from '../writeRedirectFiles';
-
-// Test to fix toUrl bugs we had:
-// - https://github.com/facebook/docusaurus/issues/3886
-// - https://github.com/facebook/docusaurus/issues/3925
-describe('createToUrl', () => {
-  test('should create appropriate redirect urls', async () => {
-    expect(createToUrl('/', '/docs/something/else')).toEqual(
-      '/docs/something/else',
-    );
-    expect(createToUrl('/', '/docs/something/else/')).toEqual(
-      '/docs/something/else/',
-    );
-    expect(createToUrl('/', 'docs/something/else')).toEqual(
-      '/docs/something/else',
-    );
-  });
-
-  test('should create appropriate redirect urls with baseUrl', async () => {
-    expect(createToUrl('/baseUrl/', '/docs/something/else')).toEqual(
-      '/baseUrl/docs/something/else',
-    );
-    expect(createToUrl('/baseUrl/', '/docs/something/else/')).toEqual(
-      '/baseUrl/docs/something/else/',
-    );
-    expect(createToUrl('/baseUrl/', 'docs/something/else')).toEqual(
-      '/baseUrl/docs/something/else',
-    );
-  });
-});
-
-describe('toRedirectFilesMetadata', () => {
-  test('should create appropriate metadatas trailingSlash=undefined', async () => {
-    const pluginContext = {
-      outDir: '/tmp/someFixedOutDir',
-      baseUrl: 'https://docusaurus.io',
-    };
-
-    const redirectFiles = toRedirectFilesMetadata(
-      [
-        {from: '/abc.html', to: '/abc'},
-        {from: '/def', to: '/def.html'},
-        {from: '/xyz', to: '/'},
-      ],
-      pluginContext,
-      undefined,
-    );
-
-    expect(redirectFiles.map((f) => f.fileAbsolutePath)).toEqual([
-      path.join(pluginContext.outDir, '/abc.html'),
-      path.join(pluginContext.outDir, '/def/index.html'),
-      path.join(pluginContext.outDir, '/xyz/index.html'),
-    ]);
-
-    expect(redirectFiles.map((f) => f.fileContent)).toMatchSnapshot(
-      'fileContent',
-    );
-  });
-
-  test('should create appropriate metadatas trailingSlash=true', async () => {
-    const pluginContext = {
-      outDir: '/tmp/someFixedOutDir',
-      baseUrl: 'https://docusaurus.io',
-    };
-
-    const redirectFiles = toRedirectFilesMetadata(
-      [
-        {from: '/abc.html', to: '/abc'},
-        {from: '/def', to: '/def.html'},
-        {from: '/xyz', to: '/'},
-      ],
-      pluginContext,
-      true,
-    );
-
-    expect(redirectFiles.map((f) => f.fileAbsolutePath)).toEqual([
-      path.join(pluginContext.outDir, '/abc.html'),
-      path.join(pluginContext.outDir, '/def/index.html'),
-      path.join(pluginContext.outDir, '/xyz/index.html'),
-    ]);
-
-    expect(redirectFiles.map((f) => f.fileContent)).toMatchSnapshot(
-      'fileContent',
-    );
-  });
-
-  test('should create appropriate metadatas trailingSlash=false', async () => {
-    const pluginContext = {
-      outDir: '/tmp/someFixedOutDir',
-      baseUrl: 'https://docusaurus.io',
-    };
-
-    const redirectFiles = toRedirectFilesMetadata(
-      [
-        {from: '/abc.html', to: '/abc'},
-        {from: '/def', to: '/def.html'},
-        {from: '/xyz', to: '/'},
-      ],
-      pluginContext,
-      false,
-    );
-
-    expect(redirectFiles.map((f) => f.fileAbsolutePath)).toEqual([
-      path.join(pluginContext.outDir, '/abc.html'),
-      path.join(pluginContext.outDir, '/def.html'),
-      path.join(pluginContext.outDir, '/xyz.html'),
-    ]);
-
-    expect(redirectFiles.map((f) => f.fileContent)).toMatchSnapshot(
-      'fileContent',
-    );
-  });
-
-  test('should create appropriate metadatas for root baseUrl', async () => {
-    const pluginContext = {
-      outDir: '/tmp/someFixedOutDir',
-      baseUrl: '/',
-    };
-    const redirectFiles = toRedirectFilesMetadata(
-      [{from: '/abc.html', to: '/abc'}],
-      pluginContext,
-      undefined,
-    );
-    expect(redirectFiles.map((f) => f.fileContent)).toMatchSnapshot(
-      'fileContent baseUrl=/',
-    );
-  });
-
-  test('should create appropriate metadatas for empty baseUrl', async () => {
-    const pluginContext = {
-      outDir: '/tmp/someFixedOutDir',
-      baseUrl: '',
-    };
-    const redirectFiles = toRedirectFilesMetadata(
-      [{from: '/abc.html', to: '/abc'}],
-      pluginContext,
-      undefined,
-    );
-    expect(redirectFiles.map((f) => f.fileContent)).toMatchSnapshot(
-      'fileContent baseUrl=empty',
-    );
-  });
-});
-
-describe('writeRedirectFiles', () => {
-  test('write the files', async () => {
-    const outDir = `/tmp/docusaurus_tests_${Math.random()}`;
-
-    const filesMetadata = [
-      {
-        fileAbsolutePath: path.join(outDir, 'someFileName'),
-        fileContent: 'content 1',
-      },
-      {
-        fileAbsolutePath: path.join(outDir, '/some/nested/filename'),
-        fileContent: 'content 2',
-      },
-    ];
-
-    await writeRedirectFiles(filesMetadata);
-
-    await expect(
-      fs.readFile(filesMetadata[0].fileAbsolutePath, 'utf8'),
-    ).resolves.toEqual('content 1');
-
-    await expect(
-      fs.readFile(filesMetadata[1].fileAbsolutePath, 'utf8'),
-    ).resolves.toEqual('content 2');
-  });
-
-  test('avoid overwriting existing files', async () => {
-    const outDir = `/tmp/docusaurus_tests_${Math.random()}`;
-
-    const filesMetadata = [
-      {
-        fileAbsolutePath: path.join(outDir, 'someFileName/index.html'),
-        fileContent: 'content 1',
-      },
-    ];
-
-    await fs.ensureDir(path.dirname(filesMetadata[0].fileAbsolutePath));
-    await fs.writeFile(
-      filesMetadata[0].fileAbsolutePath,
-      'file already exists!',
-    );
-
-    await expect(writeRedirectFiles(filesMetadata)).rejects.toThrowError(
-      `Redirect file creation error for "${filesMetadata[0].fileAbsolutePath}" path: Error: The redirect plugin is not supposed to override existing files.`,
-    );
-  });
-});

package/src/normalizePluginOptions.ts

@@ -1,55 +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 {PluginOptions, RedirectOption, UserPluginOptions} from './types';
-import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
-import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
-
-export const DefaultPluginOptions: PluginOptions = {
-  id: DEFAULT_PLUGIN_ID, // TODO temporary
-  fromExtensions: [],
-  toExtensions: [],
-  redirects: [],
-};
-
-const RedirectPluginOptionValidation = Joi.object<RedirectOption>({
-  to: PathnameSchema.required(),
-  from: Joi.alternatives().try(
-    PathnameSchema.required(),
-    Joi.array().items(PathnameSchema.required()),
-  ),
-});
-
-const isString = Joi.string().required().not(null);
-
-const UserOptionsSchema = Joi.object<UserPluginOptions>({
-  id: Joi.string().optional(), // TODO remove once validation  migrated to new system
-  fromExtensions: Joi.array().items(isString),
-  toExtensions: Joi.array().items(isString),
-  redirects: Joi.array().items(RedirectPluginOptionValidation),
-  createRedirects: Joi.function().arity(1),
-});
-
-function validateUserOptions(userOptions: UserPluginOptions) {
-  const {error} = UserOptionsSchema.validate(userOptions, {
-    abortEarly: true,
-    allowUnknown: false,
-  });
-  if (error) {
-    throw new Error(
-      `Invalid @docusaurus/plugin-client-redirects options: ${error.message}
-  ${JSON.stringify(userOptions, null, 2)}`,
-    );
-  }
-}
-
-export default function normalizePluginOptions(
-  userPluginOptions: UserPluginOptions = {},
-): PluginOptions {
-  validateUserOptions(userPluginOptions);
-  return {...DefaultPluginOptions, ...userPluginOptions};
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "incremental": true,
-    "tsBuildInfoFile": "./lib/.tsbuildinfo",
-    "rootDir": "src",
-    "outDir": "lib",
-    "typeRoots": ["./types", "./node_modules/@types"]
-  }
-}