@zeitonline/prettier-config v0.7.2

@zeitonline/prettier-config

This package provides a shared Prettier configuration for ZEIT ONLINE projects.

Installation & Usage

1. Make sure to add the .editorconfig file to your project as well, since prettier picks up a few settings from it:

wget https://raw.githubusercontent.com/zeitonline/frontend-code-style/main/.editorconfig

2. Install the package using npm:

npm install --save-dev @zeitonline/prettier-config

3. Create a .prettierrc.mjs file in the root of your project, import and spread the shared configuration:

import zonPrettierConfig from "@zeitonline/prettier-config";

export default {
    ...zonPrettierConfig,
};

4. (Optional) Add a .prettierignore file to your project to exclude files from formatting, e.g.:

package-lock.json

*.md
*.css
*.scss
*.html
*.yml
*.yaml
*.lock

5. (Optional) Add a format script to your package.json, e.g.:

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

Further Reading

• Prettier Docs