Skip to content

Latest commit

 

History

History
80 lines (54 loc) · 2.59 KB

README.md

File metadata and controls

80 lines (54 loc) · 2.59 KB
Raw

retext-case-police

NPM ISC License
VS Code unified
TypeScript Prettier EditorConfig ESLint PRs Welcome

A retext plugin for checking popular names casing.

Examples:

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

For:

Dictionaries are from case-police.

Demo

Demo screenshot of this retext plugin

Quick start

Installation

pnpm install @julian_cataldo/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

import retextCasePolice from '@julian_cataldo/retext-case-police';

// …
  .use(retextCasePolice)
// …

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

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

To do

  • Ignore words
  • 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