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

package/lib/collectRedirects.js

@@ -8,10 +8,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_common_1 = require("@docusaurus/utils-common");
 const extensionRedirects_1 = require("./extensionRedirects");
 const redirectValidation_1 = require("./redirectValidation");
-const utils_common_1 = require("@docusaurus/utils-common");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 function collectRedirects(pluginContext, trailingSlash) {
     let redirects = doCollectRedirects(pluginContext);
     redirects = applyRedirectsTrailingSlash(redirects, {

package/lib/createRedirectPageContent.js

@@ -7,9 +7,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const eta = tslib_1.__importStar(require("eta"));
 const redirectPage_template_html_1 = tslib_1.__importDefault(require("./templates/redirectPage.template.html"));
-const lodash_1 = 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();

package/lib/index.d.ts

@@ -6,6 +6,6 @@
  */
 import type { LoadContext, Plugin } from '@docusaurus/types';
 import type { PluginOptions, Options } from './options';
-export default function pluginClientRedirectsPages(context: LoadContext, options: PluginOptions): Plugin<unknown>;
+export default function pluginClientRedirectsPages(context: LoadContext, options: PluginOptions): Plugin<void>;
 export { validateOptions } from './options';
 export type { PluginOptions, Options };

package/lib/index.js

@@ -8,9 +8,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
+const utils_1 = require("@docusaurus/utils");
 const collectRedirects_1 = tslib_1.__importDefault(require("./collectRedirects"));
 const writeRedirectFiles_1 = tslib_1.__importStar(require("./writeRedirectFiles"));
-const utils_1 = require("@docusaurus/utils");
 function pluginClientRedirectsPages(context, options) {
     const { trailingSlash } = context.siteConfig;
     return {

package/lib/options.d.ts

@@ -28,4 +28,4 @@ export declare type PluginOptions = {
 };
 export declare type Options = Partial<PluginOptions>;
 export declare const DEFAULT_OPTIONS: Partial<PluginOptions>;
-export declare function validateOptions({ validate, options: userOptions, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;
+export declare function validateOptions({ validate, options: userOptions, }: OptionValidationContext<Options | undefined, PluginOptions>): PluginOptions;

package/lib/writeRedirectFiles.js

@@ -11,8 +11,9 @@ const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const createRedirectPageContent_1 = tslib_1.__importDefault(require("./createRedirectPageContent"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
+const createRedirectPageContent_1 = tslib_1.__importDefault(require("./createRedirectPageContent"));
 function createToUrl(baseUrl, to) {
     return (0, utils_1.normalizeUrl)([baseUrl, to]);
 }
@@ -75,7 +76,8 @@ async function writeRedirectFile(file) {
         { flag: 'wx' });
     }
     catch (err) {
-        throw new Error(`Redirect file creation error for "${file.fileAbsolutePath}" path: ${err}.`);
+        logger_1.default.error `Redirect file creation error for path=${file.fileAbsolutePath}.`;
+        throw err;
     }
 }
 exports.writeRedirectFile = writeRedirectFile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "2.0.0-beta.20",
+  "version": "2.0.0-beta.21",
   "description": "Client redirects plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,25 +18,25 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.20",
-    "@docusaurus/logger": "2.0.0-beta.20",
-    "@docusaurus/utils": "2.0.0-beta.20",
-    "@docusaurus/utils-common": "2.0.0-beta.20",
-    "@docusaurus/utils-validation": "2.0.0-beta.20",
+    "@docusaurus/core": "2.0.0-beta.21",
+    "@docusaurus/logger": "2.0.0-beta.21",
+    "@docusaurus/utils": "2.0.0-beta.21",
+    "@docusaurus/utils-common": "2.0.0-beta.21",
+    "@docusaurus/utils-validation": "2.0.0-beta.21",
     "eta": "^1.12.3",
     "fs-extra": "^10.1.0",
     "lodash": "^4.17.21",
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.20"
+    "@docusaurus/types": "2.0.0-beta.21"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16.14"
   },
-  "gitHead": "ed5cdba401a5948e187e927039b142a0decc702d"
+  "gitHead": "69ac49fc6909517f13615ee40290c4bd00c39df4"
 }

package/src/collectRedirects.ts

@@ -6,19 +6,18 @@
  */
 
 import _ from 'lodash';
-import type {PluginOptions, RedirectOption} from './options';
-import type {PluginContext, RedirectMetadata} from './types';
+import logger from '@docusaurus/logger';
+import {
+  applyTrailingSlash,
+  type ApplyTrailingSlashParams,
+} from '@docusaurus/utils-common';
 import {
   createFromExtensionsRedirects,
   createToExtensionsRedirects,
 } from './extensionRedirects';
 import {validateRedirect} from './redirectValidation';
-import {
-  applyTrailingSlash,
-  type ApplyTrailingSlashParams,
-} from '@docusaurus/utils-common';
-
-import logger from '@docusaurus/logger';
+import type {PluginOptions, RedirectOption} from './options';
+import type {PluginContext, RedirectMetadata} from './types';
 
 export default function collectRedirects(
   pluginContext: PluginContext,

package/src/createRedirectPageContent.ts

@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import _ from 'lodash';
 import * as eta from 'eta';
 import redirectPageTemplate from './templates/redirectPage.template.html';
-import _ from 'lodash';
 
 const getCompiledRedirectPageTemplate = _.memoize(() =>
   eta.compile(redirectPageTemplate.trim()),

package/src/index.ts

@@ -5,21 +5,20 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {LoadContext, Plugin} from '@docusaurus/types';
-import type {PluginContext, RedirectMetadata} from './types';
-import type {PluginOptions, Options} from './options';
-
+import {removePrefix, addLeadingSlash} from '@docusaurus/utils';
 import collectRedirects from './collectRedirects';
 import writeRedirectFiles, {
   toRedirectFilesMetadata,
   type RedirectFileMetadata,
 } from './writeRedirectFiles';
-import {removePrefix, addLeadingSlash} from '@docusaurus/utils';
+import type {LoadContext, Plugin} from '@docusaurus/types';
+import type {PluginContext, RedirectMetadata} from './types';
+import type {PluginOptions, Options} from './options';
 
 export default function pluginClientRedirectsPages(
   context: LoadContext,
   options: PluginOptions,
-): Plugin<unknown> {
+): Plugin<void> {
   const {trailingSlash} = context.siteConfig;
 
   return {

package/src/options.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {OptionValidationContext} from '@docusaurus/types';
 import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
+import type {OptionValidationContext} from '@docusaurus/types';
 
 export type RedirectOption = {
   to: string;
@@ -66,6 +66,6 @@ const UserOptionsSchema = Joi.object<PluginOptions>({
 export function validateOptions({
   validate,
   options: userOptions,
-}: OptionValidationContext<Options, PluginOptions>): PluginOptions {
+}: OptionValidationContext<Options | undefined, PluginOptions>): PluginOptions {
   return validate(UserOptionsSchema, userOptions);
 }

package/src/redirectValidation.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {RedirectMetadata} from './types';
 import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
+import type {RedirectMetadata} from './types';
 
 const RedirectSchema = Joi.object<RedirectMetadata>({
   from: PathnameSchema.required(),

package/src/writeRedirectFiles.ts

@@ -8,10 +8,12 @@
 import fs from 'fs-extra';
 import path from 'path';
 import _ from 'lodash';
+import logger from '@docusaurus/logger';
+import {normalizeUrl} from '@docusaurus/utils';
 
-import type {PluginContext, RedirectMetadata} from './types';
 import createRedirectPageContent from './createRedirectPageContent';
-import {normalizeUrl} from '@docusaurus/utils';
+
+import type {PluginContext, RedirectMetadata} from './types';
 
 export type WriteFilesPluginContext = Pick<PluginContext, 'baseUrl' | 'outDir'>;
 
@@ -100,9 +102,8 @@ export async function writeRedirectFile(
       {flag: 'wx'},
     );
   } catch (err) {
-    throw new Error(
-      `Redirect file creation error for "${file.fileAbsolutePath}" path: ${err}.`,
-    );
+    logger.error`Redirect file creation error for path=${file.fileAbsolutePath}.`;
+    throw err;
   }
 }