rename fromRoutePath/toRoutePath to simply from/to

packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/collectRedirects.test.ts.snap

@@ -14,7 +14,7 @@ Valid paths you can redirect to:
 
 exports[`collectRedirects should throw if redirect creator creates array of array redirect 1`] = `
 "Some created redirects are invalid:
-- {\\"fromRoutePath\\":[\\"/fromPath\\"],\\"toRoutePath\\":\\"/\\"} => Validation error: fromRoutePath must be a \`string\` type, but the final value was: \`[
+- {\\"from\\":[\\"/fromPath\\"],\\"to\\":\\"/\\"} => Validation error: from must be a \`string\` type, but the final value was: \`[
   \\"\\\\\\"/fromPath\\\\\\"\\"
 ]\`.
 "
@@ -22,8 +22,8 @@ exports[`collectRedirects should throw if redirect creator creates array of arra
 
 exports[`collectRedirects should throw if redirect creator creates invalid redirects 1`] = `
 "Some created redirects are invalid:
-- {\\"fromRoutePath\\":\\"https://google.com/\\",\\"toRoutePath\\":\\"/\\"} => Validation error: fromRoutePath is not a valid pathname. Pathname should start with / and not contain any domain or query string
+- {\\"from\\":\\"https://google.com/\\",\\"to\\":\\"/\\"} => Validation error: from is not a valid pathname. Pathname should start with / and not contain any domain or query string
-- {\\"fromRoutePath\\":\\"//abc\\",\\"toRoutePath\\":\\"/\\"} => Validation error: fromRoutePath is not a valid pathname. Pathname should start with / and not contain any domain or query string
+- {\\"from\\":\\"//abc\\",\\"to\\":\\"/\\"} => Validation error: from is not a valid pathname. Pathname should start with / and not contain any domain or query string
-- {\\"fromRoutePath\\":\\"/def?queryString=toto\\",\\"toRoutePath\\":\\"/\\"} => Validation error: fromRoutePath is not a valid pathname. Pathname should start with / and not contain any domain or query string
+- {\\"from\\":\\"/def?queryString=toto\\",\\"to\\":\\"/\\"} => Validation error: from is not a valid pathname. Pathname should start with / and not contain any domain or query string
 "
 `;

packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/redirectValidation.test.ts.snap

@@ -1,11 +1,11 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`validateRedirect throw for bad redirects 1`] = `"{\\"fromRoutePath\\":\\"https://fb.com/fromSomePath\\",\\"toRoutePath\\":\\"/toSomePath\\"} => Validation error: fromRoutePath is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
+exports[`validateRedirect throw for bad redirects 1`] = `"{\\"from\\":\\"https://fb.com/fromSomePath\\",\\"to\\":\\"/toSomePath\\"} => Validation error: from is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
 
-exports[`validateRedirect throw for bad redirects 2`] = `"{\\"fromRoutePath\\":\\"/fromSomePath\\",\\"toRoutePath\\":\\"https://fb.com/toSomePath\\"} => Validation error: toRoutePath is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
+exports[`validateRedirect throw for bad redirects 2`] = `"{\\"from\\":\\"/fromSomePath\\",\\"to\\":\\"https://fb.com/toSomePath\\"} => Validation error: to is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
 
-exports[`validateRedirect throw for bad redirects 3`] = `"{\\"fromRoutePath\\":\\"/fromSomePath\\",\\"toRoutePath\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: toRoutePath is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
+exports[`validateRedirect throw for bad redirects 3`] = `"{\\"from\\":\\"/fromSomePath\\",\\"to\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: to is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
 
-exports[`validateRedirect throw for bad redirects 4`] = `"{\\"fromRoutePath\\":null,\\"toRoutePath\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: toRoutePath is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
+exports[`validateRedirect throw for bad redirects 4`] = `"{\\"from\\":null,\\"to\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: to is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
 
-exports[`validateRedirect throw for bad redirects 5`] = `"{\\"fromRoutePath\\":[\\"heyho\\"],\\"toRoutePath\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: toRoutePath is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
+exports[`validateRedirect throw for bad redirects 5`] = `"{\\"from\\":[\\"heyho\\"],\\"to\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: to is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;

packages/docusaurus-plugin-client-redirects/src/__tests__/collectRedirects.test.ts

@@ -45,12 +45,12 @@ describe('collectRedirects', () => {
       ),
     ).toEqual([
       {
-        fromRoutePath: '/somePath.html',
+        from: '/somePath.html',
-        toRoutePath: '/somePath',
+        to: '/somePath',
       },
       {
-        fromRoutePath: '/somePath.exe',
+        from: '/somePath.exe',
-        toRoutePath: '/somePath',
+        to: '/somePath',
       },
     ]);
   });
@@ -67,8 +67,8 @@ describe('collectRedirects', () => {
       ),
     ).toEqual([
       {
-        fromRoutePath: '/otherPath',
+        from: '/otherPath',
-        toRoutePath: '/otherPath.html',
+        to: '/otherPath.html',
       },
     ]);
   });
@@ -94,16 +94,16 @@ describe('collectRedirects', () => {
       ),
     ).toEqual([
       {
-        fromRoutePath: '/someLegacyPath',
+        from: '/someLegacyPath',
-        toRoutePath: '/somePath',
+        to: '/somePath',
       },
       {
-        fromRoutePath: '/someLegacyPathArray1',
+        from: '/someLegacyPathArray1',
-        toRoutePath: '/',
+        to: '/',
       },
       {
-        fromRoutePath: '/someLegacyPathArray2',
+        from: '/someLegacyPathArray2',
-        toRoutePath: '/',
+        to: '/',
       },
     ]);
   });
@@ -151,30 +151,30 @@ describe('collectRedirects', () => {
       ),
     ).toEqual([
       {
-        fromRoutePath: '/some/path/suffix1',
+        from: '/some/path/suffix1',
-        toRoutePath: '/',
+        to: '/',
       },
       {
-        fromRoutePath: '/some/other/path/suffix2',
+        from: '/some/other/path/suffix2',
-        toRoutePath: '/',
+        to: '/',
       },
 
       {
-        fromRoutePath: '/testpath/some/path/suffix1',
+        from: '/testpath/some/path/suffix1',
-        toRoutePath: '/testpath',
+        to: '/testpath',
       },
       {
-        fromRoutePath: '/testpath/some/other/path/suffix2',
+        from: '/testpath/some/other/path/suffix2',
-        toRoutePath: '/testpath',
+        to: '/testpath',
       },
 
       {
-        fromRoutePath: '/otherPath.html/some/path/suffix1',
+        from: '/otherPath.html/some/path/suffix1',
-        toRoutePath: '/otherPath.html',
+        to: '/otherPath.html',
       },
       {
-        fromRoutePath: '/otherPath.html/some/other/path/suffix2',
+        from: '/otherPath.html/some/other/path/suffix2',
-        toRoutePath: '/otherPath.html',
+        to: '/otherPath.html',
       },
     ]);
   });
@@ -239,16 +239,16 @@ describe('collectRedirects', () => {
       ),
     ).toEqual([
       {
-        fromRoutePath: '/toShouldWork.html',
+        from: '/toShouldWork.html',
-        toRoutePath: '/toShouldWork',
+        to: '/toShouldWork',
       },
       {
-        fromRoutePath: '/toShouldWork.exe',
+        from: '/toShouldWork.exe',
-        toRoutePath: '/toShouldWork',
+        to: '/toShouldWork',
       },
       {
-        fromRoutePath: '/fromShouldWork',
+        from: '/fromShouldWork',
-        toRoutePath: '/fromShouldWork.html',
+        to: '/fromShouldWork.html',
       },
     ]);
   });

packages/docusaurus-plugin-client-redirects/src/__tests__/extensionRedirects.test.ts

@@ -55,10 +55,10 @@ describe('createToExtensionsRedirects', () => {
     expect(createToExtensionsRedirects([''], ext)).toEqual([]);
     expect(createToExtensionsRedirects(['/'], ext)).toEqual([]);
     expect(createToExtensionsRedirects(['/abc.html'], ext)).toEqual([
-      {fromRoutePath: '/abc', toRoutePath: '/abc.html'},
+      {from: '/abc', to: '/abc.html'},
     ]);
     expect(createToExtensionsRedirects(['/abc.htm'], ext)).toEqual([
-      {fromRoutePath: '/abc', toRoutePath: '/abc.htm'},
+      {from: '/abc', to: '/abc.htm'},
     ]);
     expect(createToExtensionsRedirects(['/abc.xyz'], ext)).toEqual([]);
   });
@@ -79,8 +79,8 @@ describe('createFromExtensionsRedirects', () => {
     expect(createFromExtensionsRedirects([''], ext)).toEqual([]);
     expect(createFromExtensionsRedirects(['/'], ext)).toEqual([]);
     expect(createFromExtensionsRedirects(['/abc'], ext)).toEqual([
-      {fromRoutePath: '/abc.html', toRoutePath: '/abc'},
+      {from: '/abc.html', to: '/abc'},
-      {fromRoutePath: '/abc.htm', toRoutePath: '/abc'},
+      {from: '/abc.htm', to: '/abc'},
     ]);
     expect(createFromExtensionsRedirects(['/def.html'], ext)).toEqual([]);
     expect(createFromExtensionsRedirects(['/def/'], ext)).toEqual([]);

packages/docusaurus-plugin-client-redirects/src/__tests__/redirectValidation.test.ts

@@ -10,56 +10,56 @@ import {validateRedirect} from '../redirectValidation';
 describe('validateRedirect', () => {
   test('validate good redirects without throwing', () => {
     validateRedirect({
-      fromRoutePath: '/fromSomePath',
+      from: '/fromSomePath',
-      toRoutePath: '/toSomePath',
+      to: '/toSomePath',
     });
     validateRedirect({
-      fromRoutePath: '/from/Some/Path',
+      from: '/from/Some/Path',
-      toRoutePath: '/toSomePath',
+      to: '/toSomePath',
     });
     validateRedirect({
-      fromRoutePath: '/fromSomePath',
+      from: '/fromSomePath',
-      toRoutePath: '/toSomePath',
+      to: '/toSomePath',
     });
     validateRedirect({
-      fromRoutePath: '/fromSomePath',
+      from: '/fromSomePath',
-      toRoutePath: '/to/Some/Path',
+      to: '/to/Some/Path',
     });
   });
 
   test('throw for bad redirects', () => {
     expect(() =>
       validateRedirect({
-        fromRoutePath: 'https://fb.com/fromSomePath',
+        from: 'https://fb.com/fromSomePath',
-        toRoutePath: '/toSomePath',
+        to: '/toSomePath',
       }),
     ).toThrowErrorMatchingSnapshot();
 
     expect(() =>
       validateRedirect({
-        fromRoutePath: '/fromSomePath',
+        from: '/fromSomePath',
-        toRoutePath: 'https://fb.com/toSomePath',
+        to: 'https://fb.com/toSomePath',
       }),
     ).toThrowErrorMatchingSnapshot();
 
     expect(() =>
       validateRedirect({
-        fromRoutePath: '/fromSomePath',
+        from: '/fromSomePath',
-        toRoutePath: '/toSomePath?queryString=xyz',
+        to: '/toSomePath?queryString=xyz',
       }),
     ).toThrowErrorMatchingSnapshot();
 
     expect(() =>
       validateRedirect({
-        fromRoutePath: null as any,
+        from: null as any,
-        toRoutePath: '/toSomePath?queryString=xyz',
+        to: '/toSomePath?queryString=xyz',
       }),
     ).toThrowErrorMatchingSnapshot();
 
     expect(() =>
       validateRedirect({
-        fromRoutePath: ['heyho'] as any,
+        from: ['heyho'] as any,
-        toRoutePath: '/toSomePath?queryString=xyz',
+        to: '/toSomePath?queryString=xyz',
       }),
     ).toThrowErrorMatchingSnapshot();
   });

packages/docusaurus-plugin-client-redirects/src/__tests__/writeRedirectFiles.test.ts

@@ -20,9 +20,9 @@ describe('toRedirectFilesMetadata', () => {
 
     const redirectFiles = toRedirectFilesMetadata(
       [
-        {fromRoutePath: '/abc.html', toRoutePath: '/abc'},
+        {from: '/abc.html', to: '/abc'},
-        {fromRoutePath: '/def', toRoutePath: '/def.html'},
+        {from: '/def', to: '/def.html'},
-        {fromRoutePath: '/xyz', toRoutePath: '/'},
+        {from: '/xyz', to: '/'},
       ],
       pluginContext,
     );
@@ -44,7 +44,7 @@ describe('toRedirectFilesMetadata', () => {
       baseUrl: '/',
     };
     const redirectFiles = toRedirectFilesMetadata(
-      [{fromRoutePath: '/abc.html', toRoutePath: '/abc'}],
+      [{from: '/abc.html', to: '/abc'}],
       pluginContext,
     );
     expect(redirectFiles.map((f) => f.fileContent)).toMatchSnapshot(
@@ -58,7 +58,7 @@ describe('toRedirectFilesMetadata', () => {
       baseUrl: '',
     };
     const redirectFiles = toRedirectFilesMetadata(
-      [{fromRoutePath: '/abc.html', toRoutePath: '/abc'}],
+      [{from: '/abc.html', to: '/abc'}],
       pluginContext,
     );
     expect(redirectFiles.map((f) => f.fileContent)).toMatchSnapshot(

packages/docusaurus-plugin-client-redirects/src/collectRedirects.ts

@@ -50,7 +50,7 @@ function validateCollectedRedirects(
   }
 
   const allowedToPaths = pluginContext.routesPaths;
-  const toPaths = redirects.map((redirect) => redirect.toRoutePath);
+  const toPaths = redirects.map((redirect) => redirect.to);
   const illegalToPaths = difference(toPaths, allowedToPaths);
   if (illegalToPaths.length > 0) {
     throw new Error(
@@ -70,25 +70,25 @@ 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(
+  Object.entries(groupBy(redirects, (redirect) => redirect.from)).forEach(
-    groupBy(redirects, (redirect) => redirect.fromRoutePath),
+    ([from, groupedFromRedirects]) => {
-  ).forEach(([from, groupedFromRedirects]) => {
+      if (groupedFromRedirects.length > 1) {
-    if (groupedFromRedirects.length > 1) {
+        console.error(
-      console.error(
+          chalk.red(
-        chalk.red(
+            `@docusaurus/plugin-client-redirects: multiple redirects are created with the same "from" pathname=${from}
-          `@docusaurus/plugin-client-redirects: multiple redirects are created with the same "from" pathname=${from}
 It is not possible to redirect the same pathname to multiple destinations:
 - ${groupedFromRedirects.map((r) => JSON.stringify(r)).join('\n- ')}
 `,
-        ),
+          ),
-      );
+        );
-    }
+      }
-  });
+    },
-  redirects = uniqBy(redirects, (redirect) => redirect.fromRoutePath);
+  );
+  redirects = uniqBy(redirects, (redirect) => redirect.from);
 
   // We don't want to override an already existing route with a redirect file!
   const redirectsOverridingExistingPath = redirects.filter((redirect) =>
-    pluginContext.routesPaths.includes(redirect.fromRoutePath),
+    pluginContext.routesPaths.includes(redirect.from),
   );
   if (redirectsOverridingExistingPath.length > 0) {
     console.error(
@@ -100,7 +100,7 @@ It is not possible to redirect the same pathname to multiple destinations:
     );
   }
   redirects = redirects.filter(
-    (redirect) => !pluginContext.routesPaths.includes(redirect.fromRoutePath),
+    (redirect) => !pluginContext.routesPaths.includes(redirect.from),
   );
 
   return redirects;
@@ -131,11 +131,11 @@ function createRedirectsOptionRedirects(
   // For conveniency, user can use a string or a string[]
   function optionToRedirects(option: RedirectOption): RedirectMetadata[] {
     if (typeof option.from === 'string') {
-      return [{fromRoutePath: option.from, toRoutePath: option.to}];
+      return [{from: option.from, to: option.to}];
     } else {
-      return option.from.map((fromRoutePath) => ({
+      return option.from.map((from) => ({
-        fromRoutePath,
+        from,
-        toRoutePath: option.to,
+        to: option.to,
       }));
     }
   }
@@ -149,19 +149,17 @@ function createCreateRedirectsOptionRedirects(
   createRedirects: PluginOptions['createRedirects'],
 ): RedirectMetadata[] {
   function createPathRedirects(path: string): RedirectMetadata[] {
-    const fromRoutePathsMixed: string | string[] = createRedirects
+    const fromsMixed: string | string[] = createRedirects
       ? createRedirects(path) || []
       : [];
 
-    const fromRoutePaths: string[] =
+    const froms: string[] =
-      typeof fromRoutePathsMixed === 'string'
+      typeof fromsMixed === 'string' ? [fromsMixed] : fromsMixed;
-        ? [fromRoutePathsMixed]
-        : fromRoutePathsMixed;
 
-    return fromRoutePaths.map((fromRoutePath) => {
+    return froms.map((from) => {
       return {
-        fromRoutePath,
+        from,
-        toRoutePath: path,
+        to: path,
       };
     });
   }

packages/docusaurus-plugin-client-redirects/src/extensionRedirects.ts

@@ -53,8 +53,8 @@ export function createToExtensionsRedirects(
     if (extensionFound) {
       const routePathWithoutExtension = removeSuffix(path, extensionFound);
       return [routePathWithoutExtension].map((from) => ({
-        fromRoutePath: from,
+        from: from,
-        toRoutePath: path,
+        to: path,
       }));
     }
     return [];
@@ -80,8 +80,8 @@ export function createFromExtensionsRedirects(
       return [];
     } else {
       return extensions.map((ext) => ({
-        fromRoutePath: `${path}.${ext}`,
+        from: `${path}.${ext}`,
-        toRoutePath: path,
+        to: path,
       }));
     }
   };

packages/docusaurus-plugin-client-redirects/src/redirectValidation.ts

@@ -17,8 +17,8 @@ export const PathnameValidator = Yup.string().test({
 });
 
 const RedirectSchema = Yup.object<RedirectMetadata>({
-  fromRoutePath: PathnameValidator.required(),
+  from: PathnameValidator.required(),
-  toRoutePath: PathnameValidator.required(),
+  to: PathnameValidator.required(),
 });
 
 export function validateRedirect(redirect: RedirectMetadata) {

packages/docusaurus-plugin-client-redirects/src/types.ts

@@ -36,9 +36,9 @@ export type PluginContext = Pick<
 };
 
 // In-memory representation of redirects we want: easier to test
-// /!\ easy to be confused: "fromRoutePath" is the new page we should create,
+// /!\ easy to be confused: "from" is the new page we should create,
-// that redirects to "toRoutePath" the existing Docusaurus page
+// that redirects to "to": the existing Docusaurus page
 export type RedirectMetadata = {
-  fromRoutePath: string;
+  from: string; // pathname
-  toRoutePath: string;
+  to: string; // pathname
 };

packages/docusaurus-plugin-client-redirects/src/writeRedirectFiles.ts

@@ -38,12 +38,10 @@ export function toRedirectFilesMetadata(
   const createFileMetadata = (redirect: RedirectMetadata) => {
     const fileAbsolutePath = path.join(
       pluginContext.outDir,
-      getFilePathForRoutePath(redirect.fromRoutePath),
+      getFilePathForRoutePath(redirect.from),
     );
     const toUrl = addTrailingSlash(
-      `${removeTrailingSlash(pluginContext.baseUrl)}${path.join(
+      `${removeTrailingSlash(pluginContext.baseUrl)}${path.join(redirect.to)}`,
-        redirect.toRoutePath,
-      )}`,
     );
     const fileContent = createPageContentMemoized(toUrl);
     return {