CLI-High: Terminal Syntax Highlighter

Common errors

• TypeError: (0, cli_high__WEBPACK_IMPORTED_MODULE_0__.highlight) is not a function

  cause This error typically occurs in bundled environments (like Webpack) when a named export is incorrectly treated as a default export, or when the `highlight` function is not correctly tree-shaken/imported.
  fix Verify that you are using a named import: `import { highlight } from 'cli-high'`. Check your bundler's configuration for ESM compatibility and ensure no conflicting default imports or incorrect aliasing.

• SyntaxError: Cannot use import statement outside a module

  cause Attempting to use ES module `import` syntax in a Node.js environment configured for CommonJS (`require()`) without proper module configuration.
  fix To use ESM, add `'type': 'module'` to your `package.json` file, or save your script files with a `.mjs` extension. Alternatively, if you need to load ESM in a CJS context, use dynamic import: `const { highlight } = await import('cli-high');`.

• Error: ENOENT: no such file or directory, open './path/to/your/js/file'

  cause When using `cli-high` via its CLI (`npx cli-high ./path/to/file`), this error indicates that the provided file path does not exist or is incorrect relative to where the command is executed.
  fix Double-check the file path provided to the `npx cli-high` command. Ensure the file exists and the path is either absolute or correct relative to your current working directory.

Warnings

• breaking As a 0.x.x version, cli-high's API is subject to breaking changes in minor or even patch releases without strict adherence to SemVer. The API surface may evolve rapidly.
  Fix: Always refer to the official GitHub repository and any provided changelog or release notes before upgrading to ensure compatibility with your codebase. Pinning exact versions is recommended for production.
• gotcha Mixing CommonJS `require()` with cli-high's presumed ESM-first approach (indicated by TypeScript usage and import examples) can lead to import errors like 'TypeError: highlight is not a function'.
  Fix: Ensure your project is configured for ES Modules (e.g., `'type': 'module'` in `package.json` or `.mjs` file extension). If you must use CommonJS, consider dynamic `import()` or verify the package's CJS export compatibility.

Install

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

Imports

• highlight
  wrong:

  const highlight = require('cli-high')

  correct:

  import { highlight } from 'cli-high'

  This is the primary named export for programmatic highlighting. While CommonJS might be supported, the library's examples and TypeScript types promote an ESM-first approach. Directly requiring the package might not yield the function.
• Options

  import type { Options } from 'cli-high'

  Use `import type` for importing the configuration options interface, which allows specifying language, theme, and other highlighting parameters. This ensures type-only imports for better tree-shaking and explicit type usage.
• Language

  import type { Language } from 'cli-high'

  The `Language` type is a string literal union defining the supported language identifiers for the highlighter, useful for type-safe language specification with the `highlight` function's options.

Quickstart

Demonstrates programmatic use of `cli-high` to syntax-highlight JavaScript and JSON code for terminal output, including specifying language and theme options.

import { highlight, type Options } from 'cli-high';

const javascriptCode = `
function greet(name: string) {
  console.log("Hello, " + name + "!");
}

greet("World");
`;

const options: Options = {
  language: 'js', // Or 'typescript', 'json', etc.
  theme: 'dark' // Or 'light'
};

const highlightedCode = highlight(javascriptCode, options);
console.log(highlightedCode);

// Example of highlighting a different language
const jsonConfig = `{
  "name": "cli-high-project",
  "version": "1.0.0",
  "scripts": {
    "start": "node index.js"
  }
}`;

const highlightedJson = highlight(jsonConfig, { language: 'json' });
console.log('\n' + highlightedJson);