fretted-strings

Mark on your strings and get it's position

Source

npm

Version: 1.0.0

Version published: 6 years ago

Weekly downloads: 1.3K

Maintainers: 1

Weekly downloads

Created: 5 years ago

Source

fretted-strings

Marks on your strings and get it's position.

npm i fretted-strings

Basic usage

import { mark, Frets } from 'fretted-strings';

const frets: Frets = {};
const content = mark(
  `
      hogehoge
  %%% ^      ^   %%%
  %%% p1     p2  %%%
      fooo`,
  frets,
);

// Function `mark` returns a string which is removed lines enclosed by '%%%' tags from the parameter.
assert(
  content,
  `
      hogehoge
      fooo`,
);

// And this function assigns specified location whose name is represented
// as identifier under the `^` character to 2nd parameter.
assert(frets.p1.line, 1);
assert(frets.p1.col, 6);

assert(frets.p2.line, 1);
assert(frets.p2.col, 13);

Use custom tag

import { setOptions, mark, Frets } from 'fretted-strings';

setOptions({
  tagStart: '<!--%%',
  tagEnd: '%%-->',
});

const frets: Frets = {};

mark(
  `<html>
  <div>hogehoge</div>
  <!--%%   ^    %%-->
  <!--%%   p    %%-->
</html>`,
  frets,
);

import { FretsMarker, Frets } from 'fretted-strings';

const marker = new FretsMarker({
  tagStart: '<!--%%',
  tagEnd: '%%-->',
});

const frets: Frets = {};

marker.mark(
  `<html>
  <div>hogehoge</div>
  <!--%%   ^    %%-->
  <!--%%   p    %%-->
</html>`,
  frets,
);

LICENSE

MIT

Keywords

string

FAQs

What is fretted-strings?

Is fretted-strings popular?

Is fretted-strings well maintained?

Package last updated on 02 Mar 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install