@readme/standards

Core coding standards for ReadMe projects.

Configs

| Config | Description | | :-- | :--- | | @readme/standards/biome | For projects that use Biome. | | @readme/standards/biome/esm | — addon for ESM-only repositories.† | | @readme/standards/biome/react | — addon for React codebases.†‡ | | @readme/standards/prettier | For projects that use Prettier. |

† This requires also using @readme/standards/biome.

‡ Though Biome supports linting React and JSX by default this supplemental is for additional rules that should apply only within React packages.

Biome

Installation

npm install --save-dev @biomejs/biome @readme/standards

Usage

Create a biome.jsonc file with the following contents:

{
  "extends": [
    "@readme/standards/biome"
    // "@readme/standards/biome/<supplemental>"
  ]
}

By default this config does not enable auto-formatting. If you need that enabled you will have to turn it on with:

{
  "formatter": {
    "enabled": true
  }
}

[!NOTE] If you do use auto-formatting with Biome we recommend not also using @readme/standards/prettier as they two may collide.

Prettier

Installation

npm install --save-dev prettier @readme/standards

Usage

Add the following into your package.json:

"prettier": "@readme/standards/prettier"

[!NOTE] If you use Biome and Prettier we recommend disabling Biome's auto-formatting by setting formatter.enabled to false as the two may collide.