babel-code-frame

Generate errors that contain a code frame that point to source locations.

Install

npm install --save-dev babel-code-frame

Usage

import codeFrame from 'babel-code-frame';

const rawLines = `class Foo {
  constructor()
}`;
const lineNumber = 2;
const colNumber = 16;

const result = codeFrame(rawLines, lineNumber, colNumber, { /* options */ });

console.log(result);

  1 | class Foo {
> 2 |   constructor()
    |                ^
  3 | }

If the column number is not known, you may pass null instead.

Options

`highlightCode`

boolean, defaults to false.

Toggles syntax highlighting the code as JavaScript for terminals.

`linesAbove`

number, defaults to 2.

Adjust the number of lines to show above the error.

`linesBelow`

number, defaults to 3.

Adjust the number of lines to show below the error.

`forceColor`

boolean, defaults to false.

Enable this to forcibly syntax highlight the code as JavaScript (for non-terminals); overrides highlightCode.

Current Tags

6.26.0 ... latest (7 years ago)
7.0.0-beta.3 ... next (7 years ago)

54 Versions

7.0.0-beta.3 ... 7 years ago
7.0.0-beta.2 ... 7 years ago
7.0.0-beta.1 ... 7 years ago
7.0.0-beta.0 ... 7 years ago
7.0.0-alpha.20 ... 7 years ago
6.26.0 ... 7 years ago
7.0.0-alpha.19 ... 7 years ago
7.0.0-alpha.18 ... 7 years ago
7.0.0-alpha.17 ... 7 years ago
7.0.0-alpha.16 ... 7 years ago
7.0.0-alpha.15 ... 7 years ago
7.0.0-alpha.14 ... 7 years ago
7.0.0-alpha.13 ... 7 years ago
7.0.0-alpha.12 ... 8 years ago
7.0.0-alpha.11 ... 8 years ago
7.0.0-alpha.9 ... 8 years ago
7.0.0-alpha.3 ... 8 years ago
7.0.0-alpha.1 ... 8 years ago
6.22.0 ... 8 years ago
6.20.0 ... 8 years ago
6.16.0 ... 8 years ago
6.11.0 ... 8 years ago
6.8.0 ... 9 years ago
6.7.7 ... 9 years ago
6.7.5 ... 9 years ago
6.7.4 ... 9 years ago
6.7.3 ... 9 years ago
6.7.2 ... 9 years ago
6.6.5 ... 9 years ago
6.6.0 ... 9 years ago
6.5.0-1 ... 9 years ago
6.5.0 ... 9 years ago
6.3.13 ... 9 years ago
6.2.4 ... 9 years ago
6.1.18 ... 9 years ago
6.1.17 ... 9 years ago
6.1.16 ... 9 years ago
6.1.15 ... 9 years ago
6.1.14 ... 9 years ago
6.1.13 ... 9 years ago
6.1.12 ... 9 years ago
6.1.11 ... 9 years ago
6.1.10 ... 9 years ago
6.1.9 ... 9 years ago
6.1.8 ... 9 years ago
6.1.7 ... 9 years ago
6.1.6 ... 9 years ago
6.1.5 ... 9 years ago
6.1.4 ... 9 years ago
6.0.15 ... 9 years ago
6.0.14 ... 9 years ago
6.0.12 ... 9 years ago
6.0.2 ... 9 years ago
6.0.0 ... 9 years ago