@suemor/prettier-config

A shareable Prettier configuration package for Suemor projects.

Installation

# npm
npm install --save-dev @suemor/prettier-config

# yarn
yarn add --dev @suemor/prettier-config

# pnpm
pnpm add --save-dev @suemor/prettier-config

Usage

Basic Usage

Create a .prettierrc.mjs file in your project root:

import config from '@suemor/prettier-config'

export default config

Custom Configuration

You can customize the configuration by using the defineConfig function:

import { defineConfig } from '@suemor/prettier-config'

export default defineConfig({
  // Override any base configuration options
  semi: true,
  // Control specific plugins
  importSort: true,
  tailwindcss: true,
  // Add custom plugins
  plugins: [
    // Add your custom plugins here
  ],
})

Features

This configuration includes:

• Sensible defaults for modern JavaScript/TypeScript projects
• Import sorting via @ianvs/prettier-plugin-sort-imports
• TailwindCSS class sorting via prettier-plugin-tailwindcss
• Auto-correction support via prettier-plugin-autocorrect
• Shell script formatting via prettier-plugin-sh
• Package.json formatting via prettier-package-json

Peer Dependencies

This package has the following peer dependencies:

prettier >= 3.0.0

You need to install these dependencies in your project:

# npm
npm install --save-dev prettier

# yarn
yarn add --dev prettier

# pnpm
pnpm add --save-dev prettier

Default Configuration

{
  tabWidth: 2,
  printWidth: 80,
  semi: false,
  singleQuote: true,
  trailingComma: 'all',
  arrowParens: 'always',
  endOfLine: 'lf',
}

Options

| Option | Type | Default | Description | | ------------- | ---------------------- | ------- | ---------------------------------------- | | importSort | boolean | true | Enable/disable import sorting | | tailwindcss | boolean | true | Enable/disable TailwindCSS class sorting | | plugins | (string \| Plugin)[] | [] | Add custom plugins |

Plus all standard Prettier configuration options.

License

MIT