@ac-essentials/app-util

This package provides reusable utilities for building Node.js applications—primarily for my own use, but feel free to use it if it helps you too! It focuses on logging, configuration, process management, and system helpers to keep your app code clean, robust, and consistent across projects.

Installation

You can install the package via npm:

npm install @ac-essentials/app-util
Copy

Or via yarn:

yarn add @ac-essentials/app-util
Copy

Utility Summary

Here's a categorized summary of the main utilities available in this package (see source for full details):

Logger Utilities

• logger: Flexible, pluggable logger for structured and leveled logging.
• logger-console: Console logger implementation.
• file-printer: Printer for writing logs to files with rotation support.
• idle-mark-printer-proxy: Printer proxy that marks idle periods in logs.
• no-repeat-printer-proxy: Printer proxy that suppresses repeated log messages.
• text-stream-printer: Printer for streaming logs as plain text.
• compare-log-level: Compare log levels by severity.
• is-error-log-level: Check if a log level is considered an error.
• record-equal: Deep equality check for logger records.
• ansi-record-stringifier: Stringifier for log records with ANSI color formatting.
• json-record-stringifier: Stringifier for log records as JSON.

CLI Config Utilities

• load-config: Load and merge CLI configuration files with support for extends.

App & System Utilities

• find-repo-git-dir: Find the nearest .git directory in a project.
• run-command: Run shell commands with logging and output capture.
• rotate-log-files: Rotate and manage log files with retention policies.
• get-processes-snapshot: Get a snapshot of running system processes with filtering.
• process-kill-by-pid-file: Kill a process by reading its PID from a file.
• process-wait-pid: Wait for a process to terminate by PID.

Usage

You can import and use the utilities in your project as follows:

import { Logger } from '@ac-essentials/app-util';
Copy

For more detailed documentation and examples, please refer to the official documentation.

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue on the GitHub repository.