@babel/code-frame
import { codeFrameColumns } from "@babel/code-frame";
const rawLines = `class Foo {
constructor()
}`;
const location = { start: { line: 2, column: 16 } };
const result = codeFrameColumns(rawLines, location, {
/* options */
console.log(result);
You can also pass an end
hash in location
.
import { codeFrameColumns } from "@babel/code-frame";
const rawLines = `class Foo {
constructor() {
}
}`;
const location = {
start: { line: 2, column: 17 },
end: { line: 4, column: 3 },
};
const result = codeFrameColumns(rawLines, location, {
/* options */
});
boolean
, defaults to false
.
Toggles syntax highlighting the code as JavaScript for terminals.
number
, defaults to 2
.
number
, defaults to 3
.
Adjust the number of lines to show below the error.
, defaults to false
.
Enable this to forcibly syntax highlight the code as JavaScript (for non-terminals); overrides highlightCode
.
Pass in a string to be displayed inline (if possible) next to the highlighted location in the code. If it can’t be positioned inline, it will be placed above the code frame.
1 | class Foo {
> 2 | constructor()
| ^ Missing {
3 | };
Prior to version 7, the only API exposed by this module was for a single line and optional column pointer. The old API will now log a deprecation warning.
The new API takes a location
object, similar to what is available in an AST.
This is an example of the deprecated (but still available) API:
import { codeFrameColumns } from "@babel/code-frame";
const rawLines = `class Foo {
constructor() {
console.log("hello");
}
}`;
const location = { start: { line: 2, column: 16 } };
const result = codeFrameColumns(rawLines, location, {
/* options */
});