A unified plugin which reports inconsistencies between the input and what a pipeline would output.
npm install unified-consistency
This unified plugin stringifies the AST, and reports any differences from the input. You should always specify this plugin last. It works with all unified ecosystems, including remark and rehype.
processor.use(unifiedConsistency)
This plugin has no options.
This project is compatible with Node.js 18 or greater.
This plugin is best used in a configuration file. For example:
# .remarkrc.yaml
plugins:
- unified-consistency
For example, the following script:
import { remark } from 'remark'
import unifiedConsistency from 'unified-consistency'
import { reporter } from 'vfile-reporter'
const processor = remark().use(unifiedConsistency)
const file = await processor.process('#Hello')
console.log(reporter([file]))
Yields:
<stdin>
1:1-1:7 warning Replace `#Hello` with `\#Hello⏎` replace unified-consistency
⚠ 1 warning