@emmetio/field-parser

Parses snippet fields (aka tab-stops) like `${1:foo}` in given string

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
10Aug 21, 2019Nov 27, 2016Minified + gzip package size for @emmetio/field-parser in KB

Readme

Fields (tab-stops) parser

Parses snippet fields (aka tab-stops) like ${1:foo} in given string and produces a model that contains clean string without fields and list of fields locations.

Usage example

import parse from '@emmetio/field-parser';

const fieldModel = parse('foo $0 ${1:bar} ${2}${1}');

console.log(fieldModel.string);
// outputs "foo  bar "

// `.fields` is array of `{index, location, length}` fields
console.log(fieldModel.fields);
// outputs:
// {index: 0, location: 4, length: 0}
// {index: 1, location: 5, length: 3}
// {index: 2, location: 9, length: 0}
// {index: 1, location: 9, length: 0}

You can also mark string with fields:

import { mark } from '@emmetio/field-parser';

const marked = mark('foo bar', [
    {index: 1, location: 0, length: 3},
    {index: 5, location: 4, length: 3},
]);

console.log(marked); // ${1:foo} ${5:bar}

...or parse string and then use built-it mark method:

import parse from '@emmetio/field-parser';

const fieldModel = parse('foo $0 ${1:bar} ${2}${1}');
fieldModel.forEach(field => field.index += 100);

console.log(fieldModel.mark()); // foo $100 ${101:bar} ${102}${101}

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.