https://github.com/creeation/prettier-config
Repository holding my personal Prettier configuration.
https://github.com/creeation/prettier-config
creeation prettier prettier-config prettierconfig
Last synced: 2 months ago
JSON representation
Repository holding my personal Prettier configuration.
- Host: GitHub
- URL: https://github.com/creeation/prettier-config
- Owner: CREEATION
- License: mit
- Created: 2020-12-06T18:56:47.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-08-07T08:20:32.000Z (almost 4 years ago)
- Last Synced: 2024-04-26T07:21:53.787Z (over 2 years ago)
- Topics: creeation, prettier, prettier-config, prettierconfig
- Language: Shell
- Homepage: https://npm.im/@creeation/prettier-config
- Size: 138 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @creeation/prettier-config
[](https://www.npmjs.com/package/@creeation/prettier-config)
[](https://www.npmjs.com/package/prettier)
[](./LICENSE)
Repository holding my personal Prettier configuration.
## Installation
```console
npm i -D @creeation/prettier-config
```
Then, in your `package.json`, set `prettier` to `@creeation/prettier-config`:
```json
{
"prettier": "@creeation/prettier-config"
}
```
## Configuring Prettier
- [Options](https://prettier.io/docs/en/options.html)
- [Configuration File](https://prettier.io/docs/en/configuration.html)
## Package Development Scripts and Hooks
### [Git Hooks](https://git-scm.com/docs/githooks) (using [Husky](https://typicode.github.io/husky/) and [pretty-quick](https://github.com/azz/pretty-quick))
#### `pre-commit`
```console
$ npm run git:pre-commit
```
### npm [Scripts](https://docs.npmjs.com/cli/v7/using-npm/scripts)
#### `test`
Checks if package files are formatted correctly using Prettier
> _Note: bound to [`prepublishOnly`](https://docs.npmjs.com/cli/v7/using-npm/scripts#life-cycle-scripts)_
```console
$ npm test
```
#### `format`
Formats and saves all package files using Prettier
```console
$ npm run format
```
### npm [Life Cycle Scripts](https://docs.npmjs.com/cli/v7/using-npm/scripts#life-cycle-operation-order)
#### [`postinstall`](https://docs.npmjs.com/cli/v7/using-npm/scripts#npm-install)
```console
$ npx husky install
```
#### [`prepublishOnly`](https://docs.npmjs.com/cli/v7/using-npm/scripts#npm-publish)
```console
$ npm test && npx pinst --disable
```
#### [`postpublish`](https://docs.npmjs.com/cli/v7/using-npm/scripts#npm-publish)
```console
$ npx pinst --enable
```