Leprechaun CLI Logger

Common errors

• Error [ERR_REQUIRE_ESM]: require() of ES Module .../node_modules/leprechaun/index.js from ... not supported.

  cause Attempting to import `leprechaun` using CommonJS `require()` syntax in a project that expects ESM.
  fix Change `const { info } = require('leprechaun');` to `import { info } from 'leprechaun';` and ensure your project is configured for ESM (e.g., `"type": "module"` in package.json).

• The package 'leprechaun' requires Node.js version >=20.0.0. The current active Node.js version is X.Y.Z.

  cause Running `leprechaun` on a Node.js version older than 20.0.0, which is unsupported by the package.
  fix Upgrade your Node.js runtime to version 20.0.0 or newer using a version manager like `nvm` or `volta`.

• ReferenceError: info is not defined (or similar for other functions)

  cause This usually indicates an incorrect import statement, either trying to import a non-existent default export or an incorrect named export from a CommonJS context.
  fix Ensure you are using `import { info, success, warning, error } from 'leprechaun';` and your environment supports ESM.

Warnings

• breaking Version 1.0.0 introduced a minimum Node.js requirement of `>=20.0.0`. Projects running on older Node.js versions must upgrade to use Leprechaun v1.0.0 and above.
  Fix: Upgrade your Node.js environment to version 20.0.0 or higher, or use an earlier version of Leprechaun (if available and compatible) at your own risk.
• breaking The package migrated to TypeScript in version 1.0.0. While the primary API remains consistent, this may introduce changes to type definitions or internal module structure that could subtly affect existing JavaScript consumers or custom type declarations.
  Fix: Verify that your type imports and usage remain compatible. If you encounter type errors, consult the bundled type definitions or report an issue.
• gotcha As indicated by the `TODO` section in the README, Leprechaun currently lacks comprehensive documentation and tests. This could lead to unexpected behavior in edge cases, difficulty understanding advanced usage patterns, or instability in future updates.
  Fix: Exercise caution when relying on undocumented features. Consider reviewing the source code for deeper understanding and contribute to the project's documentation and testing efforts if possible.

Install

• npm install leprechaun npm
• yarn add leprechaun yarn
• pnpm add leprechaun pnpm

Imports

• info
  wrong:

  const { info } = require('leprechaun');

  correct:

  import { info } from 'leprechaun';

  Leprechaun is an ESM-only package since v1.0.0, requiring `import` syntax. It ships with TypeScript types.
• success, warning, error
  wrong:

  import leprechaun from 'leprechaun'; leprechaun.success(...);

  correct:

  import { success, warning, error } from 'leprechaun';

  All logging functions are named exports; there is no default export.
• All logging functions
  wrong:

  const { info, success, warning, error } = require('leprechaun');

  correct:

  import { info, success, warning, error } from 'leprechaun';

  Use this pattern to import all available logging functions for console output.

Quickstart

This quickstart demonstrates how to import and use all four primary logging functions (`info`, `success`, `warning`, `error`) to display diverse messages with appropriate colorful icons in a CLI application.

import { info, success, warning, error } from 'leprechaun';

const project = 'MyCLIApp';
const version = '1.0.0';
const featureEnabled = true;

info('Starting', project, 'v' + version);
success('Configuration loaded:', featureEnabled ? 'enabled' : 'disabled');
warning('Check for updates recommended for', project);
error('Failed to connect to service. Retrying...');