https://github.com/pyk/prettier-config
pyk's personal prettier configuration
https://github.com/pyk/prettier-config
prettier prettier-config prettierrc
Last synced: about 2 months ago
JSON representation
pyk's personal prettier configuration
- Host: GitHub
- URL: https://github.com/pyk/prettier-config
- Owner: pyk
- Created: 2022-09-26T13:54:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-26T14:10:01.000Z (over 3 years ago)
- Last Synced: 2025-03-08T18:05:18.590Z (over 1 year ago)
- Topics: prettier, prettier-config, prettierrc
- Language: JavaScript
- Homepage: https://pyk.sh/create-shareable-prettier-configuration/
- Size: 6.84 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
@pyk/prettier-config
pyk's personal [Prettier](https://pyk.sh/what-is-prettier) configuration.
### Installation
Use the following command to install `@pyk/prettier-config`:
```sh
# npm
npm install --save-dev --save-exact prettier @pyk/prettier-config@latest
# pnpm
pnpm add --save-dev --save-exact prettier @pyk/prettier-config@latest
```
### Usage
Add the following fields in your `package.json`:
```json
{
"scripts": {
"prettier:check": "prettier --check ."
"prettier:write": "prettier --write ."
},
"prettier": "@pyk/prettier-config"
}
```
> **Note** You can ignore files by adding it to `.prettierignore`.
Then you can use `pnpm prettier:check` or `npm run prettier:check` to check the
file formatting.
### Development
Clone the repo:
```shell
git clone git@github.com:pyk/prettier-config.git
cd prettier-config/
```
Install the dependencies:
```shell
pnpm install
```
Publish the package:
```shell
pnpm publish --tag latest
```
### Resources
- [What is prettier?](https://pyk.sh/what-is-prettier)
- [How to create shareable or reusable prettier configuration](https://pyk.sh/create-shareable-prettier-configuration/)