@envsa/prettier-config
v8.0.3
Published
Prettier configuration for @envsa/shared-config.
Downloads
302
Maintainers
Readme
@envsa/prettier-config
Prettier configuration for @envsa/shared-config.
Overview
It's a shared Prettier config.
See @envsa/shared-config
for the recommended single-package approach.
Setup
To use just this Prettier config in isolation:
Install the
.npmrc
in your project root. This is required for correct PNPM behavior:pnpm dlx @envsa/repo-config --init
Add the package:
pnpm add -D @envsa/prettier-config
Add the starter
.prettierrc.js
and.prettierignore
files to your project root, and add any customizations you'd like:pnpm exec prettier-config --init
Usage
The Prettier binary should be picked up automatically by VS Code plugins.
You can call it directly, or use the script bundled with the config.
Integrate with your package.json
scripts as you see fit, for example:
"scripts": {
"lint": "prettier-config --check"
"format": "prettier-config --fix"
}
You might need to pass certain plugins in explicitly. The shared-config --fix
and shared-config --lint
scripts take care of this for you.
CLI
Command: prettier-config
Prettier configuration for @envsa/shared-config.
Usage:
prettier-config [<file|glob> ...]
| Option | Argument | Description |
| ------------------------ | -------- | ---------------------------------------------------------------- |
| --check
-c
| | Check for and report issues. Same as prettier-config
. |
| --fix
-f
| | Fix all auto-fixable issues, and report the un-fixable. |
| --init
-i
| | Initialize by copying starter config files to your project root. |
| --print-config
-p
| <path>
| Print the effective configuration at a certain path. |
| --help
-h
| | Print this help info. |
| --version
-v
| | Print the package version. |
Credits
Eric Mika is the author of the original @kitschpatrol/shared-config project on which this is based.
License
MIT © Liam Rella