Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
markdownlint/helpers
History
David Anson d94b78e6bf Refactor getEvents slightly to avoid modifying the MicromarkParseOptions object.
2024-10-22 22:03:05 -07:00
..
.npmignore Enable custom rules to use the micromark parser, export micromark helpers for reuse. 2024-10-01 22:53:46 -07:00
helpers.js Refactor use of micromark so token stream is authentic by shimming undefined link reference handling, remove no-longer-necessary parse operation in MD034. 2024-10-21 20:56:22 -07:00
LICENSE Remove years from copyright statements. 2023-01-14 15:11:48 -08:00
micromark-helpers.cjs Refactor various code to do shallow/constrained search instead of deep search for better performance, make cache key for filterByTypesCached unique. 2024-10-09 22:42:36 -07:00
micromark-parse.cjs Refactor getEvents slightly to avoid modifying the MicromarkParseOptions object. 2024-10-22 22:03:05 -07:00
package.json Enable custom rules to use the micromark parser, export micromark helpers for reuse. 2024-10-01 22:53:46 -07:00
README.md Promote applyFix and applyFixes helpers into core library. 2024-10-06 17:24:44 -07:00
shared.js Split micromark.cjs into separate -parse and -helpers files. 2024-09-28 16:26:38 -07:00
test.cjs Enable custom rules to use the micromark parser, export micromark helpers for reuse. 2024-10-01 22:53:46 -07:00

README.md

markdownlint-rule-helpers

A collection of markdownlint helper functions for custom rules

Overview

The Markdown linter markdownlint offers a variety of built-in validation rules and supports the creation of custom rules. The internal rules share various helper functions; this package exposes those for reuse by custom rules.

API

Undocumented - This package exports the internal functions as-is. The APIs were not originally meant to be public, are not officially supported, and may change from release to release. There are brief descriptive comments above each function, but no JSDoc annotations. That said, some of what's here will be useful to custom rule authors and may avoid duplicating code.

Tests

None - The entire body of code is tested to 100% coverage by the core markdownlint project, so there are no additional tests here.