@docusaurus/plugin-client-redirects 0.0.0-5133 → 0.0.0-5140

package/lib/collectRedirects.js

@@ -73,17 +73,16 @@ function filterUnwantedRedirects(redirects, pluginContext) {
     // writing the same html redirection file twice.
     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))}`;
+            logger_1.default.report(pluginContext.siteConfig.onDuplicateRoutes) `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 = 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));
+    const { false: newRedirects = [], true: redirectsOverridingExistingPath = [] } = lodash_1.default.groupBy(collectedRedirects, (redirect) => pluginContext.relativeRoutesPaths.includes(redirect.from));
     if (redirectsOverridingExistingPath.length > 0) {
-        logger_1.default.error `name=${'@docusaurus/plugin-client-redirects'}: some redirects would override existing paths, and will be ignored: ${redirectsOverridingExistingPath.map((r) => JSON.stringify(r))}`;
+        logger_1.default.report(pluginContext.siteConfig.onDuplicateRoutes) `name=${'@docusaurus/plugin-client-redirects'}: some redirects would override existing paths, and will be ignored:${redirectsOverridingExistingPath.map((r) => JSON.stringify(r))}`;
     }
-    return collectedRedirects.filter((redirect) => !pluginContext.relativeRoutesPaths.includes(redirect.from));
+    return newRedirects;
 }
 function createRedirectsOptionRedirects(redirectsOption) {
     // For convenience, user can use a string or a string[]

package/lib/index.js

@@ -21,6 +21,7 @@ function pluginClientRedirectsPages(context, options) {
                 baseUrl: props.baseUrl,
                 outDir: props.outDir,
                 options,
+                siteConfig: props.siteConfig,
             };
             const redirects = (0, collectRedirects_1.default)(pluginContext, trailingSlash);
             const redirectFiles = (0, writeRedirectFiles_1.toRedirectFiles)(redirects, pluginContext, trailingSlash);

package/lib/types.d.ts

@@ -9,7 +9,7 @@ import type { PluginOptions } from './options';
 /**
  * The minimal infos the plugin needs to work
  */
-export declare type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {
+export declare type PluginContext = Pick<Props, 'outDir' | 'baseUrl' | 'siteConfig'> & {
     options: PluginOptions;
     relativeRoutesPaths: string[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "0.0.0-5133",
+  "version": "0.0.0-5140",
   "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-5133",
-    "@docusaurus/logger": "0.0.0-5133",
-    "@docusaurus/utils": "0.0.0-5133",
-    "@docusaurus/utils-common": "0.0.0-5133",
-    "@docusaurus/utils-validation": "0.0.0-5133",
+    "@docusaurus/core": "0.0.0-5140",
+    "@docusaurus/logger": "0.0.0-5140",
+    "@docusaurus/utils": "0.0.0-5140",
+    "@docusaurus/utils-common": "0.0.0-5140",
+    "@docusaurus/utils-validation": "0.0.0-5140",
     "eta": "^1.12.3",
     "fs-extra": "^10.1.0",
     "lodash": "^4.17.21",
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-5133"
+    "@docusaurus/types": "0.0.0-5140"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "4c5e886911b143aab693647b60c293e8ebcd6611"
+  "gitHead": "69c4afd865b2ddd33abeca82c6732b5d639e79d1"
 }

package/src/collectRedirects.ts

@@ -102,8 +102,10 @@ function filterUnwantedRedirects(
   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}
-It is not possible to redirect the same pathname to multiple destinations: ${groupedFromRedirects.map(
+        logger.report(
+          pluginContext.siteConfig.onDuplicateRoutes,
+        )`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),
         )}`;
       }
@@ -111,18 +113,18 @@ It is not possible to redirect the same pathname to multiple destinations: ${gro
   );
   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(
-    (redirect) => pluginContext.relativeRoutesPaths.includes(redirect.from),
-  );
+  const {false: newRedirects = [], true: redirectsOverridingExistingPath = []} =
+    _.groupBy(collectedRedirects, (redirect) =>
+      pluginContext.relativeRoutesPaths.includes(redirect.from),
+    );
   if (redirectsOverridingExistingPath.length > 0) {
-    logger.error`name=${'@docusaurus/plugin-client-redirects'}: some redirects would override existing paths, and will be ignored: ${redirectsOverridingExistingPath.map(
+    logger.report(
+      pluginContext.siteConfig.onDuplicateRoutes,
+    )`name=${'@docusaurus/plugin-client-redirects'}: some redirects would override existing paths, and will be ignored:${redirectsOverridingExistingPath.map(
       (r) => JSON.stringify(r),
     )}`;
   }
-  return collectedRedirects.filter(
-    (redirect) => !pluginContext.relativeRoutesPaths.includes(redirect.from),
-  );
+  return newRedirects;
 }
 
 function createRedirectsOptionRedirects(

package/src/index.ts

@@ -31,6 +31,7 @@ export default function pluginClientRedirectsPages(
         baseUrl: props.baseUrl,
         outDir: props.outDir,
         options,
+        siteConfig: props.siteConfig,
       };
 
       const redirects: RedirectItem[] = collectRedirects(

package/src/types.ts

@@ -11,7 +11,7 @@ import type {PluginOptions} from './options';
 /**
  * The minimal infos the plugin needs to work
  */
-export type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {
+export type PluginContext = Pick<Props, 'outDir' | 'baseUrl' | 'siteConfig'> & {
   options: PluginOptions;
   relativeRoutesPaths: string[];
 };