@docusaurus/plugin-client-redirects 2.0.0-beta.15 → 2.0.0-beta.16

package/lib/collectRedirects.js

@@ -7,7 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const extensionRedirects_1 = require("./extensionRedirects");
 const redirectValidation_1 = require("./redirectValidation");
 const utils_common_1 = require("@docusaurus/utils-common");
@@ -23,9 +23,12 @@ function collectRedirects(pluginContext, trailingSlash) {
 }
 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
+// => 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,
@@ -39,8 +42,8 @@ function validateCollectedRedirects(redirects, pluginContext) {
             (0, redirectValidation_1.validateRedirect)(redirect);
             return undefined;
         }
-        catch (e) {
-            return e.message;
+        catch (err) {
+            return err.message;
         }
     })
         .filter(Boolean);
@@ -51,7 +54,7 @@ function validateCollectedRedirects(redirects, pluginContext) {
     }
     const allowedToPaths = pluginContext.relativeRoutesPaths;
     const toPaths = redirects.map((redirect) => redirect.to);
-    const illegalToPaths = (0, lodash_1.difference)(toPaths, allowedToPaths);
+    const illegalToPaths = lodash_1.default.difference(toPaths, allowedToPaths);
     if (illegalToPaths.length > 0) {
         throw new Error(`You are trying to create client-side redirections to paths that do not exist:
 - ${illegalToPaths.join('\n- ')}
@@ -64,13 +67,13 @@ Valid paths you can redirect to:
 function filterUnwantedRedirects(redirects, pluginContext) {
     // we don't want to create twice the same redirect
     // that would lead to writing twice the same html redirection file
-    Object.entries((0, lodash_1.groupBy)(redirects, (redirect) => redirect.from)).forEach(([from, groupedFromRedirects]) => {
+    Object.entries(lodash_1.default.groupBy(redirects, (redirect) => redirect.from)).forEach(([from, groupedFromRedirects]) => {
         if (groupedFromRedirects.length > 1) {
             logger_1.default.error `name=${'@docusaurus/plugin-client-redirects'}: multiple redirects are created with the same "from" pathname: path=${from}
 It is not possible to redirect the same pathname to multiple destinations: ${groupedFromRedirects.map((r) => JSON.stringify(r))}`;
         }
     });
-    const collectedRedirects = (0, lodash_1.uniqBy)(redirects, (redirect) => redirect.from);
+    const collectedRedirects = lodash_1.default.uniqBy(redirects, (redirect) => redirect.from);
     // We don't want to override an already existing route with a redirect file!
     const redirectsOverridingExistingPath = collectedRedirects.filter((redirect) => pluginContext.relativeRoutesPaths.includes(redirect.from));
     if (redirectsOverridingExistingPath.length > 0) {

package/lib/createRedirectPageContent.js

@@ -9,8 +9,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const eta = (0, tslib_1.__importStar)(require("eta"));
 const redirectPage_template_html_1 = (0, tslib_1.__importDefault)(require("./templates/redirectPage.template.html"));
-const lodash_1 = require("lodash");
-const getCompiledRedirectPageTemplate = (0, lodash_1.memoize)(() => eta.compile(redirectPage_template_html_1.default.trim()));
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+const getCompiledRedirectPageTemplate = lodash_1.default.memoize(() => eta.compile(redirectPage_template_html_1.default.trim()));
 function renderRedirectPageTemplate(data) {
     const compiled = getCompiledRedirectPageTemplate();
     return compiled(data, eta.defaultConfig);

package/lib/extensionRedirects.js

@@ -52,18 +52,12 @@ function createFromExtensionsRedirects(paths, extensions) {
         if (path === '' || path === '/' || alreadyEndsWithAnExtension(path)) {
             return [];
         }
-        // /path => /path.html
-        // /path/ => /path.html/
-        function getFrom(ext) {
-            if (path.endsWith('/')) {
-                return (0, utils_1.addTrailingSlash)(`${(0, utils_1.removeTrailingSlash)(path)}.${ext}`);
-            }
-            else {
-                return `${path}.${ext}`;
-            }
-        }
         return extensions.map((ext) => ({
-            from: getFrom(ext),
+            // /path => /path.html
+            // /path/ => /path.html/
+            from: path.endsWith('/')
+                ? (0, utils_1.addTrailingSlash)(`${(0, utils_1.removeTrailingSlash)(path)}.${ext}`)
+                : `${path}.${ext}`,
             to: path,
         }));
     };

package/lib/writeRedirectFiles.js

@@ -10,7 +10,7 @@ exports.writeRedirectFile = exports.toRedirectFilesMetadata = exports.createToUr
 const tslib_1 = require("tslib");
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const createRedirectPageContent_1 = (0, tslib_1.__importDefault)(require("./createRedirectPageContent"));
 const utils_1 = require("@docusaurus/utils");
 function createToUrl(baseUrl, to) {
@@ -18,7 +18,8 @@ function createToUrl(baseUrl, to) {
 }
 exports.createToUrl = createToUrl;
 // Create redirect file path
-// Make sure this path has lower precedence over the original file path when served by host providers!
+// Make sure this path has lower precedence over the original file path when
+// served by host providers!
 // Otherwise it can produce infinite redirect loops!
 //
 // See https://github.com/facebook/docusaurus/issues/5055
@@ -29,23 +30,25 @@ function getRedirectFilePath(fromPath, trailingSlash) {
     const filePath = path_1.default.dirname(fromPath);
     // Edge case for https://github.com/facebook/docusaurus/pull/5102
     // If the redirect source path is /xyz, with file /xyz.html
-    // We can't write the redirect file at /xyz.html/index.html because for Unix FS, a file/folder can't have the same name "xyz.html"
-    // The only possible solution for a redirect file is thus /xyz.html.html (I know, looks suspicious)
+    // We can't write the redirect file at /xyz.html/index.html because for Unix
+    // FS, a file/folder can't have the same name "xyz.html"
+    // The only possible solution for a redirect file is thus /xyz.html.html (I
+    // know, looks suspicious)
     if (trailingSlash === false && fileName.endsWith('.html')) {
         return path_1.default.join(filePath, `${fileName}.html`);
     }
-    // If the target path is /xyz, with file /xyz/index.html, we don't want the redirect file to be /xyz.html
-    // otherwise it would be picked in priority and the redirect file would redirect to itself
-    // We prefer the redirect file to be /xyz.html/index.html, served with lower priority for most static hosting tools
-    else {
-        return path_1.default.join(filePath, `${fileName}/index.html`);
-    }
+    // If the target path is /xyz, with file /xyz/index.html, we don't want the
+    // redirect file to be /xyz.html, otherwise it would be picked in priority and
+    // the redirect file would redirect to itself. We prefer the redirect file to
+    // be /xyz.html/index.html, served with lower priority for most static hosting
+    // tools
+    return path_1.default.join(filePath, `${fileName}/index.html`);
 }
 function toRedirectFilesMetadata(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!
-    const createPageContentMemoized = (0, lodash_1.memoize)((toUrl) => (0, createRedirectPageContent_1.default)({ toUrl }));
+    const createPageContentMemoized = lodash_1.default.memoize((toUrl) => (0, createRedirectPageContent_1.default)({ toUrl }));
     const createFileMetadata = (redirect) => {
         const fileRelativePath = getRedirectFilePath(redirect.from, trailingSlash);
         const fileAbsolutePath = path_1.default.join(pluginContext.outDir, fileRelativePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "2.0.0-beta.15",
+  "version": "2.0.0-beta.16",
   "description": "Client redirects plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-client-redirects.d.ts",
@@ -18,18 +18,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.15",
-    "@docusaurus/logger": "2.0.0-beta.15",
-    "@docusaurus/utils": "2.0.0-beta.15",
-    "@docusaurus/utils-common": "2.0.0-beta.15",
-    "@docusaurus/utils-validation": "2.0.0-beta.15",
+    "@docusaurus/core": "2.0.0-beta.16",
+    "@docusaurus/logger": "2.0.0-beta.16",
+    "@docusaurus/utils": "2.0.0-beta.16",
+    "@docusaurus/utils-common": "2.0.0-beta.16",
+    "@docusaurus/utils-validation": "2.0.0-beta.16",
     "eta": "^1.12.3",
-    "fs-extra": "^10.0.0",
-    "lodash": "^4.17.20",
+    "fs-extra": "^10.0.1",
+    "lodash": "^4.17.21",
     "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.15"
+    "@docusaurus/types": "2.0.0-beta.16"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "6cfad16436c07d8d11e5c2e1486dc59afd483e33"
+  "gitHead": "eb43c4d4f95a4fb97dc9bb9dc615413e0dc2e1e7"
 }

package/src/collectRedirects.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {uniqBy, difference, groupBy} from 'lodash';
+import _ from 'lodash';
 import type {
   PluginOptions,
   RedirectOption,
@@ -39,9 +39,12 @@ export default function 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
+// => 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,
@@ -61,8 +64,8 @@ function validateCollectedRedirects(
       try {
         validateRedirect(redirect);
         return undefined;
-      } catch (e) {
-        return (e as Error).message;
+      } catch (err) {
+        return (err as Error).message;
       }
     })
     .filter(Boolean);
@@ -76,7 +79,7 @@ function validateCollectedRedirects(
 
   const allowedToPaths = pluginContext.relativeRoutesPaths;
   const toPaths = redirects.map((redirect) => redirect.to);
-  const illegalToPaths = difference(toPaths, allowedToPaths);
+  const illegalToPaths = _.difference(toPaths, allowedToPaths);
   if (illegalToPaths.length > 0) {
     throw new Error(
       `You are trying to create client-side redirections to paths that do not exist:
@@ -95,7 +98,7 @@ function filterUnwantedRedirects(
 ): RedirectMetadata[] {
   // we don't want to create twice the same redirect
   // that would lead to writing twice the same html redirection file
-  Object.entries(groupBy(redirects, (redirect) => redirect.from)).forEach(
+  Object.entries(_.groupBy(redirects, (redirect) => redirect.from)).forEach(
     ([from, groupedFromRedirects]) => {
       if (groupedFromRedirects.length > 1) {
         logger.error`name=${'@docusaurus/plugin-client-redirects'}: multiple redirects are created with the same "from" pathname: path=${from}
@@ -105,7 +108,7 @@ It is not possible to redirect the same pathname to multiple destinations: ${gro
       }
     },
   );
-  const collectedRedirects = uniqBy(redirects, (redirect) => redirect.from);
+  const collectedRedirects = _.uniqBy(redirects, (redirect) => redirect.from);
 
   // We don't want to override an already existing route with a redirect file!
   const redirectsOverridingExistingPath = collectedRedirects.filter(

package/src/createRedirectPageContent.ts

@@ -7,13 +7,13 @@
 
 import * as eta from 'eta';
 import redirectPageTemplate from './templates/redirectPage.template.html';
-import {memoize} from 'lodash';
+import _ from 'lodash';
 
 type CreateRedirectPageOptions = {
   toUrl: string;
 };
 
-const getCompiledRedirectPageTemplate = memoize(() =>
+const getCompiledRedirectPageTemplate = _.memoize(() =>
   eta.compile(redirectPageTemplate.trim()),
 );
 

package/src/extensionRedirects.ts

@@ -81,19 +81,12 @@ export function createFromExtensionsRedirects(
     if (path === '' || path === '/' || alreadyEndsWithAnExtension(path)) {
       return [];
     }
-
-    // /path => /path.html
-    // /path/ => /path.html/
-    function getFrom(ext: string) {
-      if (path.endsWith('/')) {
-        return addTrailingSlash(`${removeTrailingSlash(path)}.${ext}`);
-      } else {
-        return `${path}.${ext}`;
-      }
-    }
-
     return extensions.map((ext) => ({
-      from: getFrom(ext),
+      // /path => /path.html
+      // /path/ => /path.html/
+      from: path.endsWith('/')
+        ? addTrailingSlash(`${removeTrailingSlash(path)}.${ext}`)
+        : `${path}.${ext}`,
       to: path,
     }));
   };

package/src/writeRedirectFiles.ts

@@ -7,7 +7,7 @@
 
 import fs from 'fs-extra';
 import path from 'path';
-import {memoize} from 'lodash';
+import _ from 'lodash';
 
 import type {PluginContext, RedirectMetadata} from './types';
 import createRedirectPageContent from './createRedirectPageContent';
@@ -25,7 +25,8 @@ export function createToUrl(baseUrl: string, to: string): string {
 }
 
 // Create redirect file path
-// Make sure this path has lower precedence over the original file path when served by host providers!
+// Make sure this path has lower precedence over the original file path when
+// served by host providers!
 // Otherwise it can produce infinite redirect loops!
 //
 // See https://github.com/facebook/docusaurus/issues/5055
@@ -39,17 +40,19 @@ function getRedirectFilePath(
   const filePath = path.dirname(fromPath);
   // Edge case for https://github.com/facebook/docusaurus/pull/5102
   // If the redirect source path is /xyz, with file /xyz.html
-  // We can't write the redirect file at /xyz.html/index.html because for Unix FS, a file/folder can't have the same name "xyz.html"
-  // The only possible solution for a redirect file is thus /xyz.html.html (I know, looks suspicious)
+  // We can't write the redirect file at /xyz.html/index.html because for Unix
+  // FS, a file/folder can't have the same name "xyz.html"
+  // The only possible solution for a redirect file is thus /xyz.html.html (I
+  // know, looks suspicious)
   if (trailingSlash === false && fileName.endsWith('.html')) {
     return path.join(filePath, `${fileName}.html`);
   }
-  // If the target path is /xyz, with file /xyz/index.html, we don't want the redirect file to be /xyz.html
-  // otherwise it would be picked in priority and the redirect file would redirect to itself
-  // We prefer the redirect file to be /xyz.html/index.html, served with lower priority for most static hosting tools
-  else {
-    return path.join(filePath, `${fileName}/index.html`);
-  }
+  // If the target path is /xyz, with file /xyz/index.html, we don't want the
+  // redirect file to be /xyz.html, otherwise it would be picked in priority and
+  // the redirect file would redirect to itself. We prefer the redirect file to
+  // be /xyz.html/index.html, served with lower priority for most static hosting
+  // tools
+  return path.join(filePath, `${fileName}/index.html`);
 }
 
 export function toRedirectFilesMetadata(
@@ -60,7 +63,7 @@ export function toRedirectFilesMetadata(
   // 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!
-  const createPageContentMemoized = memoize((toUrl: string) =>
+  const createPageContentMemoized = _.memoize((toUrl: string) =>
     createRedirectPageContent({toUrl}),
   );