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 example for markdownlint-rule-helpers.applyFixes to documentation (fixes #663).

Browse source
This commit is contained in:
Bryan Mishkin 2022-12-03 15:48:08 -05:00 • committed by David Anson
parent 09911b24cf
commit 2c38ae90fc
3 changed files with 24 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
helpers/README.md
View file

@ -17,7 +17,9 @@ change from release to release. There are brief descriptive comments above each
function, but no [JSDoc][jsdoc] annotations. That said, some of what's here will
be useful to custom rule authors and may avoid duplicating code.
## Example
## Examples
### Using Helpers from a Custom Rule
```javascript
const { forEachLine, getLineMetadata } = require("markdownlint-rule-helpers");
@ -41,6 +43,18 @@ module.exports = {
};
```
### Applying Recommended Fixes
```javascript
const { "sync": markdownlintSync } = require("markdownlint");
const markdownlintRuleHelpers = require("markdownlint-rule-helpers");
function fixMarkdownlintViolations(content) {
const fixResults = markdownlintSync({ strings: { content } });
return markdownlintRuleHelpers.applyFixes(content, fixResults.content);
}
```
See also: [`markdownlint` built-in rule implementations][lib].
## Tests