CLI Styles

Common errors

• ReferenceError: require is not defined

  cause Attempting to use `require('cli-styles')` in an ECMAScript Module (ESM) context (e.g., in a `.mjs` file or a module with `"type": "module"` in `package.json`).
  fix For ESM, use `import cliStyles from 'cli-styles';` to import the default export. For CommonJS, ensure your file is `.cjs` or `"type": "commonjs"` is specified, or simply use the default Node.js behavior.

• TypeError: cliStyles.input.default is not a function

  cause This error is unlikely to occur unless `cliStyles` itself is not correctly imported or is `undefined`. More commonly, `cliStyles.input` might be treated as a function if `cliStyles` isn't properly destructured or imported as a default.
  fix Ensure `cliStyles` is imported correctly (e.g., `const cliStyles = require('cli-styles')` or `import cliStyles from 'cli-styles'`). The `input.default` property is a function provided by `chalk`, so verify `chalk` is also correctly resolved within `cli-styles`.

• TypeError: Cannot read properties of undefined (reading 'default') at Object.input

  cause This error often happens if you've attempted named destructuring like `import { input } from 'cli-styles'` in an ESM context. Since `cli-styles` only has a default export, `input` would be `undefined`.
  fix Import the entire default export: `import cliStyles from 'cli-styles'`. Then access its properties: `cliStyles.input.default(...)`.

Warnings

• gotcha cli-styles is a CommonJS module and does not natively support named ESM imports. Attempting `import { input } from 'cli-styles'` will fail or result in `undefined` values in pure ESM environments.
  Fix: Use `import cliStyles from 'cli-styles'` for ESM, which will import the default export, then access properties like `cliStyles.input`. For CommonJS, use `const cliStyles = require('cli-styles')`.
• deprecated The package is not actively maintained since its last update in February 2020. While stable at 1.0.0, users should be aware that new features, bug fixes, or updates for compatibility with newer Node.js versions or terminal features are unlikely.
  Fix: Consider evaluating alternative, actively maintained libraries for new projects if future compatibility or features are critical. For existing projects, be mindful of potential issues with newer Node.js versions or terminal emulation that may not be addressed.
• gotcha cli-styles is not a prompt library itself; it provides styling primitives for existing prompt implementations. Directly calling `cliStyles.input` or `cliStyles.indicator` will not render a prompt or text, as these are objects containing styling functions or pre-styled strings.
  Fix: Always access the specific style function or string, e.g., `cliStyles.input.default('text')` or `cliStyles.indicator.success`. Integrate these outputs with a proper prompt library like `prompt-skeleton` or Node.js's `readline` module.
• gotcha The package depends on older versions of `chalk` (implicitly via its `package.json` at the time of 1.0.0 release). This might lead to dependency conflicts if your project uses a much newer `chalk` version, or it might not leverage the latest color capabilities or performance improvements.
  Fix: Inspect your `package-lock.json` for `cli-styles`'s `chalk` dependency. If conflicts arise, consider using `npm dedupe` or manually resolving dependency trees. For new projects, evaluate alternatives that use up-to-date dependencies.

Install

• npm install cli-styles npm
• yarn add cli-styles yarn
• pnpm add cli-styles pnpm

Imports

• cliStyles
  wrong:

  import { input, indicator, delimiter } from 'cli-styles'

  correct:

  import cliStyles from 'cli-styles'

  The package is CommonJS-first and exports a single default object. While bundlers like Webpack or Rollup might allow this syntax, direct Node.js ESM usage often requires careful configuration or a dynamic import for older CJS modules. Named imports will result in `undefined`.
• cliStyles (CommonJS)

  const cliStyles = require('cli-styles')

  This is the primary and most reliable way to import 'cli-styles' in Node.js environments, given its CommonJS module format.
• input.default
  wrong:

  cliStyles.input('Your input')

  correct:

  cliStyles.input.default('Your input')

  The 'input' property is an object containing various input style functions (e.g., 'default', 'password'). You must access the specific style function, not call 'input' directly.

Quickstart

Demonstrates how to import 'cli-styles' and apply its input styles, status indicators, and delimiters to a basic readline prompt to achieve a consistent look.

import cliStyles from 'cli-styles';
import readline from 'readline';

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
});

async function runPrompt() {
  // Using the question indicator and delimiter
  process.stdout.write(cliStyles.indicator.question + ' ' + cliStyles.delimiter + ' ');

  // Using default input style
  const question = cliStyles.input.default('What is your name? ');
  rl.question(question, (name) => {
    if (name.length > 0) {
      process.stdout.write(cliStyles.indicator.success + ' ' + cliStyles.delimiter + ' ');
      console.log(cliStyles.input.default(`Hello, ${name}!`));
    } else {
      process.stdout.write(cliStyles.indicator.error + ' ' + cliStyles.delimiter + ' ');
      console.log(cliStyles.input.default('Name cannot be empty.'));
    }
    rl.close();
  });
}

runPrompt();