Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 14:00:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add tests for micromark helpers filterByPredicate, filterByTypes, and getMicromarkEvents.

Browse source
This commit is contained in:
David Anson 2023-02-10 20:37:32 -08:00
parent a87f40efd8
commit 5302ee45de
3 changed files with 68 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

21
helpers/micromark.cjs
View file

@ -23,13 +23,13 @@ const { gfmAutolinkLiteral, gfmFootnote, parse, postprocess, preprocess } =
*/
/**
* Parses a Markdown document and returns (frozen) tokens.
* Parses a Markdown document and returns Micromark events.
*
* @param {string} markdown Markdown document.
* @param {Object} [options] Options for micromark.
* @returns {Token[]} Micromark tokens (frozen).
* @returns {Object[]} Micromark events.
*/
function micromarkParse(markdown, options = {}) {
function getMicromarkEvents(markdown, options = {}) {
// Customize options object to add useful extensions
options.extensions ||= [];
@ -43,6 +43,20 @@ function micromarkParse(markdown, options = {}) {
parseContext.defined.includes = (searchElement) => searchElement.length > 0;
const chunks = preprocess()(markdown, encoding, eol);
const events = postprocess(parseContext.document().write(chunks));
return events;
}
/**
* Parses a Markdown document and returns (frozen) tokens.
*
* @param {string} markdown Markdown document.
* @param {Object} [options] Options for micromark.
* @returns {Token[]} Micromark tokens (frozen).
*/
function micromarkParse(markdown, options = {}) {
// Use micromark to parse document into Events
const events = getMicromarkEvents(markdown, options);
// Create Token objects
const document = [];
@ -186,6 +200,7 @@ module.exports = {
filterByPredicate,
filterByTypes,
getHtmlTagInfo,
getMicromarkEvents,
getTokenTextByType,
matchAndGetTokensByType
};