remark-preset-wooorm

My personal markdown (and prose) style.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • remarkPresetWooorm
• Checks
• Compatibility
• Related
• Contribute
• License

What is this?

This is a preset for remark to check markdown. It’s used on all the readmes I work on.

When should I use this?

Feel free to use this. But you can also create your own personal style preset.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-preset-wooorm

In Deno with esm.sh:

import remarkPresetWooorm from 'https://esm.sh/remark-preset-wooorm@10'

In browsers with esm.sh:

<script type="module">
  import remarkPresetWooorm from 'https://esm.sh/remark-preset-wooorm@10?bundle'
</script>

Use

import {remark} from 'remark'
import remarkPresetWooorm from 'remark-preset-wooorm'
import {reporter} from 'vfile-reporter'

const file = await remark()
  .use(remarkPresetWooorm)
  .process('This *and* _and_ that.')

console.error(reporter(file))

Yields:

1:7-1:16  warning Unexpected repeated `and`, remove one occurrence                                     and             retext-repeated-words
1:12-1:17 warning Unexpected emphasis marker `_`, expected `*`                                         emphasis-marker remark-lint
1:23      warning Unexpected missing final newline character, expected line feed (`\n`) at end of file final-newline   remark-lint

⚠ 3 warnings

API

This package exports no identifiers. The default export is remarkPresetWooorm. It exports no TypeScript types.

remarkPresetWooorm

Preset to support my personal markdown style (Preset).

Checks

Markdown

• extends remark-preset-lint-recommended, and adds a strict code-style (see index.js)
• checks broken local links
• markdown is compiled with asterisks (*) for list-item bullets and emphasis, and fenced code blocks (note: set output: true in your config to benefit from this)
• how remark compiles can be configured inline with comments
• Contents headers are kept up to date, with a depth of 3 (if output: true)
• GH references, like mentions or issue references, are linked (if output: true)

Natural language

See retext-preset-wooorm for more info.

• English parsing
• two spaces between sentences (but: prefer a line break instead!)
• checks “indefinite articles”: “a” or “an”
• checks quotes and apostrophes ("" > “”)
• checks accidental repeated words
• checks diacritics
• checks redundant acronyms
• checks incorrectly placed apostrophes in contractions

Compatibility

This projects is compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-preset-wooorm@10, compatible with Node.js 16.

Related

• retext-preset-wooorm — personal markdown style

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer