8058baeaefPR-URL: https://github.com/nodejs/node/pull/12162 Reviewed-By: Teddy Katz <teddy.katz@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> |
||
|---|---|---|
| .. | ||
| lib | ||
| package.json | ||
| README.md | ||
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
| 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 |
| forceColor | boolean | false |
Forcibly syntax highlight the code as JavaScript (for non-terminals); overrides highlightCode |