@jpp-toolkit/logger 0.0.11

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Julien Papini
+
+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/dist/index.d.mts

@@ -0,0 +1,26 @@
+//#region src/logger.d.ts
+type LogFunc = (message?: string, ...args: unknown[]) => void;
+type LoggerOptions = {
+  readonly logStdout?: LogFunc | undefined;
+  readonly logStderr?: LogFunc | undefined;
+  readonly rootDir?: string | undefined;
+  readonly rootIsProjectRoot?: boolean | undefined;
+  readonly rootIsPackageRoot?: boolean | undefined;
+};
+declare class Logger {
+  private readonly _logStdout;
+  private readonly _logStderr;
+  private readonly _rootDir;
+  constructor(options?: LoggerOptions);
+  formatPath(path: string): string;
+  log(message?: string, ...args: unknown[]): void;
+  success(message?: string, ...args: unknown[]): void;
+  info(message?: string, ...args: unknown[]): void;
+  warning(message?: string, ...args: unknown[]): void;
+  error(message?: string, ...args: unknown[]): void;
+  list(items: string[]): void;
+  paths(paths: string[]): void;
+}
+//#endregion
+export { LogFunc, Logger, LoggerOptions };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,44 @@
+import { findPackageRoot, findProjectRoot } from "@jpp-toolkit/utils";
+import { blue, gray, green, red, yellow } from "colorette";
+
+//#region src/logger.ts
+var Logger = class {
+	_logStdout;
+	_logStderr;
+	_rootDir;
+	constructor(options = {}) {
+		this._logStdout = options.logStdout ?? console.log;
+		this._logStderr = options.logStderr ?? console.error;
+		this._rootDir = options.rootDir ?? (options.rootIsPackageRoot ? findPackageRoot() : options.rootIsProjectRoot ? findProjectRoot() : void 0);
+	}
+	formatPath(path) {
+		const root = this._rootDir ?? process.cwd();
+		const replaceWith = this._rootDir ? "<root>/" : "<cwd>/";
+		return path.replace(new RegExp(`^${root}/`, "u"), gray(replaceWith));
+	}
+	log(message, ...args) {
+		this._logStdout(message, ...args);
+	}
+	success(message, ...args) {
+		this._logStdout(`${green("✔︎")} ${message}`, ...args);
+	}
+	info(message, ...args) {
+		this._logStdout(`${blue("ℹ︎")} ${message}`, ...args);
+	}
+	warning(message, ...args) {
+		this._logStdout(`${yellow("⚠︎")} ${message}`, ...args);
+	}
+	error(message, ...args) {
+		this._logStderr(`${red("✘")} ${message}`, ...args);
+	}
+	list(items) {
+		for (const item of items) this._logStdout(` - ${item}`);
+	}
+	paths(paths) {
+		this.list(paths.map((p) => this.formatPath(p)));
+	}
+};
+
+//#endregion
+export { Logger };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/logger.ts"],"sourcesContent":["import { findPackageRoot, findProjectRoot } from '@jpp-toolkit/utils';\nimport { green, blue, yellow, red, gray } from 'colorette';\n\nexport type LogFunc = (message?: string, ...args: unknown[]) => void;\n\nexport type LoggerOptions = {\n    readonly logStdout?: LogFunc | undefined;\n    readonly logStderr?: LogFunc | undefined;\n    readonly rootDir?: string | undefined;\n    readonly rootIsProjectRoot?: boolean | undefined;\n    readonly rootIsPackageRoot?: boolean | undefined;\n};\n\nexport class Logger {\n    private readonly _logStdout: LogFunc;\n    private readonly _logStderr: LogFunc;\n    private readonly _rootDir: string | undefined;\n\n    constructor(options: LoggerOptions = {}) {\n        this._logStdout = options.logStdout ?? console.log;\n        this._logStderr = options.logStderr ?? console.error;\n        this._rootDir =\n            options.rootDir\n            ?? (options.rootIsPackageRoot ? findPackageRoot()\n            : options.rootIsProjectRoot ? findProjectRoot()\n            : undefined);\n    }\n\n    public formatPath(path: string): string {\n        const root = this._rootDir ?? process.cwd();\n        const replaceWith = this._rootDir ? '<root>/' : '<cwd>/';\n        return path.replace(new RegExp(`^${root}/`, 'u'), gray(replaceWith));\n    }\n\n    public log(message?: string, ...args: unknown[]): void {\n        this._logStdout(message, ...args);\n    }\n\n    public success(message?: string, ...args: unknown[]): void {\n        this._logStdout(`${green('✔︎')} ${message}`, ...args);\n    }\n\n    public info(message?: string, ...args: unknown[]): void {\n        this._logStdout(`${blue('ℹ︎')} ${message}`, ...args);\n    }\n\n    public warning(message?: string, ...args: unknown[]): void {\n        this._logStdout(`${yellow('⚠︎')} ${message}`, ...args);\n    }\n\n    public error(message?: string, ...args: unknown[]): void {\n        this._logStderr(`${red('✘')} ${message}`, ...args);\n    }\n\n    public list(items: string[]): void {\n        for (const item of items) this._logStdout(` - ${item}`);\n    }\n\n    public paths(paths: string[]): void {\n        this.list(paths.map((p) => this.formatPath(p)));\n    }\n}\n"],"mappings":";;;;AAaA,IAAa,SAAb,MAAoB;CAChB,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CAEjB,YAAY,UAAyB,EAAE,EAAE;AACrC,OAAK,aAAa,QAAQ,aAAa,QAAQ;AAC/C,OAAK,aAAa,QAAQ,aAAa,QAAQ;AAC/C,OAAK,WACD,QAAQ,YACJ,QAAQ,oBAAoB,iBAAiB,GAC/C,QAAQ,oBAAoB,iBAAiB,GAC7C;;CAGV,AAAO,WAAW,MAAsB;EACpC,MAAM,OAAO,KAAK,YAAY,QAAQ,KAAK;EAC3C,MAAM,cAAc,KAAK,WAAW,YAAY;AAChD,SAAO,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,IAAI,IAAI,EAAE,KAAK,YAAY,CAAC;;CAGxE,AAAO,IAAI,SAAkB,GAAG,MAAuB;AACnD,OAAK,WAAW,SAAS,GAAG,KAAK;;CAGrC,AAAO,QAAQ,SAAkB,GAAG,MAAuB;AACvD,OAAK,WAAW,GAAG,MAAM,KAAK,CAAC,GAAG,WAAW,GAAG,KAAK;;CAGzD,AAAO,KAAK,SAAkB,GAAG,MAAuB;AACpD,OAAK,WAAW,GAAG,KAAK,KAAK,CAAC,GAAG,WAAW,GAAG,KAAK;;CAGxD,AAAO,QAAQ,SAAkB,GAAG,MAAuB;AACvD,OAAK,WAAW,GAAG,OAAO,KAAK,CAAC,GAAG,WAAW,GAAG,KAAK;;CAG1D,AAAO,MAAM,SAAkB,GAAG,MAAuB;AACrD,OAAK,WAAW,GAAG,IAAI,IAAI,CAAC,GAAG,WAAW,GAAG,KAAK;;CAGtD,AAAO,KAAK,OAAuB;AAC/B,OAAK,MAAM,QAAQ,MAAO,MAAK,WAAW,MAAM,OAAO;;CAG3D,AAAO,MAAM,OAAuB;AAChC,OAAK,KAAK,MAAM,KAAK,MAAM,KAAK,WAAW,EAAE,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@jpp-toolkit/logger",
+  "version": "0.0.11",
+  "description": "A simple logger for JS/TS projects.",
+  "keywords": [
+    "jpp",
+    "logger"
+  ],
+  "homepage": "https://github.com/jpapini/jpp-toolkit/tree/main/packages/logger#readme",
+  "bugs": {
+    "url": "https://github.com/jpapini/jpp-toolkit/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jpapini/jpp-toolkit.git",
+    "directory": "packages/logger"
+  },
+  "license": "MIT",
+  "author": "Julien Papini <julien.papini@gmail.com> (https://github.com/jpapini)",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "colorette": "2.0.20",
+    "@jpp-toolkit/utils": "0.0.11"
+  },
+  "engines": {
+    "node": "24",
+    "pnpm": "10"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit --pretty",
+    "dev": "build-lib --watch",
+    "build": "build-lib"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './logger';

package/src/logger.ts

@@ -0,0 +1,62 @@
+import { findPackageRoot, findProjectRoot } from '@jpp-toolkit/utils';
+import { green, blue, yellow, red, gray } from 'colorette';
+
+export type LogFunc = (message?: string, ...args: unknown[]) => void;
+
+export type LoggerOptions = {
+    readonly logStdout?: LogFunc | undefined;
+    readonly logStderr?: LogFunc | undefined;
+    readonly rootDir?: string | undefined;
+    readonly rootIsProjectRoot?: boolean | undefined;
+    readonly rootIsPackageRoot?: boolean | undefined;
+};
+
+export class Logger {
+    private readonly _logStdout: LogFunc;
+    private readonly _logStderr: LogFunc;
+    private readonly _rootDir: string | undefined;
+
+    constructor(options: LoggerOptions = {}) {
+        this._logStdout = options.logStdout ?? console.log;
+        this._logStderr = options.logStderr ?? console.error;
+        this._rootDir =
+            options.rootDir
+            ?? (options.rootIsPackageRoot ? findPackageRoot()
+            : options.rootIsProjectRoot ? findProjectRoot()
+            : undefined);
+    }
+
+    public formatPath(path: string): string {
+        const root = this._rootDir ?? process.cwd();
+        const replaceWith = this._rootDir ? '<root>/' : '<cwd>/';
+        return path.replace(new RegExp(`^${root}/`, 'u'), gray(replaceWith));
+    }
+
+    public log(message?: string, ...args: unknown[]): void {
+        this._logStdout(message, ...args);
+    }
+
+    public success(message?: string, ...args: unknown[]): void {
+        this._logStdout(`${green('✔︎')} ${message}`, ...args);
+    }
+
+    public info(message?: string, ...args: unknown[]): void {
+        this._logStdout(`${blue('ℹ︎')} ${message}`, ...args);
+    }
+
+    public warning(message?: string, ...args: unknown[]): void {
+        this._logStdout(`${yellow('⚠︎')} ${message}`, ...args);
+    }
+
+    public error(message?: string, ...args: unknown[]): void {
+        this._logStderr(`${red('✘')} ${message}`, ...args);
+    }
+
+    public list(items: string[]): void {
+        for (const item of items) this._logStdout(` - ${item}`);
+    }
+
+    public paths(paths: string[]): void {
+        this.list(paths.map((p) => this.formatPath(p)));
+    }
+}