@reliverse/relinka 1.3.6 → 1.3.8

package/README.md

@@ -1,116 +1,155 @@
-# Relidler: Reliverse Bundler
+# Relinka: Stylish Logging Made Simple
 
 [💖 GitHub Sponsors](https://github.com/sponsors/blefnk) • [💬 Discord](https://discord.gg/Pb8uKbwpsJ) • [✨ Repo](https://github.com/reliverse/relinka-logger) • [📦 NPM](https://npmjs.com/@reliverse/relinka) • [📚 Docs](https://docs.reliverse.org)
 
-**@reliverse/relinka** is your next powerful logger, which allows you to style your terminal or browser console like never before.
+**@reliverse/relinka** is your next favorite logging library — built to make your terminal (and browser console — soon) output look good, stay clean, and be actually helpful. It’s styled, structured, and smart. Oh, and it works with configs, files, and colors out of the box.
 
-## Features
+## 🌟 Features
 
-- 😘 Drop-in replacement for `consola`
-- ⚡ `relinka` works via CLI and SDK
-- 📦 Automated NPM/JSR publishing
-- ✅ Ensures reliable JS/TS builds
-- 🔄 Handles automatic version bumps
-- 🔧 Eliminates `package.json` headaches
-- 🎯 Optimized for speed and modern workflows
-- 🛠️ Converts TypeScript aliases to relative paths
-- ✨ Packed with powerful features under the hood
-- 📝 Highly configurable flow via a configuration file
-- 🔌 Plugin system with one built-in plugin included
+- 🧙 Drop-in replacement for `node:console` and `consola`
+- 💬 `relinka` supports: `info`, `warn`, `success`, `error`, `verbose`
+- 🎨 Beautiful, color-coded logs in the terminal
+- 🧠 Auto-formats messages, objects, and errors
+- 📁 Save logs to file (with daily logs, cleanup, and rotation)
+- 📦 Use it programmatically or through CLI-compatible tools
+- ⚙️ Smart customization via config
+- ✨ Extensible and future-proof
 
-## Getting Started
+## 🚀 Getting Started
 
-Ensure [Git](https://git-scm.com/downloads), [Node.js](https://nodejs.org), and a package manager ([bun](https://bun.sh)/[pnpm](https://pnpm.io)/[yarn](https://yarnpkg.com)/[npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)) are installed. Then follow these steps:
+### 1. Install
 
-### Example Playground
+```bash
+bun add @reliverse/relinka
+```
+
+And, optionally, install the CLI globally to manage your config:
 
-Want to test Relinka before integrating it into your project? Clone the repo and launch the example:
+```bash
+bun i -g @reliverse/relinka-cli
+```
 
-```sh
-git clone https://github.com/reliverse/relinka-logger.git
-cd relinka-logger
-bun i
-bun dev # bun examples/e-main.ts
+### 2. Basic Usage
+
+```ts
+import { relinkaConfig, relinka } from "@reliverse/relinka";
+export async function main() {
+  await relinkaConfig;
+  relinka(
+    "verbose",
+    "This message can be seen only if config was loaded AND debug is enabled",
+  );
+  relinka("info", "Everything is running smoothly");
+  relinka("warn", "This might be a problem");
+  relinka("error", "Uh oh, something broke");
+  relinka("success", "Thanks for using Relinka! 👋");
+}
+await main();
 ```
 
-### Relidler Usage
+## 🧪 Advanced Usage
+
+Want a clean blank line?
 
-1. **Install globally**:
+```ts
+relinka("clear", ""); // Acts just like `console.clear()`
+relinka("info", ""); // Just prints a blank newline
+```
 
-    ```sh
-    bun i -g @reliverse/relidler
-    ```
+🔜 Use the async logger if you want some advanced features (like typing text animation - soon):
 
-    **Or update as needed**:
+```ts
+import { relinkaAsync } from "@reliverse/relinka";
 
-    ```sh
-    bun -g update --latest
-    ```
+await relinkaAsync("info", "Something happened", { animate: true });
+```
 
-2. **Prepare your project**:
+## ⚙️ Configuration
+
+Create a `relinka.config.ts` file with a content like:
+
+```ts
+import { defineConfig } from "@reliverse/relinka";
+export default defineConfig({
+  // Enable debug to see verbose logs
+  debug: true,
+  // Show timestamp in each log message
+  withTimestamp: false,
+  // Control whether logs are saved to a file
+  saveLogsToFile: true,
+  // Disable colors in the console
+  disableColors: false,
+  // Log file path
+  logFilePath: "relinka.log",
+  // Directory settings
+  dirs: {
+    dailyLogs: true,
+    logDir: ".reliverse/logs", // store logs in a custom folder
+    maxLogFiles: 5, // keep only the 5 most recent log files
+    specialDirs: {
+      distDirNames: [],
+      useParentConfigInDist: true,
+    },
+  },
+});
+```
 
-    a. **Configure `.gitignore`**:
+Supported config file names:
 
-    ```sh
-    echo "*.log" >> .gitignore
-    echo "dist-npm" >> .gitignore
-    echo "dist-jsr" >> .gitignore
-    echo "dist-libs" >> .gitignore
-    ```
+- `relinka.config.ts`
+- 🔜 `.relinka.config.js`
+- 🔜 `.relinkarc`
+- 🔜 or any other supported by c12
 
-    b. **Install config intellisense**:
+## 📁 Log Files
 
-    ```sh
-    bun add -D @reliverse/relidler-cfg
-    ```
+- Stored in `.reliverse/logs/` by default
+- Filename: `relinka.log` or `YYYY-MM-DD-relinka.log` if daily logs are enabled
+- Auto-rotates based on `maxLogFiles`
 
-    c. **Initialize `relidler.cfg.ts`**:
+## 📚 API Summary
 
-    ```sh
-    relidler
-    ```
+### relinka(level, message, ...args)
 
-    - The `relidler.cfg.ts` file is created automatically on the first run.
-    - **It's recommended to customize this file according to your needs.**
-    - Supported names: `relidler.cfg.ts` • `relidler.config.ts` • `build.pub.ts` • `build.cfg.ts`.
+Logs synchronously. Skips debug logs if `debug: false`.
 
-3. **Run and enjoy**:
+### relinkaAsync(level, message, ...args)
 
-    ```sh
-    relidler
-    ```
+Async logger that waits for config automatically, and provides some additional advanced features.
 
-## Plugins & SDK
+### defineConfig(config)
 
-Relidler includes a plugin system, with the following official built-in plugin already available:
+Helper to define typed config in `relinka.config.ts`
 
-- **`libraries-relidler-plugin`**: Builds and publishes specified subdirectories of your main project as separate packages.
+## 🧰 Utilities
 
-### API (for advanced users)
+✅ Timestamping  
+✅ Log file rotation  
+✅ File-safe formatting  
+✅ ANSI color support  
+✅ Error object handling
 
-The SDK allows you to create new Relidler plugins and even extend your own CLI functionality.
+## 💡 Tips
 
-```sh
-bun add -D @reliverse/relidler-sdk
-```
+- Want `@ts-expect-error` auto-injection? Check out [`@reliverse/reinject`](https://npmjs.com/@reliverse/reinject).
+- Using this in a CLI tool? Combine with [`@reliverse/prompts`](https://npmjs.com/@reliverse/prompts).
 
-## TODO
+## ✅ TODO
 
-- [x] ~~Implement stable `regular` build and publish~~
-- [ ] Implement stable `library` build and publish
-- [ ] Allow to minify dist with comments preserved
-- [ ] Achieve full drop-in replacement for `unbuild`
-- [ ] Support auto migration from `build.config.ts`
-- [ ] Allow plugins to extend Relidler's `defineConfig`
-- [ ] Support configuration via `reliverse.{ts,jsonc}`
-- [ ] Make config file optional with sensible defaults
+- [x] File-based logging
+- [x] Timestamp support
+- [x] Daily logs
+- [x] Smart config
+- [x] Log rotation
+- [ ] CLI interface (optional)
+- [ ] Plugin support (custom formatters, log levels, etc)
 
-## Related
+## 🙌 Shoutout
 
-Kudos to the following project that made Relinka possible:
+Relinka was inspired by this gem:
 
 - [unjs/consola](https://github.com/unjs/consola#readme)
 
-## License
+## 📄 License
 
-🩷 [MIT](./LICENSE) © [blefnk Nazar Kornienko](https://github.com/blefnk)
+💖 MIT © [blefnk (Nazar Kornienko)](https://github.com/blefnk)

package/bin/{relinka-impl → core-impl}/deprecated/components/levels/levels.d.ts

@@ -1,13 +1,13 @@
-import type { LogObject, LogTypeDeprecated } from "../../../../relinka-types.js";
-/**
- * A mapping of `LogTypeDeprecated` to its corresponding numeric log level.
- *
- * @type {Record<LogTypeDeprecated, number>} LogLevelsDeprecated - key-value pairs of log types to their numeric levels. See {@link LogTypeDeprecated}.
- */
-export declare const LogLevelsDeprecated: Record<LogTypeDeprecated, number>;
-/**
- * Maps `LogTypeDeprecated` to a `Partial<LogObject>`, primarily defining the log level.
- *
- * @type {Record<LogTypeDeprecated, Partial<LogObject>>} LogTypesDeprecated - key-value pairs of log types to partial log objects, specifying log levels. See {@link LogTypeDeprecated} and {@link LogObject}.
- */
-export declare const LogTypesDeprecated: Record<LogTypeDeprecated, Partial<LogObject>>;
+import type { LogObject, LogTypeDeprecated } from "../../../../core-types.js";
+/**
+ * A mapping of `LogTypeDeprecated` to its corresponding numeric log level.
+ *
+ * @type {Record<LogTypeDeprecated, number>} LogLevelsDeprecated - key-value pairs of log types to their numeric levels. See {@link LogTypeDeprecated}.
+ */
+export declare const LogLevelsDeprecated: Record<LogTypeDeprecated, number>;
+/**
+ * Maps `LogTypeDeprecated` to a `Partial<LogObject>`, primarily defining the log level.
+ *
+ * @type {Record<LogTypeDeprecated, Partial<LogObject>>} LogTypesDeprecated - key-value pairs of log types to partial log objects, specifying log levels. See {@link LogTypeDeprecated} and {@link LogObject}.
+ */
+export declare const LogTypesDeprecated: Record<LogTypeDeprecated, Partial<LogObject>>;

package/bin/{relinka-impl → core-impl}/deprecated/components/modes/basic.d.ts

@@ -1,19 +1,19 @@
-import type { RelinkaInstanceDeprecated } from "../relinka-deprecated/relinka.js";
-import type { RelinkaOptionsDeprecated } from "../../../../relinka-types.js";
-export * from "./shared.js";
-/**
- * Factory function to create a new Relinka instance
- *
- * @param {Partial<RelinkaOptionsDeprecated & { fancy: boolean }>} [options={}] - Optional configuration options. See {@link RelinkaOptionsDeprecated}.
- * @returns {RelinkaInstanceDeprecated} A new Relinka instance configured with the given options.
- */
-export declare function createRelinkaBaseDeprecated(options?: Partial<RelinkaOptionsDeprecated & {
-    fancy: boolean;
-}>): RelinkaInstanceDeprecated;
-/**
- * Creates and exports a standard instance of Relinka with the default configuration.
- * This instance can be used directly for logging throughout the application.
- *
- * @type {RelinkaInstanceDeprecated} relinka - The default instance of Relinka.
- */
-export declare const relinkaBasicDeprecated: RelinkaInstanceDeprecated;
+import type { RelinkaInstanceDeprecated } from "../relinka-deprecated/relinka.js";
+import type { RelinkaOptionsDeprecated } from "../../../../core-types.js";
+export * from "./shared.js";
+/**
+ * Factory function to create a new Relinka instance
+ *
+ * @param {Partial<RelinkaOptionsDeprecated & { fancy: boolean }>} [options={}] - Optional configuration options. See {@link RelinkaOptionsDeprecated}.
+ * @returns {RelinkaInstanceDeprecated} A new Relinka instance configured with the given options.
+ */
+export declare function createRelinkaBaseDeprecated(options?: Partial<RelinkaOptionsDeprecated & {
+    fancy: boolean;
+}>): RelinkaInstanceDeprecated;
+/**
+ * Creates and exports a standard instance of Relinka with the default configuration.
+ * This instance can be used directly for logging throughout the application.
+ *
+ * @type {RelinkaInstanceDeprecated} relinka - The default instance of Relinka.
+ */
+export declare const relinkaBasicDeprecated: RelinkaInstanceDeprecated;

package/bin/{relinka-impl → core-impl}/deprecated/components/modes/browser.d.ts

@@ -1,19 +1,19 @@
-import type { RelinkaOptionsDeprecated } from "../../../../relinka-types.js";
-import { type RelinkaInstanceDeprecated } from "../relinka-deprecated/relinka.js";
-export * from "./shared.js";
-/**
- * Creates a new Relinka instance configured specifically for browser environments.
- * This function sets up default reporters and a prompt method tailored to the browser's dialogue APIs.
- *
- * @param {Partial<RelinkaOptionsDeprecated>} [options={}] - Optional configuration options.
- * The options can override the default reporter and prompt behavior. See {@link RelinkaOptionsDeprecated}.
- * @returns {RelinkaInstanceDeprecated} A new Relinka instance optimized for use in browser environments.
- */
-export declare function createRelinkaBrowserDeprecatedDeprecated(options?: Partial<RelinkaOptionsDeprecated>): any;
-/**
- * A standard Relinka instance created with browser-specific configurations.
- * This instance can be used throughout a browser-based project.
- *
- * @type {RelinkaInstanceDeprecated} relinka - The default browser-configured Relinka instance.
- */
-export declare const relinkaBrowserDeprecated: RelinkaInstanceDeprecated;
+import type { RelinkaOptionsDeprecated } from "../../../../core-types.js";
+import { type RelinkaInstanceDeprecated } from "../relinka-deprecated/relinka.js";
+export * from "./shared.js";
+/**
+ * Creates a new Relinka instance configured specifically for browser environments.
+ * This function sets up default reporters and a prompt method tailored to the browser's dialogue APIs.
+ *
+ * @param {Partial<RelinkaOptionsDeprecated>} [options={}] - Optional configuration options.
+ * The options can override the default reporter and prompt behavior. See {@link RelinkaOptionsDeprecated}.
+ * @returns {RelinkaInstanceDeprecated} A new Relinka instance optimized for use in browser environments.
+ */
+export declare function createRelinkaBrowserDeprecatedDeprecated(options?: Partial<RelinkaOptionsDeprecated>): any;
+/**
+ * A standard Relinka instance created with browser-specific configurations.
+ * This instance can be used throughout a browser-based project.
+ *
+ * @type {RelinkaInstanceDeprecated} relinka - The default browser-configured Relinka instance.
+ */
+export declare const relinkaBrowserDeprecated: RelinkaInstanceDeprecated;

package/bin/{relinka-impl → core-impl}/deprecated/components/modes/shared.d.ts

@@ -1,2 +1,2 @@
-export { LogLevelsDeprecated, LogTypesDeprecated, } from "../levels/levels.js";
-export type * from "../../../../relinka-types.js";
+export { LogLevelsDeprecated, LogTypesDeprecated, } from "../levels/levels.js";
+export type * from "../../../../core-types.js";

package/bin/{relinka-impl → core-impl}/deprecated/components/relinka-deprecated/logger.d.ts

@@ -1,5 +1,5 @@
-type MessageKind = "log" | "info" | "warn" | "error" | "success";
-type VerboseKind = `${MessageKind}-verbose`;
-type AllKinds = MessageKind | VerboseKind;
-export declare const relinkaDeprecated: (_kind: AllKinds, title: string, content?: string, hint?: string) => void;
-export {};
+type MessageKind = "log" | "info" | "warn" | "error" | "success";
+type VerboseKind = `${MessageKind}-verbose`;
+type AllKinds = MessageKind | VerboseKind;
+export declare const relinkaDeprecated: (_kind: AllKinds, title: string, content?: string, hint?: string) => void;
+export {};

package/bin/{relinka-impl → core-impl}/deprecated/components/relinka-deprecated/mod.d.ts

@@ -1,20 +1,20 @@
-import type { RelinkaOptionsDeprecated } from "../../../../relinka-types.js";
-import type { RelinkaInstanceDeprecated } from "./relinka.js";
-export * from "../modes/shared.js";
-/**
- * Factory function to create a new Relinka instance tailored for use in different environments.
- * It automatically adjusts logging levels based on environment variables and execution context.
- *
- * @param {Partial<RelinkaOptionsDeprecated & { fancy: boolean }>} [options={}] - Optional configuration options. See {@link RelinkaOptionsDeprecated}.
- * @returns {RelinkaInstanceDeprecated} A new Relinka instance with configurations based on the given options and the execution environment.
- */
-export declare function createRelinkaSharedDeprecated(options?: Partial<RelinkaOptionsDeprecated & {
-    fancy: boolean;
-}>): RelinkaInstanceDeprecated;
-/**
- * A default instance of Relinka, created and configured for immediate use.
- * This instance is configured based on the execution environment and the options provided.
- *
- * @type {RelinkaInstanceDeprecated} relinka - The default Relinka instance, ready to use.
- */
-export declare const relinkaInstanceDeprecated: RelinkaInstanceDeprecated;
+import type { RelinkaOptionsDeprecated } from "../../../../core-types.js";
+import type { RelinkaInstanceDeprecated } from "./relinka.js";
+export * from "../modes/shared.js";
+/**
+ * Factory function to create a new Relinka instance tailored for use in different environments.
+ * It automatically adjusts logging levels based on environment variables and execution context.
+ *
+ * @param {Partial<RelinkaOptionsDeprecated & { fancy: boolean }>} [options={}] - Optional configuration options. See {@link RelinkaOptionsDeprecated}.
+ * @returns {RelinkaInstanceDeprecated} A new Relinka instance with configurations based on the given options and the execution environment.
+ */
+export declare function createRelinkaSharedDeprecated(options?: Partial<RelinkaOptionsDeprecated & {
+    fancy: boolean;
+}>): RelinkaInstanceDeprecated;
+/**
+ * A default instance of Relinka, created and configured for immediate use.
+ * This instance is configured based on the execution environment and the options provided.
+ *
+ * @type {RelinkaInstanceDeprecated} relinka - The default Relinka instance, ready to use.
+ */
+export declare const relinkaInstanceDeprecated: RelinkaInstanceDeprecated;