An ESM/Jest/Node-friendly utility for resolving file and directory paths, logging, error handling, and signal handling in both CommonJS and ESM environments.
- Unified API for CommonJS and ESM
- Logging with [@eliware/log]
- Path utilities with [@eliware/path]
- Error handler registration with [@eliware/errors]
- Signal/shutdown handler registration with [@eliware/signals]
- Re-exports Node.js built-in
fsmodule - TypeScript type definitions included
- Fully tested with Jest
npm install @eliware/commonimport { fs, log, path, pathUrl, getCurrentDirname, getCurrentFilename, registerHandlers, registerSignals } from '@eliware/common';
log.info('This is an info log from @eliware/log');
const { removeHandlers } = registerHandlers();
log.info('Registered error handlers.');
const envFile = path(import.meta, '.env');
log.info(`path to env file: ${envFile}`);
const envFileUrl = pathUrl(import.meta, '.env');
log.info(`pathUrl to env file: ${envFileUrl}`);
const { shutdown } = registerSignals();
log.info('Registered signal handlers.');
// Example usage of fs
const files = fs.readdirSync(getCurrentDirname(import.meta));
log.info(`Files in current directory: ${files.join(', ')}`);const { fs, log, path, pathUrl, getCurrentDirname, getCurrentFilename, registerHandlers, registerSignals } = require('@eliware/common');
log.info('This is an info log from @eliware/log');
const { removeHandlers } = registerHandlers();
log.info('Registered error handlers.');
const envFile = path(__dirname, '.env');
log.info(`path to env file: ${envFile}`);
const envFileUrl = pathUrl(__dirname, '.env');
log.info(`pathUrl to env file: ${envFileUrl}`);
const { shutdown } = registerSignals();
log.info('Registered signal handlers.');
// Example usage of fs
const files = fs.readdirSync(getCurrentDirname(__dirname));
log.info(`Files in current directory: ${files.join(', ')}`);Re-export of the Node.js built-in fs module. Use for file system operations.
Default logger instance from [@eliware/log]. Supports .info, .warn, .error, etc.
Joins the current dirname with provided segments to form an absolute path.
metaOrDir:import.meta(ESM), a string (dirname, e.g.__dirname), or undefinedsegments: Path segments to join- Returns: Absolute path string
Returns the current directory name.
metaOrDir:import.meta(ESM), a string (dirname, e.g.__dirname), or undefineddirnameFn: Optional custom dirname function- Returns: Absolute path to the current directory
Returns the current filename.
metaOrDir:import.meta(ESM), a string (dirname, e.g.__dirname), or undefined- Returns: Absolute path to the current file
Registers process-level exception handlers for uncaught exceptions, unhandled rejections, warnings, and exit events.
processObj: The process object to attach handlers to (default: process)logger: Logger for output (default: log)- Returns:
{ removeHandlers }function to remove all registered handlers
Sets up shutdown handlers for the process.
options:{ processObj, logger, signals }- Returns:
{ shutdown, getShuttingDown }
Type definitions are included and exported for all main functions and options:
import { fs, log, path, getCurrentDirname, getCurrentFilename, registerHandlers, registerSignals, RegisterSignalsOptions } from '@eliware/common';For help, questions, or to chat with the author and community, visit:
