@reliverse/relinka

Docs | npmjs.com | GitHub

Style your terminal or browser console like never before. @reliverse/relinka is your next powerful logger. It's a full-featured alternative to winston, unjs relinka, pino, bristol, node-bunyan, and similar libraries. Used by @reliverse/prompts and @reliverse/cli.

Installation

bun add @reliverse/relinka # Replace 'bun' with npm, pnpm, or yarn if desired

---

Warning: The @reliverse/relinka README.md was based on the @reliverse/prompts README.md. Some of the information may be not related to the current library. And will be updated soon.

---

Screenshot

Key Features

• Type Safety: Built with TypeScript, ensuring strong typing to prevent runtime errors.
• Schema Validation: Validates user inputs using schemas for enhanced reliability.
• Flexible Prompt Types: Supports a range of prompt types, including text, password, number, select, and multiselect.
• Crash Resilience: Designed to handle cancellations and errors gracefully, ensuring stability.

Prompt Types

Each type has its own validation and display logic. More types are planned for future releases.

• Text: Collects text input.
• Password: Hidden input for secure password entries.
• Number: Numeric input with optional validation.
• Confirm: Simple Yes/No prompt.
• Select: Dropdown selection for multiple choices.
• Multiselect: Allows users to select multiple items from a list.

Input Validation

All prompts support custom validation logic, providing immediate feedback to users.

Contributing

@reliverse/relinka is a work in progress. We welcome feedback and contributions to help make it the best library it can be. Thank you!

Here is how to install the library for development:

git clone https://github.com/reliverse/relinka.git
cd relinka
bun i

Playground

Run bun dev to launch the examples/run-example.ts CLI, where you can dive into and explore any of the examples listed below. Experiment with @reliverse/relinka by running examples locally or reviewing the linked code:

1. 1-main-example.ts: A comprehensive example of a CLI application featuring a well styled UI config. This example showcases all available prompt components, with code organized into separate functions and files for better readability and clarity.
2. 2-mono-example.ts: A quiz game example inspired by Fireship's video. It demonstrates the dynamic capabilities of @reliverse/relinka by using a prompt() that includes all prompt components, so you don't need to import each component separately.
3. 3-basic-example.ts: A simple example highlighting the core functionalities of @reliverse/relinka. The entire implementation is contained within a single file for easy understanding.

Logger Library Comparison

Note: This table contains approximate and placeholder values. More detailed assessments will be provided as libraries continue to evolve.

Icon Legend:

• 🟡: Not yet verified
• 🟢: Fully supported
• 🔵: Partially supported
• 🔴: Not supported

Feature	@reliverse/relinka	@unjs/consola	@klaudiosinani/signale	pino	@TomFrost/Bristol	@trentm/node-bunyan	winston	log4js-node
Full Node.js Modules Support	🟢 Native ES module package	🟢	🟡	🟡	🟡	🟡	🟡	🟡
Works both in node, bun, and deno environments	🔵 node+bun (deno support is coming soon)	🔵	🟡	🟡	🟡	🟡	🟡	🟡
Codebase typesafety with intellisense	🔵	🔵	🟡	🟡	🟡	🟡	🟡	🟡
Runtime typesafety with schema validation	🔵	🔵	🟡	🟡	🟡	🟡	🟡	🟡
Usage Examples	🟢	🟢	🟡	🟡	🟡	🟡	🟡	🟡
Prompts Components	🟢 Can be enabled using @reliverse/prompts library	🟢	🟡	🟡	🟡	🟡	🟡	🟡
Customization	🟢 Colors, typography, variants, borders, and more	🟢	🟡	🟡	🟡	🟡	🟡	🟡
Custom Validation	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
Error Handling	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
Ease of Setup	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
Crash Resilience	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
General DX	🔵 Clean and understandable TypeScript code	🔵	🟡	🟡	🟡	🟡	🟡	🟡
DX: Classes	🟢 Minimal number of classes as possible	🟢	🟡	🟡	🟡	🟡	🟡	🟡
Documentation	🔵	🔵	🟡	🟡	🟡	🟡	🟡	🟡
Designed With UX/DX in Mind	🟢	🟢	🟡	🟡	🟡	🟡	🟡	🟡
Fast and lightweight argument parser	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
Smart value parsing with typecast	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
Boolean shortcuts and unknown flag handling	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
Nested sub-commands	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
Lazy and Async commands	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
Pluggable and composable API	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡
Auto generated usage and help	🟡	🟡	🟡	🟡	🟡	🟡	🟡	🟡

Related Links: ESM/CJS, "Pure ESM package", Clean code, "UX patterns for CLI tools", DX (Developer Experience), TypeBox, "ANSI Escape Sequences"

Wrap-Up

@reliverse/relinka is a versatile library designed to accelerate CLI development by providing customizable prompt components. Integrated into the Reliverse CLI, @reliverse/relinka enables you to create a unique design aligned with your CLI app’s aesthetics, similar to how @shadcn/ui supports customizable web UI components. Quickly get started by copying configurations from the Reliverse Docs and using components that fit your project, making it faster to bring your CLI app to life. You’re free to customize each component as desired, with default designs provided to ensure an attractive interface from the start.

Example Configuration:

const basicConfig = {
  titleColor: "cyanBright",
  titleTypography: "bold",
  borderColor: "viceGradient",
} satisfies OptionalPromptOptions;

const extendedConfig = {
  ...basicConfig,
  contentTypography: "italic",
  contentColor: "dim",
} satisfies OptionalPromptOptions;

const username = await textPrompt({
  id: "username",
  title: "We're glad you're testing our library!",
  content: "Let's get to know each other!\nWhat's your username?",
  schema: schema.properties.username,
  ...extendedConfig,
});

Learn More

• Reliverse Docs

Special Thanks

This project wouldn’t exist without the amazing work of the huge number of contributors to the list of projects below. Many of the @reliverse/relinka features are based on the incredible work of:

@reliverse/prompts | @unjs/consola

License

MIT © Nazarii Korniienko