@docusaurus/logger 0.0.0-4946 → 0.0.0-4952
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -6
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +0 -5
- package/lib/index.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +1 -4
package/README.md
CHANGED
|
@@ -7,20 +7,33 @@ An encapsulated logger for semantically formatting console messages.
|
|
|
7
7
|
It exports a single object as default export: `logger`. `logger` has the following properties:
|
|
8
8
|
|
|
9
9
|
- Some useful colors.
|
|
10
|
-
-
|
|
10
|
+
- `red`
|
|
11
|
+
- `yellow`
|
|
12
|
+
- `green`
|
|
13
|
+
- `bold`
|
|
14
|
+
- `dim`
|
|
15
|
+
- Formatters. These functions all have the signature `(msg: unknown) => string`. Note that their implementations are not guaranteed. You should only care about their semantics.
|
|
11
16
|
- `path`: formats a file path.
|
|
12
17
|
- `url`: formats a URL.
|
|
13
|
-
- `
|
|
18
|
+
- `name`: formats an identifier.
|
|
14
19
|
- `code`: formats a code snippet.
|
|
15
20
|
- `subdue`: subdues the text.
|
|
16
21
|
- `num`: formats a number.
|
|
17
|
-
- The `interpolate` function. It is a template literal tag.
|
|
18
|
-
- Logging functions. All logging functions can both be used as functions (
|
|
22
|
+
- The `interpolate` function. It is a template literal tag. The syntax can be found below.
|
|
23
|
+
- Logging functions. All logging functions can both be used as normal functions (similar to the `console.log` family, but only accepts one parameter) or template literal tags.
|
|
19
24
|
- `info`: prints information.
|
|
20
25
|
- `warn`: prints a warning that should be payed attention to.
|
|
21
26
|
- `error`: prints an error (not necessarily halting the program) that signals significant problems.
|
|
22
27
|
- `success`: prints a success message.
|
|
23
28
|
|
|
29
|
+
### A word on the `error` formatter
|
|
30
|
+
|
|
31
|
+
Beware that an `error` message, even when it doesn't hang the program, is likely going to cause confusion. When users inspect logs and find an `[ERROR]`, even when the build succeeds, they will assume something is going wrong. Use it sparingly.
|
|
32
|
+
|
|
33
|
+
Docusaurus only uses `logger.error` when printing messages immediately before throwing an error, or when user has set the reporting severity of `onBrokenLink`, etc. to `"error"`.
|
|
34
|
+
|
|
35
|
+
In addition, `warn` and `error` will color the **entire** message for better attention. If you are printing large blocks of help text about an error, better use `logger.info`.
|
|
36
|
+
|
|
24
37
|
### Using the template literal tag
|
|
25
38
|
|
|
26
39
|
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:
|
|
@@ -32,11 +45,11 @@ logger.info`Hello name=${name}! You have number=${money} dollars. Here are the $
|
|
|
32
45
|
To buy anything, enter code=${'buy x'} where code=${'x'} is the item's name; to quit, press code=${'Ctrl + C'}.`;
|
|
33
46
|
```
|
|
34
47
|
|
|
35
|
-
An embedded expression is optionally preceded by a flag in the form
|
|
48
|
+
An embedded expression is optionally preceded by a flag in the form `[a-z]+=` (a few lowercase letters, followed by an equals sign, directly preceding the embedded expression). If the expression is not preceded by any flag, it's printed out as-is. Otherwise, it's formatted with one of the formatters:
|
|
36
49
|
|
|
37
50
|
- `path=`: `path`
|
|
38
51
|
- `url=`: `url`
|
|
39
|
-
- `name=`: `
|
|
52
|
+
- `name=`: `name`
|
|
40
53
|
- `code=`: `code`
|
|
41
54
|
- `subdue=`: `subdue`
|
|
42
55
|
- `number=`: `num`
|
package/lib/index.d.ts
CHANGED
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +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;
|
|
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"}
|
package/lib/index.js
CHANGED
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
* This source code is licensed under the MIT license found in the
|
|
6
6
|
* LICENSE file in the root directory of this source tree.
|
|
7
7
|
*/
|
|
8
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
8
|
const tslib_1 = require("tslib");
|
|
10
9
|
const chalk_1 = tslib_1.__importDefault(require("chalk"));
|
|
11
10
|
const path = (msg) => chalk_1.default.cyan.underline(`"${msg}"`);
|
|
@@ -95,9 +94,5 @@ const logger = {
|
|
|
95
94
|
success,
|
|
96
95
|
newLine,
|
|
97
96
|
};
|
|
98
|
-
// TODO remove when migrating to ESM
|
|
99
|
-
// logger can only be default-imported in ESM with this
|
|
100
97
|
module.exports = logger;
|
|
101
|
-
module.exports.default = logger;
|
|
102
|
-
exports.default = logger;
|
|
103
98
|
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/logger",
|
|
3
|
-
"version": "0.0.0-
|
|
3
|
+
"version": "0.0.0-4952",
|
|
4
4
|
"description": "An encapsulated logger for semantically formatting console messages.",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"repository": {
|
|
@@ -29,5 +29,5 @@
|
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@types/supports-color": "^8.1.1"
|
|
31
31
|
},
|
|
32
|
-
"gitHead": "
|
|
32
|
+
"gitHead": "a6c2ca088235cebecbb1a14b9df8cd2dfc54b8a1"
|
|
33
33
|
}
|
package/src/index.ts
CHANGED