Skip to content

Display an arrow in a string of code to point to a location

License

Notifications You must be signed in to change notification settings

curvedmark/pinpoint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pinpoint

Add line numbers and an arrow to a string of code that points to a specific location.

Installation

npm install pinpoint

Example

With this code:

function add(left, right) {
  return left   right;
}

console.log(add(1   1));

When being asked to point to line 2 and column 2, generates this:

1| function add(left, right) {
2|   return left   right;
-----^
3| }
4|
5| console.log(add(1   1));

API

var pinpoint = require('pinpoint');

var str = pinpoint(code, options);
  • code - a string of code
  • options - an object literal supports these options:
    • line - the line number to point to, 1-based.
    • column - the column number to point to, 1-based.
    • showLines - the number of lines to show. The pointed line will try to stay in the middle of the displays lines.
    • indent - indent string prepend to each line, before the line number.
    • tabSize - width of a tab character.

About

Display an arrow in a string of code to point to a location

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published