babel/packages/babel-code-frame
Simon Lydell bf0e256c3a babel-code-frame: Highlight strings with green (not red) (#4579)
- Red makes it look like something is wrong with the string.
- On Ubuntu-based systems, it looks kinda broken.
- The error markers (`>` and `^`) as well as invalid tokens are already
  marked with red. By not having strings red, the most important
  information -- the error location -- is more visible.

This is a continuation of commit fa1de5ce (PR #4572).
2016-09-27 15:35:17 -04:00
..
2016-03-08 22:33:23 -05:00

babel-code-frame

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

Install

$ npm install 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

name type default description
highlightCode boolean false Syntax highlight the code as JavaScript for terminals
linesAbove number 2 The number of lines to show above the error
linesBelow number 3 The number of lines to show below the error