rslog 0.1.0 → 1.0.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Bytedance, 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

@@ -1 +1,108 @@
 # Rslog
+
+A tiny, intuitive, type-friendly logger for Node.js.
+
+- **Tiny**. 1.5kB gzipped.
+- **Clean**. Zero dependencies.
+- **Intuitive**. Clear log prefix.
+- **Type-friendly**. Written in TypeScript.
+
+## Preview
+
+![Artboard](https://github.com/rspack-contrib/rslog/assets/7237365/436d6364-550d-4e0d-bc0f-9df1327c46b3)
+
+## Install
+
+```bash
+# with npm
+npm add rslog
+
+# with yarn
+yarn add rslog
+
+# with pnpm
+pnpm add rslog
+
+# with bun
+bun add rslog
+```
+
+## Usage
+
+- Require:
+
+```js
+// with require
+const { logger } = require('rslog');
+
+// with import
+import { logger } from 'rslog';
+```
+
+- Log:
+
+```js
+// A gradient welcome log
+logger.greet(`\n➜ Rslog v1.0.0\n`);
+
+// Info
+logger.info('This is a info message');
+
+// Start
+logger.start('This is a start message');
+
+// Warn
+logger.warn('This is a warn message');
+
+// Ready
+logger.ready('This is a ready message');
+
+// Success
+logger.success('This is a success message');
+
+// Error
+logger.error('This is a error message');
+logger.error(new Error('This is a error message with stack'));
+
+// Debug
+logger.debug('This is a debug message');
+
+// Same as console.log
+logger.log('This is a log message');
+```
+
+## Log Level
+
+You can create a new logger instance through `createLogger` and specify the log level:
+
+```js
+const { createLogger } = require('rslog');
+
+const logger = createLogger({ level: 'warn' });
+
+// Will print
+logger.error('This is a error message');
+logger.warn('This is a warn message');
+
+// Will not print
+logger.info('This is a info message');
+logger.log('This is a log message');
+```
+
+The log levels of each method are as follows:
+
+| Level   | Method                              |
+| ------- | ----------------------------------- |
+| error   | `error`                             |
+| warn    | `warn`                              |
+| info    | `info`, `start`, `ready`, `success` |
+| log     | `log`                               |
+| verbose | `debug`                             |
+
+## Credits
+
+The color implementation of Rslog are modified from [alexeyraspopov/picocolors](https://github.com/alexeyraspopov/picocolors).
+
+## License
+
+Rslog is [MIT licensed](https://github.com/rspack-contrib/rslog/blob/main/LICENSE).

package/dist/es/index.js

@@ -1 +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.magenta},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}\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};
+var e=/^\s*at\s.*:\d+:\d+[\s)]*$/,r=/^\s*at\s.*\(<anonymous>\)$/,{env:l}=process,o=!("NO_COLOR"in l)&&("FORCE_COLOR"in l||"win32"===process.platform||process.stdout.isTTY&&"dumb"!==l.TERM||"CI"in l),n=(e,r,l=e)=>o=>{let n=""+o,a=n.indexOf(r,e.length);return~a?e+t(n,r,l,a)+r:e+n+r},t=(e,r,l,o)=>{let n=e.substring(0,o)+l,a=e.substring(o+r.length),s=a.indexOf(r);return~s?n+t(a,r,l,s):n+a},a={bold:o?n("","",""):String,red:o?n("",""):String,green:o?n("",""):String,yellow:o?n("",""):String,magenta:o?n("",""):String,cyan:o?n("",""):String,gray:o?n("",""):String},s=[189,255,243],i=[74,194,154];var g={error:0,warn:1,info:2,log:3,verbose:4},c={error:{label:"error",level:"error",color:a.red},warn:{label:"warn",level:"warn",color:a.yellow},info:{label:"info",level:"info",color:a.cyan},start:{label:"start",level:"info",color:a.cyan},ready:{label:"ready",level:"info",color:a.green},success:{label:"success",level:"info",color:a.green},log:{level:"log"},debug:{label:"debug",level:"verbose",color:a.magenta}},m=(l={})=>{let n=l.level||"log",t=(l,o,...t)=>{if(g[c[l].level]>g[n])return;if(void 0===o||null===o)return void console.log();let s=c[l],i="";"label"in s&&(i=(s.label||"").padEnd(7),i=a.bold(s.color?s.color(i):i));let m="";if(o instanceof Error)if(o.stack){let[e,...r]=o.stack.split("\n");m=`${e.replace("Error: ","")}\n${a.gray(r.join("\n"))}`}else m=o.message;else if("error"===s.level&&"string"===typeof o){m=o.split("\n").map((l=>(l=>e.test(l)||r.test(l))(l)?a.gray(l):l)).join("\n")}else m=`${o}`;let d=i.length?`${i} ${m}`:m;console.log(d,...t)},m={greet:e=>t("log",function(e){if(!o)return e;let r=e.length,l=[(i[0]-s[0])/r,(i[1]-s[1])/r,(i[2]-s[2])/r],n="";for(let o=0;o<r;o++){let r="";n+=`[38;2;${Math.round(s[0]+l[0]*o)};${Math.round(s[1]+l[1]*o)};${Math.round(s[2]+l[2]*o)}m${e[o]}${r}`}return n}(e))};return Object.keys(c).forEach((e=>{m[e]=(...r)=>t(e,...r)})),m},d=m();export{m as createLogger,d as logger};

package/dist/lib/index.js

@@ -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.magenta},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}\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();
+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();

package/dist/types/index.d.ts

@@ -1,18 +1,23 @@
-type LogLevel = 'log' | 'debug' | 'info' | 'warn' | 'error';
+type ColorFn = (input: string | number | null | undefined) => string;
+
+type LogLevel = 'error' | 'warn' | 'info' | 'log' | 'verbose';
 type LogMessage = number | string | Error | null;
-type LogFormatter = (input: string | number | null | undefined) => string;
 interface LogType {
     label?: string;
     level: LogLevel;
-    formatter?: LogFormatter;
+    color?: ColorFn;
 }
 type LogFunction = (message?: LogMessage, ...args: any[]) => void;
 interface Options {
     level?: LogLevel;
 }
 
-declare const createLogger: (options?: Options) => Record<"error" | "log" | "debug" | "info" | "warn" | "ready" | "success", LogFunction>;
+declare let createLogger: (options?: Options) => Record<"error" | "warn" | "info" | "log" | "start" | "ready" | "success" | "debug", LogFunction> & {
+    greet: (message: string) => void;
+};
 
-declare const logger: Record<"error" | "log" | "debug" | "info" | "warn" | "ready" | "success", LogFunction>;
+declare let logger: Record<"error" | "warn" | "info" | "log" | "start" | "ready" | "success" | "debug", LogFunction> & {
+    greet: (message: string) => void;
+};
 
-export { LogFormatter, LogFunction, LogLevel, LogMessage, LogType, Options, createLogger, logger };
+export { LogFunction, LogLevel, LogMessage, LogType, Options, createLogger, logger };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rslog",
-  "version": "0.1.0",
+  "version": "1.0.0-beta.0",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/lib/index.js",
   "module": "./dist/es/index.js",
@@ -14,7 +14,6 @@
     "@modern-js/tsconfig": "2.35.1",
     "@types/jest": "~29.2.4",
     "@types/node": "~16.11.7",
-    "picocolors": "^1.0.0",
     "prettier": "~2.8.1",
     "rimraf": "~3.0.2",
     "typescript": "~5.0.4"
@@ -24,17 +23,11 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
+    "preview": "node ./preview.js",
     "dev": "modern dev",
     "build": "modern build",
     "build:watch": "modern build -w",
     "reset": "rimraf ./**/node_modules",
-    "lint": "modern lint",
-    "change": "modern change",
-    "bump": "modern bump",
-    "pre": "modern pre",
-    "change-status": "modern change-status",
-    "gen-release-note": "modern gen-release-note",
-    "release": "modern release",
     "new": "modern new",
     "upgrade": "modern upgrade",
     "test": "modern test"