@docusaurus/logger 0.0.0-4297

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Facebook, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# `@docusaurus/logger`
+
+An encapsulated logger for semantically formatting console messages.
+
+## APIs
+
+It exports a single object as default export: `logger`. `logger` has the following properties:
+
+- Some useful colors.
+- Formatters. These functions have the same signature as the formatters of `picocolors`. Note that their implementations are not guaranteed. You should only care about their semantics.
+  - `path`: formats a file path or URL.
+  - `id`: formats an identifier.
+  - `code`: formats a code snippet.
+  - `subdue`: subdues the text.
+  - `num`: formats a number.
+- The `interpolate` function. It is a template literal tag.
+- Logging functions. All logging functions can both be used as functions (in which it has the same usage as `console.log`) or template literal tags.
+  - `info`: prints information.
+  - `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.
+
+### Using the template literal tag
+
+The template literal tag evaluates the template and expressions embedded. `interpolate` returns a new string, while other logging functions prints it. Below is a typical usage:
+
+```js
+logger.info`Hello name=${name}! You have number=${money} dollars. Here are the ${
+  items.length > 1 ? 'items' : 'item'
+} on the shelf: ${items}
+To buy anything, enter code=${'buy x'} where code=${'x'} is the item's name; to quit, press code=${'Ctrl + C'}.`;
+```
+
+An embedded expression is optionally preceded by a flag in the form `%[a-z]+` (a percentage sign followed by a few lowercase letters). If it's not preceded by any flag, it's printed out as-is. Otherwise, it's formatted with one of the formatters:
+
+- `path=`: `path`
+- `name=`: `id`
+- `code=`: `code`
+- `subdue=`: `subdue`
+- `number=`: `num`
+
+If the expression is an array, it's formatted by `` `\n- ${array.join('\n- ')}\n` `` (note it automatically gets a leading line end). Each member is formatted by itself and the bullet is not formatted. So you would see the above message printed as:
+
+![demo](./demo.png)

package/lib/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+import chalk from 'chalk';
+declare type InterpolatableValue = string | number | (string | number)[];
+declare function interpolate(msgs: TemplateStringsArray, ...values: InterpolatableValue[]): string;
+declare function info(msg: unknown): void;
+declare function info(msg: TemplateStringsArray, ...values: [InterpolatableValue, ...InterpolatableValue[]]): void;
+declare function warn(msg: unknown): void;
+declare function warn(msg: TemplateStringsArray, ...values: [InterpolatableValue, ...InterpolatableValue[]]): void;
+declare function error(msg: unknown): void;
+declare function error(msg: TemplateStringsArray, ...values: [InterpolatableValue, ...InterpolatableValue[]]): void;
+declare function success(msg: unknown): void;
+declare function success(msg: TemplateStringsArray, ...values: [InterpolatableValue, ...InterpolatableValue[]]): void;
+declare const logger: {
+    red: chalk.Chalk;
+    yellow: chalk.Chalk;
+    green: chalk.Chalk;
+    bold: chalk.Chalk;
+    dim: chalk.Chalk;
+    path: (msg: unknown) => string;
+    name: (msg: unknown) => string;
+    code: (msg: unknown) => string;
+    subdue: chalk.Chalk;
+    num: chalk.Chalk;
+    interpolate: typeof interpolate;
+    info: typeof info;
+    warn: typeof warn;
+    error: typeof error;
+    success: typeof success;
+};
+export default logger;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAc,MAAM,OAAO,CAAC;AAEnC,aAAK,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AAQjE,iBAAS,WAAW,CAClB,IAAI,EAAE,oBAAoB,EAC1B,GAAG,MAAM,EAAE,mBAAmB,EAAE,GAC/B,MAAM,CAgCR;AAED,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,QAAA,MAAM,MAAM;;;;;;gBAxGO,OAAO,KAAG,MAAM;gBAChB,OAAO,KAAG,MAAM;gBAChB,OAAO,KAAG,MAAM;;;;;;;;CAsHlC,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/lib/index.js

@@ -0,0 +1,85 @@
+"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 tslib_1 = require("tslib");
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const path = (msg) => chalk_1.default.cyan(chalk_1.default.underline(msg));
+const name = (msg) => chalk_1.default.blue(chalk_1.default.bold(msg));
+const code = (msg) => chalk_1.default.cyan(`\`${msg}\``);
+const subdue = chalk_1.default.gray;
+const num = chalk_1.default.yellow;
+function interpolate(msgs, ...values) {
+    let res = '';
+    values.forEach((value, idx) => {
+        const flag = msgs[idx].match(/[a-z]+=$/);
+        res += msgs[idx].replace(/[a-z]+=$/, '');
+        const format = (function () {
+            if (!flag) {
+                return (a) => a;
+            }
+            switch (flag[0]) {
+                case 'path=':
+                    return path;
+                case 'number=':
+                    return num;
+                case 'name=':
+                    return name;
+                case 'subdue=':
+                    return subdue;
+                case 'code=':
+                    return code;
+                default:
+                    throw new Error('Bad Docusaurus logging message. This is likely an internal bug, please report it.');
+            }
+        })();
+        res += Array.isArray(value)
+            ? `\n- ${value.map((v) => format(v)).join('\n- ')}`
+            : format(value);
+    });
+    res += msgs.slice(-1)[0];
+    return res;
+}
+function info(msg, ...values) {
+    console.info(`${chalk_1.default.cyan(chalk_1.default.bold('[INFO]'))} ${values.length === 0
+        ? msg
+        : interpolate(msg, ...values)}`);
+}
+function warn(msg, ...values) {
+    console.warn(chalk_1.default.yellow(`${chalk_1.default.bold('[WARNING]')} ${values.length === 0
+        ? msg
+        : interpolate(msg, ...values)}`));
+}
+function error(msg, ...values) {
+    console.error(chalk_1.default.red(`${chalk_1.default.bold('[ERROR]')} ${values.length === 0
+        ? msg
+        : interpolate(msg, ...values)}`));
+}
+function success(msg, ...values) {
+    console.log(`${chalk_1.default.green(chalk_1.default.bold('[SUCCESS]'))} ${values.length === 0
+        ? msg
+        : interpolate(msg, ...values)}`);
+}
+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,
+    path,
+    name,
+    code,
+    subdue,
+    num,
+    interpolate,
+    info,
+    warn,
+    error,
+    success,
+};
+exports.default = logger;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+DAAmC;AAInC,MAAM,IAAI,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AACxE,MAAM,IAAI,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACnE,MAAM,IAAI,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;AAChE,MAAM,MAAM,GAAU,eAAK,CAAC,IAAI,CAAC;AACjC,MAAM,GAAG,GAAU,eAAK,CAAC,MAAM,CAAC;AAEhC,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,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACzC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,CAAC;YACd,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,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;AAOD,SAAS,IAAI,CAAC,GAAY,EAAE,GAAG,MAA6B;IAC1D,OAAO,CAAC,IAAI,CACV,GAAG,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IACjC,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,GAAG;QACL,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,GAAG;QACL,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,GAAG;QACL,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,eAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IACrC,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,GAAG;QACL,CAAC,CAAC,WAAW,CAAC,GAA2B,EAAE,GAAG,MAAM,CACxD,EAAE,CACH,CAAC;AACJ,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,IAAI;IACJ,IAAI;IACJ,MAAM;IACN,GAAG;IACH,WAAW;IACX,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,OAAO;CACR,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@docusaurus/logger",
+  "version": "0.0.0-4297",
+  "description": "An encapsulated logger for semantically formatting console messages.",
+  "main": "./lib/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-logger"
+  },
+  "bugs": {
+    "url": "https://github.com/facebook/docusaurus/issues"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "tslib": "^2.3.1"
+  },
+  "engines": {
+    "node": ">=14"
+  },
+  "devDependencies": {
+    "@types/supports-color": "^8.1.1"
+  },
+  "gitHead": "84ae34c33c664bf856f3a92047919a074e087d77"
+}

package/src/__mocks__/chalk.js

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+
+const chalk = require('chalk');
+
+// Force coloring the output even in CI
+module.exports = new chalk.Instance({level: 3});

package/src/index.ts

@@ -0,0 +1,134 @@
+/**
+ * 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.
+ */
+
+import chalk, {Chalk} from 'chalk';
+
+type InterpolatableValue = string | number | (string | number)[];
+
+const path = (msg: unknown): string => chalk.cyan(chalk.underline(msg));
+const name = (msg: unknown): string => chalk.blue(chalk.bold(msg));
+const code = (msg: unknown): string => chalk.cyan(`\`${msg}\``);
+const subdue: Chalk = chalk.gray;
+const num: Chalk = chalk.yellow;
+
+function interpolate(
+  msgs: TemplateStringsArray,
+  ...values: InterpolatableValue[]
+): string {
+  let res = '';
+  values.forEach((value, idx) => {
+    const flag = msgs[idx].match(/[a-z]+=$/);
+    res += msgs[idx].replace(/[a-z]+=$/, '');
+    const format = (function () {
+      if (!flag) {
+        return (a: string | number) => a;
+      }
+      switch (flag[0]) {
+        case 'path=':
+          return path;
+        case 'number=':
+          return num;
+        case 'name=':
+          return name;
+        case 'subdue=':
+          return subdue;
+        case 'code=':
+          return code;
+        default:
+          throw new Error(
+            'Bad Docusaurus logging message. This is likely an internal bug, please report it.',
+          );
+      }
+    })();
+    res += Array.isArray(value)
+      ? `\n- ${value.map((v) => format(v)).join('\n- ')}`
+      : format(value);
+  });
+  res += msgs.slice(-1)[0];
+  return res;
+}
+
+function info(msg: unknown): void;
+function info(
+  msg: TemplateStringsArray,
+  ...values: [InterpolatableValue, ...InterpolatableValue[]]
+): void;
+function info(msg: unknown, ...values: InterpolatableValue[]): void {
+  console.info(
+    `${chalk.cyan(chalk.bold('[INFO]'))} ${
+      values.length === 0
+        ? msg
+        : interpolate(msg as TemplateStringsArray, ...values)
+    }`,
+  );
+}
+function warn(msg: unknown): void;
+function warn(
+  msg: TemplateStringsArray,
+  ...values: [InterpolatableValue, ...InterpolatableValue[]]
+): void;
+function warn(msg: unknown, ...values: InterpolatableValue[]): void {
+  console.warn(
+    chalk.yellow(
+      `${chalk.bold('[WARNING]')} ${
+        values.length === 0
+          ? msg
+          : interpolate(msg as TemplateStringsArray, ...values)
+      }`,
+    ),
+  );
+}
+function error(msg: unknown): void;
+function error(
+  msg: TemplateStringsArray,
+  ...values: [InterpolatableValue, ...InterpolatableValue[]]
+): void;
+function error(msg: unknown, ...values: InterpolatableValue[]): void {
+  console.error(
+    chalk.red(
+      `${chalk.bold('[ERROR]')} ${
+        values.length === 0
+          ? msg
+          : interpolate(msg as TemplateStringsArray, ...values)
+      }`,
+    ),
+  );
+}
+function success(msg: unknown): void;
+function success(
+  msg: TemplateStringsArray,
+  ...values: [InterpolatableValue, ...InterpolatableValue[]]
+): void;
+function success(msg: unknown, ...values: InterpolatableValue[]): void {
+  console.log(
+    `${chalk.green(chalk.bold('[SUCCESS]'))} ${
+      values.length === 0
+        ? msg
+        : interpolate(msg as TemplateStringsArray, ...values)
+    }`,
+  );
+}
+
+const logger = {
+  red: chalk.red,
+  yellow: chalk.yellow,
+  green: chalk.green,
+  bold: chalk.bold,
+  dim: chalk.dim,
+  path,
+  name,
+  code,
+  subdue,
+  num,
+  interpolate,
+  info,
+  warn,
+  error,
+  success,
+};
+
+export default logger;