@docusaurus/logger 2.0.0-beta.19 → 2.0.0-beta.22

package/README.md

@@ -25,6 +25,7 @@ It exports a single object as default export: `logger`. `logger` has the followi
   - `warn`: prints a warning that should be payed attention to.
   - `error`: prints an error (not necessarily halting the program) that signals significant problems.
   - `success`: prints a success message.
+- The `report` function. It takes a `ReportingSeverity` value (`ignore`, `log`, `warn`, `throw`) and reports a message according to the severity.
 
 ### A word on the `error` formatter
 

package/lib/__mocks__/chalk.d.ts

@@ -0,0 +1,70 @@
+declare const _exports: {
+    (text: TemplateStringsArray, ...placeholders: unknown[]): string;
+    (...text: unknown[]): string;
+    Instance: chalk.Instance;
+    level: chalk.Level;
+    hex(color: string): chalk.Chalk;
+    keyword(color: string): chalk.Chalk;
+    rgb(red: number, green: number, blue: number): chalk.Chalk;
+    hsl(hue: number, saturation: number, lightness: number): chalk.Chalk;
+    hsv(hue: number, saturation: number, value: number): chalk.Chalk;
+    hwb(hue: number, whiteness: number, blackness: number): chalk.Chalk;
+    ansi(code: number): chalk.Chalk;
+    ansi256(index: number): chalk.Chalk;
+    bgHex(color: string): chalk.Chalk;
+    bgKeyword(color: string): chalk.Chalk;
+    bgRgb(red: number, green: number, blue: number): chalk.Chalk;
+    bgHsl(hue: number, saturation: number, lightness: number): chalk.Chalk;
+    bgHsv(hue: number, saturation: number, value: number): chalk.Chalk;
+    bgHwb(hue: number, whiteness: number, blackness: number): chalk.Chalk;
+    bgAnsi(code: number): chalk.Chalk;
+    bgAnsi256(index: number): chalk.Chalk;
+    readonly reset: chalk.Chalk;
+    readonly bold: chalk.Chalk;
+    readonly dim: chalk.Chalk;
+    readonly italic: chalk.Chalk;
+    readonly underline: chalk.Chalk;
+    readonly inverse: chalk.Chalk;
+    readonly hidden: chalk.Chalk;
+    readonly strikethrough: chalk.Chalk;
+    readonly visible: chalk.Chalk;
+    readonly black: chalk.Chalk;
+    readonly red: chalk.Chalk;
+    readonly green: chalk.Chalk;
+    readonly yellow: chalk.Chalk;
+    readonly blue: chalk.Chalk;
+    readonly magenta: chalk.Chalk;
+    readonly cyan: chalk.Chalk;
+    readonly white: chalk.Chalk;
+    readonly gray: chalk.Chalk;
+    readonly grey: chalk.Chalk;
+    readonly blackBright: chalk.Chalk;
+    readonly redBright: chalk.Chalk;
+    readonly greenBright: chalk.Chalk;
+    readonly yellowBright: chalk.Chalk;
+    readonly blueBright: chalk.Chalk;
+    readonly magentaBright: chalk.Chalk;
+    readonly cyanBright: chalk.Chalk;
+    readonly whiteBright: chalk.Chalk;
+    readonly bgBlack: chalk.Chalk;
+    readonly bgRed: chalk.Chalk;
+    readonly bgGreen: chalk.Chalk;
+    readonly bgYellow: chalk.Chalk;
+    readonly bgBlue: chalk.Chalk;
+    readonly bgMagenta: chalk.Chalk;
+    readonly bgCyan: chalk.Chalk;
+    readonly bgWhite: chalk.Chalk;
+    readonly bgGray: chalk.Chalk;
+    readonly bgGrey: chalk.Chalk;
+    readonly bgBlackBright: chalk.Chalk;
+    readonly bgRedBright: chalk.Chalk;
+    readonly bgGreenBright: chalk.Chalk;
+    readonly bgYellowBright: chalk.Chalk;
+    readonly bgBlueBright: chalk.Chalk;
+    readonly bgMagentaBright: chalk.Chalk;
+    readonly bgCyanBright: chalk.Chalk;
+    readonly bgWhiteBright: chalk.Chalk;
+};
+export = _exports;
+import chalk = require("chalk");
+//# sourceMappingURL=chalk.d.ts.map

package/lib/__mocks__/chalk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chalk.d.ts","sourceRoot":"","sources":["../../src/__mocks__/chalk.js"],"names":[],"mappings":""}

package/lib/__mocks__/chalk.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk = require('chalk');
+// Force coloring the output even in CI
+module.exports = new chalk.Instance({ level: 3 });
+//# sourceMappingURL=chalk.js.map

package/lib/__mocks__/chalk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chalk.js","sourceRoot":"","sources":["../../src/__mocks__/chalk.js"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAE/B,uCAAuC;AACvC,MAAM,CAAC,OAAO,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAC,KAAK,EAAE,CAAC,EAAC,CAAC,CAAC"}

package/lib/index.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import chalk from 'chalk';
+import type { ReportingSeverity } from '@docusaurus/types';
 declare type InterpolatableValue = string | number | (string | number)[];
 declare function interpolate(msgs: TemplateStringsArray, ...values: InterpolatableValue[]): string;
 declare function info(msg: unknown): void;
@@ -16,12 +16,27 @@ declare function error(msg: TemplateStringsArray, ...values: [InterpolatableValu
 declare function success(msg: unknown): void;
 declare function success(msg: TemplateStringsArray, ...values: [InterpolatableValue, ...InterpolatableValue[]]): void;
 declare function newLine(): void;
+/**
+ * Takes a message and reports it according to the severity that the user wants.
+ *
+ * - `ignore`: completely no-op
+ * - `log`: uses the `INFO` log level
+ * - `warn`: uses the `WARN` log level
+ * - `throw`: aborts the process, throws the error.
+ *
+ * Since the logger doesn't have logging level filters yet, these severities
+ * mostly just differ by their colors.
+ *
+ * @throws In addition to throwing when `reportingSeverity === "throw"`, this
+ * function also throws if `reportingSeverity` is not one of the above.
+ */
+declare function report(reportingSeverity: ReportingSeverity): typeof success;
 declare const logger: {
-    red: chalk.Chalk;
-    yellow: chalk.Chalk;
-    green: chalk.Chalk;
-    bold: chalk.Chalk;
-    dim: chalk.Chalk;
+    red: (msg: string | number) => string;
+    yellow: (msg: string | number) => string;
+    green: (msg: string | number) => string;
+    bold: (msg: string | number) => string;
+    dim: (msg: string | number) => string;
     path: (msg: unknown) => string;
     url: (msg: unknown) => string;
     name: (msg: unknown) => string;
@@ -33,6 +48,7 @@ declare const logger: {
     warn: typeof warn;
     error: typeof error;
     success: typeof success;
+    report: typeof report;
     newLine: typeof newLine;
 };
 export = logger;

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,aAAK,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AASjE,iBAAS,WAAW,CAClB,IAAI,EAAE,oBAAoB,EAC1B,GAAG,MAAM,EAAE,mBAAmB,EAAE,GAC/B,MAAM,CAkCR;AASD,iBAAS,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;AAClC,iBAAS,IAAI,CACX,GAAG,EAAE,oBAAoB,EACzB,GAAG,MAAM,EAAE,CAAC,mBAAmB,EAAE,GAAG,mBAAmB,EAAE,CAAC,GACzD,IAAI,CAAC;AAUR,iBAAS,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;AAClC,iBAAS,IAAI,CACX,GAAG,EAAE,oBAAoB,EACzB,GAAG,MAAM,EAAE,CAAC,mBAAmB,EAAE,GAAG,mBAAmB,EAAE,CAAC,GACzD,IAAI,CAAC;AAYR,iBAAS,KAAK,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;AACnC,iBAAS,KAAK,CACZ,GAAG,EAAE,oBAAoB,EACzB,GAAG,MAAM,EAAE,CAAC,mBAAmB,EAAE,GAAG,mBAAmB,EAAE,CAAC,GACzD,IAAI,CAAC;AAYR,iBAAS,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;AACrC,iBAAS,OAAO,CACd,GAAG,EAAE,oBAAoB,EACzB,GAAG,MAAM,EAAE,CAAC,mBAAmB,EAAE,GAAG,mBAAmB,EAAE,CAAC,GACzD,IAAI,CAAC;AAWR,iBAAS,OAAO,IAAI,IAAI,CAEvB;AAED,QAAA,MAAM,MAAM;;;;;;gBAtHO,OAAO,KAAG,MAAM;eACjB,OAAO,KAAG,MAAM;gBACf,OAAO,KAAG,MAAM;gBAChB,OAAO,KAAG,MAAM;kBACd,OAAO,KAAG,MAAM;eACnB,OAAO,KAAG,MAAM;;;;;;;CAmIjC,CAAC;AAIF,SAAS,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAEzD,aAAK,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AASjE,iBAAS,WAAW,CAClB,IAAI,EAAE,oBAAoB,EAC1B,GAAG,MAAM,EAAE,mBAAmB,EAAE,GAC/B,MAAM,CAkCR;AASD,iBAAS,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;AAClC,iBAAS,IAAI,CACX,GAAG,EAAE,oBAAoB,EACzB,GAAG,MAAM,EAAE,CAAC,mBAAmB,EAAE,GAAG,mBAAmB,EAAE,CAAC,GACzD,IAAI,CAAC;AAUR,iBAAS,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;AAClC,iBAAS,IAAI,CACX,GAAG,EAAE,oBAAoB,EACzB,GAAG,MAAM,EAAE,CAAC,mBAAmB,EAAE,GAAG,mBAAmB,EAAE,CAAC,GACzD,IAAI,CAAC;AAYR,iBAAS,KAAK,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;AACnC,iBAAS,KAAK,CACZ,GAAG,EAAE,oBAAoB,EACzB,GAAG,MAAM,EAAE,CAAC,mBAAmB,EAAE,GAAG,mBAAmB,EAAE,CAAC,GACzD,IAAI,CAAC;AAYR,iBAAS,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;AACrC,iBAAS,OAAO,CACd,GAAG,EAAE,oBAAoB,EACzB,GAAG,MAAM,EAAE,CAAC,mBAAmB,EAAE,GAAG,mBAAmB,EAAE,CAAC,GACzD,IAAI,CAAC;AAuBR,iBAAS,OAAO,IAAI,IAAI,CAEvB;AAED;;;;;;;;;;;;;GAaG;AACH,iBAAS,MAAM,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,OAAO,OAAO,CAepE;AAED,QAAA,MAAM,MAAM;eACC,MAAM,GAAG,MAAM,KAAG,MAAM;kBACrB,MAAM,GAAG,MAAM,KAAG,MAAM;iBACzB,MAAM,GAAG,MAAM,KAAG,MAAM;gBACzB,MAAM,GAAG,MAAM,KAAG,MAAM;eACzB,MAAM,GAAG,MAAM,KAAG,MAAM;gBAtKlB,OAAO,KAAG,MAAM;eACjB,OAAO,KAAG,MAAM;gBACf,OAAO,KAAG,MAAM;gBAChB,OAAO,KAAG,MAAM;kBACd,OAAO,KAAG,MAAM;eACnB,OAAO,KAAG,MAAM;;;;;;;;CA+KjC,CAAC;AAIF,SAAS,MAAM,CAAC"}

package/lib/index.js

@@ -7,10 +7,10 @@
  */
 const tslib_1 = require("tslib");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const path = (msg) => chalk_1.default.cyan.underline(`"${msg}"`);
+const path = (msg) => chalk_1.default.cyan.underline(`"${String(msg)}"`);
 const url = (msg) => chalk_1.default.cyan.underline(msg);
 const name = (msg) => chalk_1.default.blue.bold(msg);
-const code = (msg) => chalk_1.default.cyan(`\`${msg}\``);
+const code = (msg) => chalk_1.default.cyan(`\`${String(msg)}\``);
 const subdue = (msg) => chalk_1.default.gray(msg);
 const num = (msg) => chalk_1.default.yellow(msg);
 function interpolate(msgs, ...values) {
@@ -72,15 +72,46 @@ function success(msg, ...values) {
         ? stringify(msg)
         : interpolate(msg, ...values)}`);
 }
+function throwError(msg, ...values) {
+    throw new Error(values.length === 0
+        ? stringify(msg)
+        : interpolate(msg, ...values));
+}
 function newLine() {
     console.log();
 }
+/**
+ * Takes a message and reports it according to the severity that the user wants.
+ *
+ * - `ignore`: completely no-op
+ * - `log`: uses the `INFO` log level
+ * - `warn`: uses the `WARN` log level
+ * - `throw`: aborts the process, throws the error.
+ *
+ * Since the logger doesn't have logging level filters yet, these severities
+ * mostly just differ by their colors.
+ *
+ * @throws In addition to throwing when `reportingSeverity === "throw"`, this
+ * function also throws if `reportingSeverity` is not one of the above.
+ */
+function report(reportingSeverity) {
+    const reportingMethods = {
+        ignore: () => { },
+        log: info,
+        warn,
+        throw: throwError,
+    };
+    if (!Object.prototype.hasOwnProperty.call(reportingMethods, reportingSeverity)) {
+        throw new Error(`Unexpected "reportingSeverity" value: ${reportingSeverity}.`);
+    }
+    return reportingMethods[reportingSeverity];
+}
 const logger = {
-    red: chalk_1.default.red,
-    yellow: chalk_1.default.yellow,
-    green: chalk_1.default.green,
-    bold: chalk_1.default.bold,
-    dim: chalk_1.default.dim,
+    red: (msg) => chalk_1.default.red(msg),
+    yellow: (msg) => chalk_1.default.yellow(msg),
+    green: (msg) => chalk_1.default.green(msg),
+    bold: (msg) => chalk_1.default.bold(msg),
+    dim: (msg) => chalk_1.default.dim(msg),
     path,
     url,
     name,
@@ -92,6 +123,7 @@ const logger = {
     warn,
     error,
     success,
+    report,
     newLine,
 };
 module.exports = logger;

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,0DAA0B;AAI1B,MAAM,IAAI,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;AACxE,MAAM,GAAG,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAChE,MAAM,IAAI,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC5D,MAAM,IAAI,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;AAChE,MAAM,MAAM,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzD,MAAM,GAAG,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAExD,SAAS,WAAW,CAClB,IAA0B,EAC1B,GAAG,MAA6B;IAEhC,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1C,GAAG,IAAI,IAAI,CAAC,GAAG,CAAE,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,IAAI,EAAE;gBACT,OAAO,CAAC,CAAkB,EAAE,EAAE,CAAC,CAAC,CAAC;aAClC;YACD,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE;gBACf,KAAK,OAAO;oBACV,OAAO,IAAI,CAAC;gBACd,KAAK,MAAM;oBACT,OAAO,GAAG,CAAC;gBACb,KAAK,SAAS;oBACZ,OAAO,GAAG,CAAC;gBACb,KAAK,OAAO;oBACV,OAAO,IAAI,CAAC;gBACd,KAAK,SAAS;oBACZ,OAAO,MAAM,CAAC;gBAChB,KAAK,OAAO;oBACV,OAAO,IAAI,CAAC;gBACd;oBACE,MAAM,IAAI,KAAK,CACb,mFAAmF,CACpF,CAAC;aACL;QACH,CAAC,CAAC,EAAE,CAAC;QACL,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YACzB,CAAC,CAAC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACnD,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;IACH,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,SAAS,CAAC,GAAY;IAC7B,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,iBAAiB,EAAE;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;KAC5B;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAOD,SAAS,IAAI,CAAC,GAAY,EAAE,GAAG,MAA6B;IAC1D,OAAO,CAAC,IAAI,CACV,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAC1B,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CACxD,EAAE,CACH,CAAC;AACJ,CAAC;AAMD,SAAS,IAAI,CAAC,GAAY,EAAE,GAAG,MAA6B;IAC1D,OAAO,CAAC,IAAI,CACV,eAAK,CAAC,MAAM,CACV,GAAG,eAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IACxB,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CACxD,EAAE,CACH,CACF,CAAC;AACJ,CAAC;AAMD,SAAS,KAAK,CAAC,GAAY,EAAE,GAAG,MAA6B;IAC3D,OAAO,CAAC,KAAK,CACX,eAAK,CAAC,GAAG,CACP,GAAG,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IACtB,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CACxD,EAAE,CACH,CACF,CAAC;AACJ,CAAC;AAMD,SAAS,OAAO,CAAC,GAAY,EAAE,GAAG,MAA6B;IAC7D,OAAO,CAAC,GAAG,CACT,GAAG,eAAK,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAC9B,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CACxD,EAAE,CACH,CAAC;AACJ,CAAC;AAED,SAAS,OAAO;IACd,OAAO,CAAC,GAAG,EAAE,CAAC;AAChB,CAAC;AAED,MAAM,MAAM,GAAG;IACb,GAAG,EAAE,eAAK,CAAC,GAAG;IACd,MAAM,EAAE,eAAK,CAAC,MAAM;IACpB,KAAK,EAAE,eAAK,CAAC,KAAK;IAClB,IAAI,EAAE,eAAK,CAAC,IAAI;IAChB,GAAG,EAAE,eAAK,CAAC,GAAG;IACd,IAAI;IACJ,GAAG;IACH,IAAI;IACJ,IAAI;IACJ,MAAM;IACN,GAAG;IACH,WAAW;IACX,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,OAAO;IACP,OAAO;CACR,CAAC;AAIF,iBAAS,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,0DAA0B;AAK1B,MAAM,IAAI,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAChF,MAAM,GAAG,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAChE,MAAM,IAAI,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC5D,MAAM,IAAI,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACxE,MAAM,MAAM,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzD,MAAM,GAAG,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAExD,SAAS,WAAW,CAClB,IAA0B,EAC1B,GAAG,MAA6B;IAEhC,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1C,GAAG,IAAI,IAAI,CAAC,GAAG,CAAE,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,IAAI,EAAE;gBACT,OAAO,CAAC,CAAkB,EAAE,EAAE,CAAC,CAAC,CAAC;aAClC;YACD,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE;gBACf,KAAK,OAAO;oBACV,OAAO,IAAI,CAAC;gBACd,KAAK,MAAM;oBACT,OAAO,GAAG,CAAC;gBACb,KAAK,SAAS;oBACZ,OAAO,GAAG,CAAC;gBACb,KAAK,OAAO;oBACV,OAAO,IAAI,CAAC;gBACd,KAAK,SAAS;oBACZ,OAAO,MAAM,CAAC;gBAChB,KAAK,OAAO;oBACV,OAAO,IAAI,CAAC;gBACd;oBACE,MAAM,IAAI,KAAK,CACb,mFAAmF,CACpF,CAAC;aACL;QACH,CAAC,CAAC,EAAE,CAAC;QACL,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YACzB,CAAC,CAAC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACnD,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;IACH,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,SAAS,CAAC,GAAY;IAC7B,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,iBAAiB,EAAE;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;KAC5B;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAOD,SAAS,IAAI,CAAC,GAAY,EAAE,GAAG,MAA6B;IAC1D,OAAO,CAAC,IAAI,CACV,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAC1B,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CACxD,EAAE,CACH,CAAC;AACJ,CAAC;AAMD,SAAS,IAAI,CAAC,GAAY,EAAE,GAAG,MAA6B;IAC1D,OAAO,CAAC,IAAI,CACV,eAAK,CAAC,MAAM,CACV,GAAG,eAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IACxB,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CACxD,EAAE,CACH,CACF,CAAC;AACJ,CAAC;AAMD,SAAS,KAAK,CAAC,GAAY,EAAE,GAAG,MAA6B;IAC3D,OAAO,CAAC,KAAK,CACX,eAAK,CAAC,GAAG,CACP,GAAG,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IACtB,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CACxD,EAAE,CACH,CACF,CAAC;AACJ,CAAC;AAMD,SAAS,OAAO,CAAC,GAAY,EAAE,GAAG,MAA6B;IAC7D,OAAO,CAAC,GAAG,CACT,GAAG,eAAK,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAC9B,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CACxD,EAAE,CACH,CAAC;AACJ,CAAC;AAMD,SAAS,UAAU,CAAC,GAAY,EAAE,GAAG,MAA6B;IAChE,MAAM,IAAI,KAAK,CACb,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CAAC,CACxD,CAAC;AACJ,CAAC;AAED,SAAS,OAAO;IACd,OAAO,CAAC,GAAG,EAAE,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,MAAM,CAAC,iBAAoC;IAClD,MAAM,gBAAgB,GAAG;QACvB,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;QAChB,GAAG,EAAE,IAAI;QACT,IAAI;QACJ,KAAK,EAAE,UAAU;KAClB,CAAC;IACF,IACE,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,EAC1E;QACA,MAAM,IAAI,KAAK,CACb,yCAAyC,iBAAiB,GAAG,CAC9D,CAAC;KACH;IACD,OAAO,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,MAAM,GAAG;IACb,GAAG,EAAE,CAAC,GAAoB,EAAU,EAAE,CAAC,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC;IACrD,MAAM,EAAE,CAAC,GAAoB,EAAU,EAAE,CAAC,eAAK,CAAC,MAAM,CAAC,GAAG,CAAC;IAC3D,KAAK,EAAE,CAAC,GAAoB,EAAU,EAAE,CAAC,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC;IACzD,IAAI,EAAE,CAAC,GAAoB,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC;IACvD,GAAG,EAAE,CAAC,GAAoB,EAAU,EAAE,CAAC,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC;IACrD,IAAI;IACJ,GAAG;IACH,IAAI;IACJ,IAAI;IACJ,MAAM;IACN,GAAG;IACH,WAAW;IACX,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,OAAO;IACP,MAAM;IACN,OAAO;CACR,CAAC;AAIF,iBAAS,MAAM,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/logger",
-  "version": "2.0.0-beta.19",
+  "version": "2.0.0-beta.22",
   "description": "An encapsulated logger for semantically formatting console messages.",
   "main": "./lib/index.js",
   "repository": {
@@ -24,10 +24,10 @@
     "tslib": "^2.4.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16.14"
   },
   "devDependencies": {
     "@types/supports-color": "^8.1.1"
   },
-  "gitHead": "a71e60a49cce93c1006ef10c41ac03187f057102"
+  "gitHead": "daf9e462c4eebb7ac26a940932311f987e768f87"
 }

package/src/index.ts

@@ -6,13 +6,14 @@
  */
 
 import chalk from 'chalk';
+import type {ReportingSeverity} from '@docusaurus/types';
 
 type InterpolatableValue = string | number | (string | number)[];
 
-const path = (msg: unknown): string => chalk.cyan.underline(`"${msg}"`);
+const path = (msg: unknown): string => chalk.cyan.underline(`"${String(msg)}"`);
 const url = (msg: unknown): string => chalk.cyan.underline(msg);
 const name = (msg: unknown): string => chalk.blue.bold(msg);
-const code = (msg: unknown): string => chalk.cyan(`\`${msg}\``);
+const code = (msg: unknown): string => chalk.cyan(`\`${String(msg)}\``);
 const subdue = (msg: unknown): string => chalk.gray(msg);
 const num = (msg: unknown): string => chalk.yellow(msg);
 
@@ -122,17 +123,60 @@ function success(msg: unknown, ...values: InterpolatableValue[]): void {
     }`,
   );
 }
+function throwError(msg: unknown): void;
+function throwError(
+  msg: TemplateStringsArray,
+  ...values: [InterpolatableValue, ...InterpolatableValue[]]
+): void;
+function throwError(msg: unknown, ...values: InterpolatableValue[]): void {
+  throw new Error(
+    values.length === 0
+      ? stringify(msg)
+      : interpolate(msg as TemplateStringsArray, ...values),
+  );
+}
 
 function newLine(): void {
   console.log();
 }
 
+/**
+ * Takes a message and reports it according to the severity that the user wants.
+ *
+ * - `ignore`: completely no-op
+ * - `log`: uses the `INFO` log level
+ * - `warn`: uses the `WARN` log level
+ * - `throw`: aborts the process, throws the error.
+ *
+ * Since the logger doesn't have logging level filters yet, these severities
+ * mostly just differ by their colors.
+ *
+ * @throws In addition to throwing when `reportingSeverity === "throw"`, this
+ * function also throws if `reportingSeverity` is not one of the above.
+ */
+function report(reportingSeverity: ReportingSeverity): typeof success {
+  const reportingMethods = {
+    ignore: () => {},
+    log: info,
+    warn,
+    throw: throwError,
+  };
+  if (
+    !Object.prototype.hasOwnProperty.call(reportingMethods, reportingSeverity)
+  ) {
+    throw new Error(
+      `Unexpected "reportingSeverity" value: ${reportingSeverity}.`,
+    );
+  }
+  return reportingMethods[reportingSeverity];
+}
+
 const logger = {
-  red: chalk.red,
-  yellow: chalk.yellow,
-  green: chalk.green,
-  bold: chalk.bold,
-  dim: chalk.dim,
+  red: (msg: string | number): string => chalk.red(msg),
+  yellow: (msg: string | number): string => chalk.yellow(msg),
+  green: (msg: string | number): string => chalk.green(msg),
+  bold: (msg: string | number): string => chalk.bold(msg),
+  dim: (msg: string | number): string => chalk.dim(msg),
   path,
   url,
   name,
@@ -144,6 +188,7 @@ const logger = {
   warn,
   error,
   success,
+  report,
   newLine,
 };