@docusaurus/plugin-client-redirects 0.0.0-5113 → 0.0.0-5117

package/lib/collectRedirects.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { PluginContext, RedirectMetadata } from './types';
-export default function collectRedirects(pluginContext: PluginContext, trailingSlash: boolean | undefined): RedirectMetadata[];
+import type { PluginContext, RedirectItem } from './types';
+export default function collectRedirects(pluginContext: PluginContext, trailingSlash: boolean | undefined): RedirectItem[];

package/lib/collectRedirects.js

@@ -13,28 +13,32 @@ const utils_common_1 = require("@docusaurus/utils-common");
 const extensionRedirects_1 = require("./extensionRedirects");
 const redirectValidation_1 = require("./redirectValidation");
 function collectRedirects(pluginContext, trailingSlash) {
-    let redirects = doCollectRedirects(pluginContext);
-    redirects = applyRedirectsTrailingSlash(redirects, {
-        trailingSlash,
-        baseUrl: pluginContext.baseUrl,
-    });
+    // For each plugin config option, create the appropriate redirects
+    const redirects = [
+        ...(0, extensionRedirects_1.createFromExtensionsRedirects)(pluginContext.relativeRoutesPaths, pluginContext.options.fromExtensions),
+        ...(0, extensionRedirects_1.createToExtensionsRedirects)(pluginContext.relativeRoutesPaths, pluginContext.options.toExtensions),
+        ...createRedirectsOptionRedirects(pluginContext.options.redirects),
+        ...createCreateRedirectsOptionRedirects(pluginContext.relativeRoutesPaths, pluginContext.options.createRedirects),
+    ].map((redirect) => ({
+        ...redirect,
+        // Given a redirect with `to: "/abc"` and `trailingSlash` enabled:
+        //
+        // - We don't want to reject `to: "/abc"`, as that unambiguously points to
+        // `/abc/` now;
+        // - We want to redirect `to: /abc/` without the user having to change all
+        // her redirect plugin options
+        //
+        // It should be easy to toggle `trailingSlash` option without having to
+        // change other configs
+        to: (0, utils_common_1.applyTrailingSlash)(redirect.to, {
+            trailingSlash,
+            baseUrl: pluginContext.baseUrl,
+        }),
+    }));
     validateCollectedRedirects(redirects, pluginContext);
     return filterUnwantedRedirects(redirects, pluginContext);
 }
 exports.default = collectRedirects;
-// If users wants to redirect to=/abc and they enable trailingSlash=true then
-// => we don't want to reject the to=/abc (as only /abc/ is an existing/valid
-// path now)
-// => we want to redirect to=/abc/ without the user having to change all its
-// redirect plugin options
-// It should be easy to toggle siteConfig.trailingSlash option without having to
-// change other configs
-function applyRedirectsTrailingSlash(redirects, params) {
-    return redirects.map((redirect) => ({
-        ...redirect,
-        to: (0, utils_common_1.applyTrailingSlash)(redirect.to, params),
-    }));
-}
 function validateCollectedRedirects(redirects, pluginContext) {
     const redirectValidationErrors = redirects
         .map((redirect) => {
@@ -81,25 +85,13 @@ It is not possible to redirect the same pathname to multiple destinations: ${gro
     }
     return collectedRedirects.filter((redirect) => !pluginContext.relativeRoutesPaths.includes(redirect.from));
 }
-// For each plugin config option, create the appropriate redirects
-function doCollectRedirects(pluginContext) {
-    return [
-        ...(0, extensionRedirects_1.createFromExtensionsRedirects)(pluginContext.relativeRoutesPaths, pluginContext.options.fromExtensions),
-        ...(0, extensionRedirects_1.createToExtensionsRedirects)(pluginContext.relativeRoutesPaths, pluginContext.options.toExtensions),
-        ...createRedirectsOptionRedirects(pluginContext.options.redirects),
-        ...createCreateRedirectsOptionRedirects(pluginContext.relativeRoutesPaths, pluginContext.options.createRedirects),
-    ];
-}
 function createRedirectsOptionRedirects(redirectsOption) {
     // For convenience, user can use a string or a string[]
     function optionToRedirects(option) {
         if (typeof option.from === 'string') {
             return [{ from: option.from, to: option.to }];
         }
-        return option.from.map((from) => ({
-            from,
-            to: option.to,
-        }));
+        return option.from.map((from) => ({ from, to: option.to }));
     }
     return redirectsOption.flatMap(optionToRedirects);
 }
@@ -108,10 +100,7 @@ function createCreateRedirectsOptionRedirects(paths, createRedirects) {
     function createPathRedirects(path) {
         const fromsMixed = createRedirects?.(path) ?? [];
         const froms = typeof fromsMixed === 'string' ? [fromsMixed] : fromsMixed;
-        return froms.map((from) => ({
-            from,
-            to: path,
-        }));
+        return froms.map((from) => ({ from, to: path }));
     }
     return paths.flatMap(createPathRedirects);
 }

package/lib/extensionRedirects.d.ts

@@ -4,6 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { RedirectMetadata } from './types';
-export declare function createToExtensionsRedirects(paths: string[], extensions: string[]): RedirectMetadata[];
-export declare function createFromExtensionsRedirects(paths: string[], extensions: string[]): RedirectMetadata[];
+import type { RedirectItem } from './types';
+/**
+ * Create new `/path` that redirects to existing an `/path.html`
+ */
+export declare function createToExtensionsRedirects(paths: string[], extensions: string[]): RedirectItem[];
+/**
+ * Create new `/path.html/index.html` that redirects to existing an `/path`
+ * The filename pattern might look weird but it's on purpose (see
+ * https://github.com/facebook/docusaurus/issues/5055)
+ */
+export declare function createFromExtensionsRedirects(paths: string[], extensions: string[]): RedirectItem[];

package/lib/extensionRedirects.js

@@ -24,26 +24,27 @@ const validateExtension = (ext) => {
     }
 };
 const addLeadingDot = (extension) => `.${extension}`;
-// Create new /path that redirects to existing an /path.html
+/**
+ * Create new `/path` that redirects to existing an `/path.html`
+ */
 function createToExtensionsRedirects(paths, extensions) {
     extensions.forEach(validateExtension);
     const dottedExtensions = extensions.map(addLeadingDot);
     const createPathRedirects = (path) => {
         const extensionFound = dottedExtensions.find((ext) => path.endsWith(ext));
         if (extensionFound) {
-            const routePathWithoutExtension = (0, utils_1.removeSuffix)(path, extensionFound);
-            return [routePathWithoutExtension].map((from) => ({
-                from,
-                to: path,
-            }));
+            return [{ from: (0, utils_1.removeSuffix)(path, extensionFound), to: path }];
         }
         return [];
     };
     return paths.flatMap(createPathRedirects);
 }
 exports.createToExtensionsRedirects = createToExtensionsRedirects;
-// Create new /path.html/index.html that redirects to existing an /path
-// The filename pattern might look weird but it's on purpose (see https://github.com/facebook/docusaurus/issues/5055)
+/**
+ * Create new `/path.html/index.html` that redirects to existing an `/path`
+ * The filename pattern might look weird but it's on purpose (see
+ * https://github.com/facebook/docusaurus/issues/5055)
+ */
 function createFromExtensionsRedirects(paths, extensions) {
     extensions.forEach(validateExtension);
     const dottedExtensions = extensions.map(addLeadingDot);

package/lib/index.js

@@ -23,7 +23,7 @@ function pluginClientRedirectsPages(context, options) {
                 options,
             };
             const redirects = (0, collectRedirects_1.default)(pluginContext, trailingSlash);
-            const redirectFiles = (0, writeRedirectFiles_1.toRedirectFilesMetadata)(redirects, pluginContext, trailingSlash);
+            const redirectFiles = (0, writeRedirectFiles_1.toRedirectFiles)(redirects, pluginContext, trailingSlash);
             // Write files only at the end: make code more easy to test without IO
             await (0, writeRedirectFiles_1.default)(redirectFiles);
         },

package/lib/options.d.ts

@@ -6,7 +6,9 @@
  */
 import type { OptionValidationContext } from '@docusaurus/types';
 export declare type RedirectOption = {
+    /** Pathname of an existing Docusaurus page */
     to: string;
+    /** Pathname of the new page(s) we should create */
     from: string | string[];
 };
 export declare type PluginOptions = {
@@ -19,7 +21,9 @@ export declare type PluginOptions = {
     /** The list of redirect rules, each one with multiple `from`s → one `to`. */
     redirects: RedirectOption[];
     /**
-     * A callback to create a redirect rule.
+     * A callback to create a redirect rule. Docusaurus query this callback
+     * against every path it has created, and use its return value to output more
+     * paths.
      * @returns All the paths from which we should redirect to `path`
      */
     createRedirects?: (

package/lib/redirectValidation.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { RedirectMetadata } from './types';
-export declare function validateRedirect(redirect: RedirectMetadata): void;
+import type { RedirectItem } from './types';
+export declare function validateRedirect(redirect: RedirectItem): void;

package/lib/types.d.ts

@@ -18,7 +18,7 @@ export declare type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {
  * /!\ easy to be confused: "from" is the new page we should create,
  * that redirects to "to": the existing Docusaurus page
  */
-export declare type RedirectMetadata = {
+export declare type RedirectItem = {
     /** Pathname of the new page we should create */
     from: string;
     /** Pathname of an existing Docusaurus page */

package/lib/writeRedirectFiles.d.ts

@@ -4,13 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { PluginContext, RedirectMetadata } from './types';
+import type { PluginContext, RedirectItem } from './types';
 export declare type WriteFilesPluginContext = Pick<PluginContext, 'baseUrl' | 'outDir'>;
-export declare type RedirectFileMetadata = {
+export declare type RedirectFile = {
     fileAbsolutePath: string;
     fileContent: string;
 };
 export declare function createToUrl(baseUrl: string, to: string): string;
-export declare function toRedirectFilesMetadata(redirects: RedirectMetadata[], pluginContext: WriteFilesPluginContext, trailingSlash: boolean | undefined): RedirectFileMetadata[];
-export declare function writeRedirectFile(file: RedirectFileMetadata): Promise<void>;
-export default function writeRedirectFiles(redirectFiles: RedirectFileMetadata[]): Promise<void>;
+export declare function toRedirectFiles(redirects: RedirectItem[], pluginContext: WriteFilesPluginContext, trailingSlash: boolean | undefined): RedirectFile[];
+export declare function writeRedirectFile(file: RedirectFile): Promise<void>;
+export default function writeRedirectFiles(redirectFiles: RedirectFile[]): Promise<void>;

package/lib/writeRedirectFiles.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeRedirectFile = exports.toRedirectFilesMetadata = exports.createToUrl = void 0;
+exports.writeRedirectFile = exports.toRedirectFiles = exports.createToUrl = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -45,7 +45,7 @@ function getRedirectFilePath(fromPath, trailingSlash) {
     // tools
     return path_1.default.join(filePath, `${fileName}/index.html`);
 }
-function toRedirectFilesMetadata(redirects, pluginContext, trailingSlash) {
+function toRedirectFiles(redirects, pluginContext, trailingSlash) {
     // Perf: avoid rendering the template twice with the exact same "props"
     // We might create multiple redirect pages for the same destination url
     // note: the first fn arg is the cache key!
@@ -63,7 +63,7 @@ function toRedirectFilesMetadata(redirects, pluginContext, trailingSlash) {
     };
     return redirects.map(createFileMetadata);
 }
-exports.toRedirectFilesMetadata = toRedirectFilesMetadata;
+exports.toRedirectFiles = toRedirectFiles;
 async function writeRedirectFile(file) {
     try {
         // User-friendly security to prevent file overrides

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "0.0.0-5113",
+  "version": "0.0.0-5117",
   "description": "Client redirects plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,18 +18,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5113",
-    "@docusaurus/logger": "0.0.0-5113",
-    "@docusaurus/utils": "0.0.0-5113",
-    "@docusaurus/utils-common": "0.0.0-5113",
-    "@docusaurus/utils-validation": "0.0.0-5113",
+    "@docusaurus/core": "0.0.0-5117",
+    "@docusaurus/logger": "0.0.0-5117",
+    "@docusaurus/utils": "0.0.0-5117",
+    "@docusaurus/utils-common": "0.0.0-5117",
+    "@docusaurus/utils-validation": "0.0.0-5117",
     "eta": "^1.12.3",
     "fs-extra": "^10.1.0",
     "lodash": "^4.17.21",
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-5113"
+    "@docusaurus/types": "0.0.0-5117"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "b5db5c1f998cfe5905b579b14dc5fceb58fb9027"
+  "gitHead": "38327476be4e88fcec4b60e281c5b163565288f8"
 }

package/src/collectRedirects.ts

@@ -7,52 +7,57 @@
 
 import _ from 'lodash';
 import logger from '@docusaurus/logger';
-import {
-  applyTrailingSlash,
-  type ApplyTrailingSlashParams,
-} from '@docusaurus/utils-common';
+import {applyTrailingSlash} from '@docusaurus/utils-common';
 import {
   createFromExtensionsRedirects,
   createToExtensionsRedirects,
 } from './extensionRedirects';
 import {validateRedirect} from './redirectValidation';
 import type {PluginOptions, RedirectOption} from './options';
-import type {PluginContext, RedirectMetadata} from './types';
+import type {PluginContext, RedirectItem} from './types';
 
 export default function collectRedirects(
   pluginContext: PluginContext,
   trailingSlash: boolean | undefined,
-): RedirectMetadata[] {
-  let redirects = doCollectRedirects(pluginContext);
-
-  redirects = applyRedirectsTrailingSlash(redirects, {
-    trailingSlash,
-    baseUrl: pluginContext.baseUrl,
-  });
+): RedirectItem[] {
+  // For each plugin config option, create the appropriate redirects
+  const redirects = [
+    ...createFromExtensionsRedirects(
+      pluginContext.relativeRoutesPaths,
+      pluginContext.options.fromExtensions,
+    ),
+    ...createToExtensionsRedirects(
+      pluginContext.relativeRoutesPaths,
+      pluginContext.options.toExtensions,
+    ),
+    ...createRedirectsOptionRedirects(pluginContext.options.redirects),
+    ...createCreateRedirectsOptionRedirects(
+      pluginContext.relativeRoutesPaths,
+      pluginContext.options.createRedirects,
+    ),
+  ].map((redirect) => ({
+    ...redirect,
+    // Given a redirect with `to: "/abc"` and `trailingSlash` enabled:
+    //
+    // - We don't want to reject `to: "/abc"`, as that unambiguously points to
+    // `/abc/` now;
+    // - We want to redirect `to: /abc/` without the user having to change all
+    // her redirect plugin options
+    //
+    // It should be easy to toggle `trailingSlash` option without having to
+    // change other configs
+    to: applyTrailingSlash(redirect.to, {
+      trailingSlash,
+      baseUrl: pluginContext.baseUrl,
+    }),
+  }));
 
   validateCollectedRedirects(redirects, pluginContext);
   return filterUnwantedRedirects(redirects, pluginContext);
 }
 
-// If users wants to redirect to=/abc and they enable trailingSlash=true then
-// => we don't want to reject the to=/abc (as only /abc/ is an existing/valid
-// path now)
-// => we want to redirect to=/abc/ without the user having to change all its
-// redirect plugin options
-// It should be easy to toggle siteConfig.trailingSlash option without having to
-// change other configs
-function applyRedirectsTrailingSlash(
-  redirects: RedirectMetadata[],
-  params: ApplyTrailingSlashParams,
-) {
-  return redirects.map((redirect) => ({
-    ...redirect,
-    to: applyTrailingSlash(redirect.to, params),
-  }));
-}
-
 function validateCollectedRedirects(
-  redirects: RedirectMetadata[],
+  redirects: RedirectItem[],
   pluginContext: PluginContext,
 ) {
   const redirectValidationErrors = redirects
@@ -89,9 +94,9 @@ Valid paths you can redirect to:
 }
 
 function filterUnwantedRedirects(
-  redirects: RedirectMetadata[],
+  redirects: RedirectItem[],
   pluginContext: PluginContext,
-): RedirectMetadata[] {
+): RedirectItem[] {
   // We don't want to create the same redirect twice, since that would lead to
   // writing the same html redirection file twice.
   Object.entries(_.groupBy(redirects, (redirect) => redirect.from)).forEach(
@@ -120,37 +125,15 @@ It is not possible to redirect the same pathname to multiple destinations: ${gro
   );
 }
 
-// For each plugin config option, create the appropriate redirects
-function doCollectRedirects(pluginContext: PluginContext): RedirectMetadata[] {
-  return [
-    ...createFromExtensionsRedirects(
-      pluginContext.relativeRoutesPaths,
-      pluginContext.options.fromExtensions,
-    ),
-    ...createToExtensionsRedirects(
-      pluginContext.relativeRoutesPaths,
-      pluginContext.options.toExtensions,
-    ),
-    ...createRedirectsOptionRedirects(pluginContext.options.redirects),
-    ...createCreateRedirectsOptionRedirects(
-      pluginContext.relativeRoutesPaths,
-      pluginContext.options.createRedirects,
-    ),
-  ];
-}
-
 function createRedirectsOptionRedirects(
   redirectsOption: PluginOptions['redirects'],
-): RedirectMetadata[] {
+): RedirectItem[] {
   // For convenience, user can use a string or a string[]
-  function optionToRedirects(option: RedirectOption): RedirectMetadata[] {
+  function optionToRedirects(option: RedirectOption): RedirectItem[] {
     if (typeof option.from === 'string') {
       return [{from: option.from, to: option.to}];
     }
-    return option.from.map((from) => ({
-      from,
-      to: option.to,
-    }));
+    return option.from.map((from) => ({from, to: option.to}));
   }
 
   return redirectsOption.flatMap(optionToRedirects);
@@ -160,17 +143,14 @@ function createRedirectsOptionRedirects(
 function createCreateRedirectsOptionRedirects(
   paths: string[],
   createRedirects: PluginOptions['createRedirects'],
-): RedirectMetadata[] {
-  function createPathRedirects(path: string): RedirectMetadata[] {
+): RedirectItem[] {
+  function createPathRedirects(path: string): RedirectItem[] {
     const fromsMixed: string | string[] = createRedirects?.(path) ?? [];
 
     const froms: string[] =
       typeof fromsMixed === 'string' ? [fromsMixed] : fromsMixed;
 
-    return froms.map((from) => ({
-      from,
-      to: path,
-    }));
+    return froms.map((from) => ({from, to: path}));
   }
 
   return paths.flatMap(createPathRedirects);

package/src/extensionRedirects.ts

@@ -10,7 +10,7 @@ import {
   removeSuffix,
   removeTrailingSlash,
 } from '@docusaurus/utils';
-import type {RedirectMetadata} from './types';
+import type {RedirectItem} from './types';
 
 const ExtensionAdditionalMessage =
   'If the redirect extension system is not good enough for your use case, you can create redirects yourself with the "createRedirects" plugin option.';
@@ -40,23 +40,21 @@ const validateExtension = (ext: string) => {
 
 const addLeadingDot = (extension: string) => `.${extension}`;
 
-// Create new /path that redirects to existing an /path.html
+/**
+ * Create new `/path` that redirects to existing an `/path.html`
+ */
 export function createToExtensionsRedirects(
   paths: string[],
   extensions: string[],
-): RedirectMetadata[] {
+): RedirectItem[] {
   extensions.forEach(validateExtension);
 
   const dottedExtensions = extensions.map(addLeadingDot);
 
-  const createPathRedirects = (path: string): RedirectMetadata[] => {
+  const createPathRedirects = (path: string): RedirectItem[] => {
     const extensionFound = dottedExtensions.find((ext) => path.endsWith(ext));
     if (extensionFound) {
-      const routePathWithoutExtension = removeSuffix(path, extensionFound);
-      return [routePathWithoutExtension].map((from) => ({
-        from,
-        to: path,
-      }));
+      return [{from: removeSuffix(path, extensionFound), to: path}];
     }
     return [];
   };
@@ -64,12 +62,15 @@ export function createToExtensionsRedirects(
   return paths.flatMap(createPathRedirects);
 }
 
-// Create new /path.html/index.html that redirects to existing an /path
-// The filename pattern might look weird but it's on purpose (see https://github.com/facebook/docusaurus/issues/5055)
+/**
+ * Create new `/path.html/index.html` that redirects to existing an `/path`
+ * The filename pattern might look weird but it's on purpose (see
+ * https://github.com/facebook/docusaurus/issues/5055)
+ */
 export function createFromExtensionsRedirects(
   paths: string[],
   extensions: string[],
-): RedirectMetadata[] {
+): RedirectItem[] {
   extensions.forEach(validateExtension);
 
   const dottedExtensions = extensions.map(addLeadingDot);
@@ -77,7 +78,7 @@ export function createFromExtensionsRedirects(
   const alreadyEndsWithAnExtension = (str: string) =>
     dottedExtensions.some((ext) => str.endsWith(ext));
 
-  const createPathRedirects = (path: string): RedirectMetadata[] => {
+  const createPathRedirects = (path: string): RedirectItem[] => {
     if (path === '' || path === '/' || alreadyEndsWithAnExtension(path)) {
       return [];
     }

package/src/index.ts

@@ -8,11 +8,11 @@
 import {removePrefix, addLeadingSlash} from '@docusaurus/utils';
 import collectRedirects from './collectRedirects';
 import writeRedirectFiles, {
-  toRedirectFilesMetadata,
-  type RedirectFileMetadata,
+  toRedirectFiles,
+  type RedirectFile,
 } from './writeRedirectFiles';
 import type {LoadContext, Plugin} from '@docusaurus/types';
-import type {PluginContext, RedirectMetadata} from './types';
+import type {PluginContext, RedirectItem} from './types';
 import type {PluginOptions, Options} from './options';
 
 export default function pluginClientRedirectsPages(
@@ -33,12 +33,12 @@ export default function pluginClientRedirectsPages(
         options,
       };
 
-      const redirects: RedirectMetadata[] = collectRedirects(
+      const redirects: RedirectItem[] = collectRedirects(
         pluginContext,
         trailingSlash,
       );
 
-      const redirectFiles: RedirectFileMetadata[] = toRedirectFilesMetadata(
+      const redirectFiles: RedirectFile[] = toRedirectFiles(
         redirects,
         pluginContext,
         trailingSlash,

package/src/options.ts

@@ -9,7 +9,9 @@ import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
 import type {OptionValidationContext} from '@docusaurus/types';
 
 export type RedirectOption = {
+  /** Pathname of an existing Docusaurus page */
   to: string;
+  /** Pathname of the new page(s) we should create */
   from: string | string[];
 };
 
@@ -23,7 +25,9 @@ export type PluginOptions = {
   /** The list of redirect rules, each one with multiple `from`s → one `to`. */
   redirects: RedirectOption[];
   /**
-   * A callback to create a redirect rule.
+   * A callback to create a redirect rule. Docusaurus query this callback
+   * against every path it has created, and use its return value to output more
+   * paths.
    * @returns All the paths from which we should redirect to `path`
    */
   createRedirects?: (

package/src/redirectValidation.ts

@@ -6,14 +6,14 @@
  */
 
 import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
-import type {RedirectMetadata} from './types';
+import type {RedirectItem} from './types';
 
-const RedirectSchema = Joi.object<RedirectMetadata>({
+const RedirectSchema = Joi.object<RedirectItem>({
   from: PathnameSchema.required(),
   to: PathnameSchema.required(),
 });
 
-export function validateRedirect(redirect: RedirectMetadata): void {
+export function validateRedirect(redirect: RedirectItem): void {
   const {error} = RedirectSchema.validate(redirect, {
     abortEarly: true,
     convert: false,

package/src/types.ts

@@ -21,7 +21,7 @@ export type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {
  * /!\ easy to be confused: "from" is the new page we should create,
  * that redirects to "to": the existing Docusaurus page
  */
-export type RedirectMetadata = {
+export type RedirectItem = {
   /** Pathname of the new page we should create */
   from: string;
   /** Pathname of an existing Docusaurus page */

package/src/writeRedirectFiles.ts

@@ -13,11 +13,11 @@ import {normalizeUrl} from '@docusaurus/utils';
 
 import createRedirectPageContent from './createRedirectPageContent';
 
-import type {PluginContext, RedirectMetadata} from './types';
+import type {PluginContext, RedirectItem} from './types';
 
 export type WriteFilesPluginContext = Pick<PluginContext, 'baseUrl' | 'outDir'>;
 
-export type RedirectFileMetadata = {
+export type RedirectFile = {
   fileAbsolutePath: string;
   fileContent: string;
 };
@@ -57,11 +57,11 @@ function getRedirectFilePath(
   return path.join(filePath, `${fileName}/index.html`);
 }
 
-export function toRedirectFilesMetadata(
-  redirects: RedirectMetadata[],
+export function toRedirectFiles(
+  redirects: RedirectItem[],
   pluginContext: WriteFilesPluginContext,
   trailingSlash: boolean | undefined,
-): RedirectFileMetadata[] {
+): RedirectFile[] {
   // Perf: avoid rendering the template twice with the exact same "props"
   // We might create multiple redirect pages for the same destination url
   // note: the first fn arg is the cache key!
@@ -69,7 +69,7 @@ export function toRedirectFilesMetadata(
     createRedirectPageContent({toUrl}),
   );
 
-  const createFileMetadata = (redirect: RedirectMetadata) => {
+  const createFileMetadata = (redirect: RedirectItem) => {
     const fileRelativePath = getRedirectFilePath(redirect.from, trailingSlash);
     const fileAbsolutePath = path.join(pluginContext.outDir, fileRelativePath);
     const toUrl = createToUrl(pluginContext.baseUrl, redirect.to);
@@ -84,9 +84,7 @@ export function toRedirectFilesMetadata(
   return redirects.map(createFileMetadata);
 }
 
-export async function writeRedirectFile(
-  file: RedirectFileMetadata,
-): Promise<void> {
+export async function writeRedirectFile(file: RedirectFile): Promise<void> {
   try {
     // User-friendly security to prevent file overrides
     if (await fs.pathExists(file.fileAbsolutePath)) {
@@ -108,7 +106,7 @@ export async function writeRedirectFile(
 }
 
 export default async function writeRedirectFiles(
-  redirectFiles: RedirectFileMetadata[],
+  redirectFiles: RedirectFile[],
 ): Promise<void> {
   await Promise.all(redirectFiles.map(writeRedirectFile));
 }