rslog 0.1.1 → 1.0.0-beta.1

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -9,8 +9,7 @@ A tiny, intuitive, type-friendly logger for Node.js.
9
9
 
10
10
  ## Preview
11
11
 
12
- ![Artboard](https://github.com/rspack-contrib/rslog/assets/7237365/410e19c3-04c9-48e7-a05b-e358b138f79c)
13
-
12
+ ![Artboard](https://github.com/rspack-contrib/rslog/assets/7237365/436d6364-550d-4e0d-bc0f-9df1327c46b3)
14
13
 
15
14
  ## Install
16
15
 
@@ -43,18 +42,18 @@ import { logger } from 'rslog';
43
42
  - Log:
44
43
 
45
44
  ```js
46
- // Same as console.log
47
- logger.log('This is a log message');
45
+ // A gradient welcome log
46
+ logger.greet(`\n➜ Rslog v1.0.0\n`);
48
47
 
49
48
  // Info
50
49
  logger.info('This is a info message');
51
50
 
51
+ // Start
52
+ logger.start('This is a start message');
53
+
52
54
  // Warn
53
55
  logger.warn('This is a warn message');
54
56
 
55
- // Debug
56
- logger.debug('This is a debug message');
57
-
58
57
  // Ready
59
58
  logger.ready('This is a ready message');
60
59
 
@@ -64,4 +63,46 @@ logger.success('This is a success message');
64
63
  // Error
65
64
  logger.error('This is a error message');
66
65
  logger.error(new Error('This is a error message with stack'));
66
+
67
+ // Debug
68
+ logger.debug('This is a debug message');
69
+
70
+ // Same as console.log
71
+ logger.log('This is a log message');
67
72
  ```
73
+
74
+ ## Log Level
75
+
76
+ You can create a new logger instance through `createLogger` and specify the log level:
77
+
78
+ ```js
79
+ const { createLogger } = require('rslog');
80
+
81
+ const logger = createLogger({ level: 'warn' });
82
+
83
+ // Will print
84
+ logger.error('This is a error message');
85
+ logger.warn('This is a warn message');
86
+
87
+ // Will not print
88
+ logger.info('This is a info message');
89
+ logger.log('This is a log message');
90
+ ```
91
+
92
+ The log levels of each method are as follows:
93
+
94
+ | Level | Method |
95
+ | ------- | ----------------------------------- |
96
+ | error | `error` |
97
+ | warn | `warn` |
98
+ | info | `info`, `start`, `ready`, `success` |
99
+ | log | `log` |
100
+ | verbose | `debug` |
101
+
102
+ ## Credits
103
+
104
+ The color implementation of Rslog are modified from [alexeyraspopov/picocolors](https://github.com/alexeyraspopov/picocolors).
105
+
106
+ ## License
107
+
108
+ Rslog is [MIT licensed](https://github.com/rspack-contrib/rslog/blob/main/LICENSE).
@@ -0,0 +1,166 @@
1
+ // src/utils.ts
2
+ var C = /^\s*at\s.*:\d+:\d+[\s)]*$/;
3
+ var h = /^\s*at\s.*\(<anonymous>\)$/;
4
+ var L = (t) => C.test(t) || h.test(t);
5
+ var { env: f } = process;
6
+ var a = !("NO_COLOR" in f) && ("FORCE_COLOR" in f || process.platform === "win32" || process.stdout.isTTY && f.TERM !== "dumb" || "CI" in f);
7
+
8
+ // src/color.ts
9
+ var m = (t, l, n = t) => (i) => {
10
+ let e = "" + i;
11
+ let r = e.indexOf(l, t.length);
12
+ return ~r ? t + y(e, l, n, r) + l : t + e + l;
13
+ };
14
+ var y = (t, l, n, i) => {
15
+ let e = t.substring(0, i) + n;
16
+ let r = t.substring(i + l.length);
17
+ let p = r.indexOf(l);
18
+ return ~p ? e + y(r, l, n, p) : e + r;
19
+ };
20
+ var o = {
21
+ bold: a ? m("\x1B[1m", "\x1B[22m", "\x1B[22m\x1B[1m") : String,
22
+ red: a ? m("\x1B[31m", "\x1B[39m") : String,
23
+ green: a ? m("\x1B[32m", "\x1B[39m") : String,
24
+ yellow: a ? m("\x1B[33m", "\x1B[39m") : String,
25
+ magenta: a ? m("\x1B[35m", "\x1B[39m") : String,
26
+ cyan: a ? m("\x1B[36m", "\x1B[39m") : String,
27
+ gray: a ? m("\x1B[90m", "\x1B[39m") : String
28
+ };
29
+
30
+ // src/gradient.ts
31
+ var s = [
32
+ 189,
33
+ 255,
34
+ 243
35
+ ];
36
+ var E = [
37
+ 74,
38
+ 194,
39
+ 154
40
+ ];
41
+ function O(t) {
42
+ if (!a) {
43
+ return t;
44
+ }
45
+ let l = t.length;
46
+ let n = [
47
+ (E[0] - s[0]) / l,
48
+ (E[1] - s[1]) / l,
49
+ (E[2] - s[2]) / l
50
+ ];
51
+ let i = "";
52
+ for (let e = 0; e < l; e++) {
53
+ let r = Math.round(s[0] + n[0] * e);
54
+ let p = Math.round(s[1] + n[1] * e);
55
+ let c = Math.round(s[2] + n[2] * e);
56
+ let g = `\x1B[38;2;${r};${p};${c}m`;
57
+ let b = "\x1B[0m";
58
+ i += `${g}${t[e]}${b}`;
59
+ }
60
+ return i;
61
+ }
62
+
63
+ // src/constants.ts
64
+ var S = {
65
+ error: 0,
66
+ warn: 1,
67
+ info: 2,
68
+ log: 3,
69
+ verbose: 4
70
+ };
71
+ var d = {
72
+ // Level error
73
+ error: {
74
+ label: "error",
75
+ level: "error",
76
+ color: o.red
77
+ },
78
+ // Level warn
79
+ warn: {
80
+ label: "warn",
81
+ level: "warn",
82
+ color: o.yellow
83
+ },
84
+ // Level info
85
+ info: {
86
+ label: "info",
87
+ level: "info",
88
+ color: o.cyan
89
+ },
90
+ start: {
91
+ label: "start",
92
+ level: "info",
93
+ color: o.cyan
94
+ },
95
+ ready: {
96
+ label: "ready",
97
+ level: "info",
98
+ color: o.green
99
+ },
100
+ success: {
101
+ label: "success",
102
+ level: "info",
103
+ color: o.green
104
+ },
105
+ // Level log
106
+ log: {
107
+ level: "log"
108
+ },
109
+ // Level debug
110
+ debug: {
111
+ label: "debug",
112
+ level: "verbose",
113
+ color: o.magenta
114
+ }
115
+ };
116
+
117
+ // src/createLogger.ts
118
+ var v = (t = {}) => {
119
+ let l = t.level || "log";
120
+ let n = (e, r, ...p) => {
121
+ if (S[d[e].level] > S[l]) {
122
+ return;
123
+ }
124
+ if (r === void 0 || r === null) {
125
+ console.log();
126
+ return;
127
+ }
128
+ let c = d[e];
129
+ let g = "";
130
+ if ("label" in c) {
131
+ g = (c.label || "").padEnd(7);
132
+ g = o.bold(c.color ? c.color(g) : g);
133
+ }
134
+ let b = "";
135
+ if (r instanceof Error) {
136
+ if (r.stack) {
137
+ let [u, ...x] = r.stack.split("\n");
138
+ b = `${u.replace("Error: ", "")}
139
+ ${o.gray(x.join("\n"))}`;
140
+ } else {
141
+ b = r.message;
142
+ }
143
+ } else if (c.level === "error" && typeof r === "string") {
144
+ let u = r.split("\n");
145
+ b = u.map((x) => L(x) ? o.gray(x) : x).join("\n");
146
+ } else {
147
+ b = `${r}`;
148
+ }
149
+ let $ = g.length ? `${g} ${b}` : b;
150
+ console.log($, ...p);
151
+ };
152
+ let i = {
153
+ greet: (e) => n("log", O(e))
154
+ };
155
+ Object.keys(d).forEach((e) => {
156
+ i[e] = (...r) => n(e, ...r);
157
+ });
158
+ return i;
159
+ };
160
+
161
+ // src/index.ts
162
+ var N = v();
163
+ export {
164
+ v as createLogger,
165
+ N as logger
166
+ };
package/dist/lib/index.js CHANGED
@@ -1 +1 @@
1
- var e,r,t=Object.create,n=Object.defineProperty,l=Object.getOwnPropertyDescriptor,o=Object.getOwnPropertyNames,a=Object.getPrototypeOf,m=Object.prototype.hasOwnProperty,i=(e,r,t,a)=>{if(r&&"object"===typeof r||"function"===typeof r)for(let i of o(r))m.call(e,i)||i===t||n(e,i,{get:()=>r[i],enumerable:!(a=l(r,i))||a.enumerable});return e},g=(e,r,l)=>(l=null!=e?t(a(e)):{},i(!r&&e&&e.__esModule?l:n(l,"default",{value:e,enumerable:!0}),e)),s=(e=(e,r)=>{var t=require("tty"),n=!("NO_COLOR"in process.env||process.argv.includes("--no-color"))&&("FORCE_COLOR"in process.env||process.argv.includes("--color")||"win32"===process.platform||t.isatty(1)&&"dumb"!==process.env.TERM||"CI"in process.env),l=(e,r,t=e)=>n=>{let l=""+n,a=l.indexOf(r,e.length);return~a?e+o(l,r,t,a)+r:e+l+r},o=(e,r,t,n)=>{let l=e.substring(0,n)+t,a=e.substring(n+r.length),m=a.indexOf(r);return~m?l+o(a,r,t,m):l+a},a=(e=n)=>({isColorSupported:e,reset:e?e=>`${e}`:String,bold:e?l("","",""):String,dim:e?l("","",""):String,italic:e?l("",""):String,underline:e?l("",""):String,inverse:e?l("",""):String,hidden:e?l("",""):String,strikethrough:e?l("",""):String,black:e?l("",""):String,red:e?l("",""):String,green:e?l("",""):String,yellow:e?l("",""):String,blue:e?l("",""):String,magenta:e?l("",""):String,cyan:e?l("",""):String,white:e?l("",""):String,gray:e?l("",""):String,bgBlack:e?l("",""):String,bgRed:e?l("",""):String,bgGreen:e?l("",""):String,bgYellow:e?l("",""):String,bgBlue:e?l("",""):String,bgMagenta:e?l("",""):String,bgCyan:e?l("",""):String,bgWhite:e?l("",""):String});r.exports=a(),r.exports.createColors=a},()=>(r||e((r={exports:{}}).exports,r),r.exports)),u={};((e,r)=>{for(var t in r)n(e,t,{get:r[t],enumerable:!0})})(u,{createLogger:()=>v,logger:()=>y}),module.exports=(e=>i(n({},"__esModule",{value:!0}),e))(u);var c=g(s()),f=g(s()),d={error:0,warn:1,info:2,debug:3,log:4},b={error:{label:"error",level:"error",formatter:f.default.red},info:{label:"info",level:"info",formatter:f.default.cyan},ready:{label:"ready",level:"info",formatter:f.default.green},success:{label:"success",level:"info",formatter:f.default.green},warn:{label:"warn",level:"warn",formatter:f.default.yellow},debug:{label:"debug",level:"debug",formatter:f.default.magenta},log:{level:"log"}},p=/^\s*at\s.*:\d+:\d+[\s)]*$/,S=/^\s*at\s.*\(<anonymous>\)$/,v=(e={})=>{const r=e.level||d.log,t=(e,t,...n)=>{if(d[b[e].level]>d[r])return;if(void 0===t||null===t)return void console.log();const l=b[e];let o="";"label"in l&&(o=(l.label||"").padEnd(7),o=c.default.bold(l.formatter?l.formatter(o):o));let a="";if(t instanceof Error)if(t.stack){const[e,...r]=t.stack.split("\n");a=`${e.replace("Error: ","")}\n${c.default.gray(r.join("\n"))}`}else a=t.message;else if("error"===l.level&&"string"===typeof t){a=t.split("\n").map((e=>(e=>p.test(e)||S.test(e))(e)?c.default.gray(e):e)).join("\n")}else a=`${t}`;const m=o.length?`${o} ${a}`:a;console.log(m,...n)},n={};return Object.keys(b).forEach((e=>{n[e]=(...r)=>t(e,...r)})),n},y=v();
1
+ var e,r=Object.defineProperty,l=Object.getOwnPropertyDescriptor,o=Object.getOwnPropertyNames,t=Object.prototype.hasOwnProperty,n={};((e,l)=>{for(var o in l)r(e,o,{get:l[o],enumerable:!0})})(n,{createLogger:()=>p,logger:()=>y}),module.exports=(e=n,((e,n,a,s)=>{if(n&&"object"===typeof n||"function"===typeof n)for(let i of o(n))t.call(e,i)||i===a||r(e,i,{get:()=>n[i],enumerable:!(s=l(n,i))||s.enumerable});return e})(r({},"__esModule",{value:!0}),e));var a=/^\s*at\s.*:\d+:\d+[\s)]*$/,s=/^\s*at\s.*\(<anonymous>\)$/,{env:i}=process,g=!("NO_COLOR"in i)&&("FORCE_COLOR"in i||"win32"===process.platform||process.stdout.isTTY&&"dumb"!==i.TERM||"CI"in i),c=(e,r,l=e)=>o=>{let t=""+o,n=t.indexOf(r,e.length);return~n?e+m(t,r,l,n)+r:e+t+r},m=(e,r,l,o)=>{let t=e.substring(0,o)+l,n=e.substring(o+r.length),a=n.indexOf(r);return~a?t+m(n,r,l,a):t+n},f={bold:g?c("","",""):String,red:g?c("",""):String,green:g?c("",""):String,yellow:g?c("",""):String,magenta:g?c("",""):String,cyan:g?c("",""):String,gray:g?c("",""):String},u=[189,255,243],b=[74,194,154];var d={error:0,warn:1,info:2,log:3,verbose:4},v={error:{label:"error",level:"error",color:f.red},warn:{label:"warn",level:"warn",color:f.yellow},info:{label:"info",level:"info",color:f.cyan},start:{label:"start",level:"info",color:f.cyan},ready:{label:"ready",level:"info",color:f.green},success:{label:"success",level:"info",color:f.green},log:{level:"log"},debug:{label:"debug",level:"verbose",color:f.magenta}},p=(e={})=>{let r=e.level||"log",l=(e,l,...o)=>{if(d[v[e].level]>d[r])return;if(void 0===l||null===l)return void console.log();let t=v[e],n="";"label"in t&&(n=(t.label||"").padEnd(7),n=f.bold(t.color?t.color(n):n));let i="";if(l instanceof Error)if(l.stack){let[e,...r]=l.stack.split("\n");i=`${e.replace("Error: ","")}\n${f.gray(r.join("\n"))}`}else i=l.message;else if("error"===t.level&&"string"===typeof l){i=l.split("\n").map((e=>(e=>a.test(e)||s.test(e))(e)?f.gray(e):e)).join("\n")}else i=`${l}`;let g=n.length?`${n} ${i}`:i;console.log(g,...o)},o={greet:e=>l("log",function(e){if(!g)return e;let r=e.length,l=[(b[0]-u[0])/r,(b[1]-u[1])/r,(b[2]-u[2])/r],o="";for(let t=0;t<r;t++){let r="";o+=`[38;2;${Math.round(u[0]+l[0]*t)};${Math.round(u[1]+l[1]*t)};${Math.round(u[2]+l[2]*t)}m${e[t]}${r}`}return o}(e))};return Object.keys(v).forEach((e=>{o[e]=(...r)=>l(e,...r)})),o},y=p();
@@ -1,18 +1,23 @@
1
- type LogLevel = 'log' | 'debug' | 'info' | 'warn' | 'error';
1
+ type ColorFn = (input: string | number | null | undefined) => string;
2
+
3
+ type LogLevel = 'error' | 'warn' | 'info' | 'log' | 'verbose';
2
4
  type LogMessage = number | string | Error | null;
3
- type LogFormatter = (input: string | number | null | undefined) => string;
4
5
  interface LogType {
5
6
  label?: string;
6
7
  level: LogLevel;
7
- formatter?: LogFormatter;
8
+ color?: ColorFn;
8
9
  }
9
10
  type LogFunction = (message?: LogMessage, ...args: any[]) => void;
10
11
  interface Options {
11
12
  level?: LogLevel;
12
13
  }
13
14
 
14
- declare const createLogger: (options?: Options) => Record<"error" | "log" | "debug" | "info" | "warn" | "ready" | "success", LogFunction>;
15
+ declare let createLogger: (options?: Options) => Record<"error" | "warn" | "info" | "log" | "start" | "ready" | "success" | "debug", LogFunction> & {
16
+ greet: (message: string) => void;
17
+ };
15
18
 
16
- declare const logger: Record<"error" | "log" | "debug" | "info" | "warn" | "ready" | "success", LogFunction>;
19
+ declare let logger: Record<"error" | "warn" | "info" | "log" | "start" | "ready" | "success" | "debug", LogFunction> & {
20
+ greet: (message: string) => void;
21
+ };
17
22
 
18
- export { LogFormatter, LogFunction, LogLevel, LogMessage, LogType, Options, createLogger, logger };
23
+ export { LogFunction, LogLevel, LogMessage, LogType, Options, createLogger, logger };
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "rslog",
3
- "version": "0.1.1",
3
+ "version": "1.0.0-beta.1",
4
4
  "types": "./dist/types/index.d.ts",
5
5
  "main": "./dist/lib/index.js",
6
- "module": "./dist/es/index.js",
6
+ "module": "./dist/es/index.mjs",
7
7
  "files": [
8
8
  "dist"
9
9
  ],
@@ -14,7 +14,6 @@
14
14
  "@modern-js/tsconfig": "2.35.1",
15
15
  "@types/jest": "~29.2.4",
16
16
  "@types/node": "~16.11.7",
17
- "picocolors": "^1.0.0",
18
17
  "prettier": "~2.8.1",
19
18
  "rimraf": "~3.0.2",
20
19
  "typescript": "~5.0.4"
package/dist/es/index.js DELETED
@@ -1 +0,0 @@
1
- var e,r,t=Object.create,n=Object.defineProperty,o=Object.getOwnPropertyDescriptor,l=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,m=(e=>"undefined"!==typeof require?require:"undefined"!==typeof Proxy?new Proxy(e,{get:(e,r)=>("undefined"!==typeof require?require:e)[r]}):e)((function(e){if("undefined"!==typeof require)return require.apply(this,arguments);throw new Error('Dynamic require of "'+e+'" is not supported')})),s=(e,r,m)=>(m=null!=e?t(i(e)):{},((e,r,t,i)=>{if(r&&"object"===typeof r||"function"===typeof r)for(let m of l(r))a.call(e,m)||m===t||n(e,m,{get:()=>r[m],enumerable:!(i=o(r,m))||i.enumerable});return e})(!r&&e&&e.__esModule?m:n(m,"default",{value:e,enumerable:!0}),e)),g=(e=(e,r)=>{var t=m("tty"),n=!("NO_COLOR"in process.env||process.argv.includes("--no-color"))&&("FORCE_COLOR"in process.env||process.argv.includes("--color")||"win32"===process.platform||t.isatty(1)&&"dumb"!==process.env.TERM||"CI"in process.env),o=(e,r,t=e)=>n=>{let o=""+n,i=o.indexOf(r,e.length);return~i?e+l(o,r,t,i)+r:e+o+r},l=(e,r,t,n)=>{let o=e.substring(0,n)+t,i=e.substring(n+r.length),a=i.indexOf(r);return~a?o+l(i,r,t,a):o+i},i=(e=n)=>({isColorSupported:e,reset:e?e=>`${e}`:String,bold:e?o("","",""):String,dim:e?o("","",""):String,italic:e?o("",""):String,underline:e?o("",""):String,inverse:e?o("",""):String,hidden:e?o("",""):String,strikethrough:e?o("",""):String,black:e?o("",""):String,red:e?o("",""):String,green:e?o("",""):String,yellow:e?o("",""):String,blue:e?o("",""):String,magenta:e?o("",""):String,cyan:e?o("",""):String,white:e?o("",""):String,gray:e?o("",""):String,bgBlack:e?o("",""):String,bgRed:e?o("",""):String,bgGreen:e?o("",""):String,bgYellow:e?o("",""):String,bgBlue:e?o("",""):String,bgMagenta:e?o("",""):String,bgCyan:e?o("",""):String,bgWhite:e?o("",""):String});r.exports=i(),r.exports.createColors=i},()=>(r||e((r={exports:{}}).exports,r),r.exports)),u=s(g()),f=s(g()),d={error:0,warn:1,info:2,debug:3,log:4},c={error:{label:"error",level:"error",formatter:f.default.red},info:{label:"info",level:"info",formatter:f.default.cyan},ready:{label:"ready",level:"info",formatter:f.default.green},success:{label:"success",level:"info",formatter:f.default.green},warn:{label:"warn",level:"warn",formatter:f.default.yellow},debug:{label:"debug",level:"debug",formatter:f.default.magenta},log:{level:"log"}},p=/^\s*at\s.*:\d+:\d+[\s)]*$/,b=/^\s*at\s.*\(<anonymous>\)$/,y=(e={})=>{const r=e.level||d.log,t=(e,t,...n)=>{if(d[c[e].level]>d[r])return;if(void 0===t||null===t)return void console.log();const o=c[e];let l="";"label"in o&&(l=(o.label||"").padEnd(7),l=u.default.bold(o.formatter?o.formatter(l):l));let i="";if(t instanceof Error)if(t.stack){const[e,...r]=t.stack.split("\n");i=`${e.replace("Error: ","")}\n${u.default.gray(r.join("\n"))}`}else i=t.message;else if("error"===o.level&&"string"===typeof t){i=t.split("\n").map((e=>(e=>p.test(e)||b.test(e))(e)?u.default.gray(e):e)).join("\n")}else i=`${t}`;const a=l.length?`${l} ${i}`:i;console.log(a,...n)},n={};return Object.keys(c).forEach((e=>{n[e]=(...r)=>t(e,...r)})),n},S=y();export{y as createLogger,S as logger};