retext-case-police


A retext plugin for checking popular names casing.

Examples:

- ⚠️ macbook → ✅ MacBook
- ⚠️ MacOS → ✅ macOS
- 🤔…
- ⚠️ ESBuild → ✅ esbuild
- ⚠️ eslint → ✅ ESLint
- 😭…

For:

- Abbreviates
- Brands
- General
- Products
- Softwares

---

Dictionaries are from case-police.

Demo

!Demo screenshot of this retext plugin

Quick start

Installation

``sh
pnpm install retext-case-police
`

> Note: 100% ESM, including dependencies
> For Node.js 17 and higher (using JSON import assertions) or with --experimental-json-modules flag with Node 16.

Usage

`ts
import retextCasePolice from 'retext-case-police';

// …
.use(retextCasePolice)
// …

// ——————— With options ————v

// Ignore words
.use(retextCasePolice, { ignore: ['GitHub'] })

`

To do

- [x] Ignore words
- [x] Resolve Parcel stripping out assert { type: 'json' }
- [ ] Ignore links (e.g https://` wrongly flagged)
- [ ] Custom dictionaries embedding?

---

See CHANGELOG.md for release history.

---

🔗  JulianCataldo.com