Broxus Prettier config

Recommended Prettier configuration to create formatted code with best practices.

Installation

Install the package as development dependency, alongside prettier package

npm i @broxus/prettier-config prettier -D

yarn add @broxus/prettier-config prettier -D

pnpm add @broxus/prettier-config prettier -D

bun add @broxus/prettier-config prettier -D

Usage

In your package.json, add the following:

{
    ...
    "prettier": "@broxus/prettier-config",
    "hysky": {
        "hooks": {
            "pre-commit": "npx lint-staged"
        }
    }
    ...
}

If you need to change or add any other config to the prettier, you must remove the prettier option on package.json and create a .prettierrc.js or prettier.config.js file with the following content:

module.exports = {
    ...require('@broxus/prettier-config')
    // some overrides if needed
}

[!TIP] Alternatively, you can create a .prettierrc or prettier.config file in any supported format, such as: .prettierrc.js, .prettierrc.ts, .prettierrc.cjs, .prettierrc.cts, prettierrc.mjs, prettierrc.mts, prettier.config.js, prettier.config.ts, prettier.config.cjs, prettier.config.cts, prettier.config.mjs, prettier.config.mts