babel-code-frame
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/babel-code-frame package

6.26.0 • Public • Published

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.

Readme

Keywords

none

Package Sidebar

Install

npm i babel-code-frame

Homepage

babeljs.io/

Weekly Downloads

4,425,045

Version

6.26.0

License

MIT

Last publish

Collaborators

  • hzoo
  • loganfsmyth
  • existentialism