A baseline Prettier configuration used and maintained by members of @homestuck.

🚀 Quick Start

1. Install the package:

npm install --save-dev @homestuck/prettier-config
# or
pnpm add -D @homestuck/prettier-config

2. Add to your project using one of the following supported methods:

Update your project's package.json file:

{
  "name": "your-project",
  "prettier": "@homestuck/prettier-config"
}

Update/Create your project's Prettier configuration YAML or JSON file:

# .prettierrc, .prettierrc.yml, .prettierrc.yaml, .prettierrc.json, or .prettierrc.json5
'@homestuck/prettier-config'

Update/Create your project's Prettier configuration JS (ESModule) file:

// prettier.config.js, .prettierrc.js, prettier.config.mjs, or .prettierrc.mjs
import homestuckPrettierConfig from '@homestuck/prettier-config'

/**
 * @see https://prettier.io/docs/configuration
 * @type {import("prettier").Config}
 */
const config = {
  ...homestuckPrettierConfig,
  // Optional config overrides can be set here.
}

export default config

Update/Create your project's Prettier configuration TS (ESModule) file:

// prettier.config.ts, .prettierrc.ts, prettier.config.mts, or .prettierrc.mts
import type { Config } from 'prettier'

import baseConfig from '@homestuck/prettier-config'

const config: Config = {
  ...baseConfig,
  // Additional configs and overrides can optionally be set here.
}

export default config