locater

Locater

Find line number and cursor of string or Regex in a multi-line input

Install

npm install locater

Usage

Locater supports string and regex matching. Below is an example showing both usage with a given input.

input.txt

In my younger and more vulnerable years
my father gave me some advice that
I've been turning over in my mind ever since.

js

var locater = require('locater');
var input = fs.readFileSync('./input.txt', {encoding: 'utf8'});

locater('my', input);
// => [{ line: 1, cursor: 4 }, { line: 2, cursor: 1 }, { line: 3, cursor: 27 }]

locater(/[a-zA-Z]{7}\s/g, input);
// => [{ line: 1, cursor: 7 }, { line: 1, cursor: 27 }, { line: 3, cursor: 11 }]

Guide

locater(pattern, input)

Returns an array of positions of occurrences of pattern in input. A position is represented by an object with keys line and cursor.

pattern can be either String or Regex. If it is a Regex, it should be declared as global.

If there is no match, locater returns an empty array.

Contributing

Feel free to open issues with bugs and feature requests.

License

MIT