Prettier

Prettier is an opinionated code formatter.

If you used the CLI method to install Minze you can extend your environment with auto-code formatting quite quickly.

The following guide is based on a fresh Minze CLI installation.

1. Install dependencies.

npm

$ npm add -D prettier

yarn

$ yarn add -D prettier

pnpm

$ pnpm add -D prettier

bun

$ bun add -D prettier

2. Add format script to package.json.

package.json

{
  "scripts": {
    // ...
    "format": "prettier --write --cache ."
  }
}

2. Create and populate .prettierignore and .prettierrc.json files.

files

├─ src/
├─ ...
├─ .prettierignore // [!code ++]
└─ .prettierrc.json // [!code ++]

.prettierignore

dist
package-lock.json
.*cache
cache
*.d.ts
*.mdx
*.dev.html
storybook

.prettierrc.json

{
  "$schema": "https://json.schemastore.org/prettierrc",
  "singleQuote": true,
  "semi": false,
  "trailingComma": "none"
}

3. Format your code.

npm

$ npm run format

yarn

$ yarn run format

pnpm

$ pnpm run format

bun

$ bun run format

TIP

For more details about Prettier refer to the Prettier docs.