mdast utility to parse comment markers.
Install
npm:
npm install mdast-comment-marker
Use
var marker = require('mdast-comment-marker');
console.log(marker({
type: 'html',
value: '<!--foo-->'
}));
console.log(marker({
type: 'html',
value: '<!--foo bar baz=12.4 qux="test test" quux=\'false\'-->'
}));
console.log(marker({
type: 'html',
value: '<!doctype html>'
}));
console.log(marker({
type: 'comment',
value: 'bar'
}));
Yields:
{ name: 'foo',
attributes: '',
parameters: {},
node: { type: 'html', value: '<!--foo-->' } }
{ name: 'foo',
attributes: 'bar baz=12.4 qux="test test" quux=\'false\'',
parameters: { bar: true, baz: 12.4, qux: 'test test', quux: false },
node:
{ type: 'html',
value: '<!--foo bar baz=12.4 qux="test test" quux=\'false\'-->' } }
null
{ name: 'bar',
attributes: '',
parameters: {},
node: { type: 'comment', value: 'bar' } }
API
marker(node)
Parse a comment marker.
Parameters
Returns
Marker?
— Information, when applicable.
Marker
A comment marker.
Properties
name
(string
) — Name of markerattributes
(string
) — Value after nameparameters
(Object
) — Parsed attributes, tries to convert
values to numbers and booleans when possiblenode
(Node
) — Reference to given node
Security
Use of mdast-comment-marker
does not involve hast, user content,
or change the tree, so there are no openings for
cross-site scripting (XSS) attacks.
Contribute
See contributing.md
in syntax-tree/.github
for ways to get
started.
See support.md
for ways to get help.
This project has a code of conduct.
By interacting with this repository, organization, or community you agree to
abide by its terms.
License
MIT © Titus Wormer