Socket
Socket
Sign inDemoInstall

babel-code-frame

Package Overview
Dependencies
9
Maintainers
5
Versions
54
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

babel-code-frame

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

    6.26.0latest
    GitHub
    npm

Version published
Maintainers
5
Weekly downloads
3,677,552
decreased by-13.46%

Weekly downloads

Package description

What is babel-code-frame?

The babel-code-frame package is a utility that allows developers to generate a string representing a code frame that highlights a specific portion of the code, typically used to point out syntax errors or other code issues. It can be used to enhance error messages with a visual context of where the issue is located in the source code.

What are babel-code-frame's main functionalities?

Highlighting code

This feature allows you to highlight a specific part of the code. In the provided code sample, it highlights the word 'Foo' in the given rawLines string.

const { codeFrameColumns } = require('babel-code-frame');
const rawLines = `class Foo {\n  constructor()\n}`;
const location = { start: { line: 1, column: 16 }, end: { line: 1, column: 19 } };

const result = codeFrameColumns(rawLines, location, { highlightCode: true });
console.log(result);

Other packages similar to babel-code-frame

Readme

Source

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.

FAQs

Last updated on 16 Aug 2017

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc