Skip to content

Files

Latest commit

ee79de6 · Apr 6, 2025

History

History

autocorrect

prettier-plugin-autocorrect npm bundle size npm bundle size

An opinionated copywriting formatter plugin for Prettier

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing, taking various rules into account.

This plugin adds support for a lot of files through autocorrect.

Notice

This plugin is still under development, its printer just wraps autocorrect's default printer. Of course it should just work, but may not match prettier's format sometimes.

Requirements

prettier-plugin-autocorrect is an evergreen module. 🌲 This module requires an LTS Node version (v14.0.0+).

Install

Using npm:

# npm
npm i -D prettier prettier-plugin-autocorrect

# yarn
yarn add -D prettier prettier-plugin-autocorrect

Usage

Once installed, Prettier plugins must be added to .prettierrc:

{
  "plugins": ["prettier-plugin-autocorrect"]
}

Then:

# npx
npx prettier --write writing.md

# yarn
yarn prettier --write writing.md

Sponsors

Sponsors

1stG RxTS UnTS
1stG Open Collective sponsors RxTS Open Collective sponsors UnTS Open Collective sponsors

Backers

1stG RxTS UnTS
1stG Open Collective backers RxTS Open Collective backers UnTS Open Collective backers

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

MIT © JounQin@1stG.me