unified-consistency
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

unified-consistency

github actions npm version npm downloads

codecov

A unified plugin which reports inconsistencies between the input and what a pipeline would output.

Table of Contents

Installation

npm install unified-consistency

API

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)

Options

This plugin has no options.

Compatibility

This project is compatible with Node.js 18 or greater.

Examples

Configuration file

This plugin is best used in a configuration file. For example:

# .remarkrc.yaml
plugins:
  - unified-consistency

Programmatic use

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

License

MIT © Remco Haszing

Package Sidebar

Install

npm i unified-consistency

Weekly Downloads

127

Version

2.0.0

License

MIT

Unpacked Size

6.76 kB

Total Files

5

Last publish

Collaborators

  • remcohaszing