@king-3/prettier-config

A minimal and opinionated Prettier config preset with sensible defaults.

English | 中文

Features

• 📏 2 spaces indentation - Consistent and readable
• 🚫 No semicolons - Cleaner code style
• ✨ Single quotes - Less visual noise
• 📝 No trailing commas - Simplified syntax
• 🎯 Smart ignore patterns - Automatically skips common build artifacts and lock files

Installation

Quick Setup

pnpm add -D prettier @king-3/prettier-config

Create a prettier.config.mjs file in your project root:

// prettier.config.mjs
import king3 from '@king-3/prettier-config'

export default king3()

Add Format Scripts

Add these scripts to your package.json:

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

Then run:

pnpm format        # Format all files
pnpm format:check  # Check formatting without modifying files

Configuration

Default Settings

{
  "printWidth": 80,
  "semi": false,
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "none",
  "useTabs": false
}

Custom Configuration

Override any default setting:

// prettier.config.mjs
import { king3 } from '@king-3/prettier-config'

export default king3({
  printWidth: 120,
  semi: true
  // ... other Prettier options
})

Ignored Files

The following patterns are automatically ignored:

**/node_modules/**
**/dist/**
**/coverage/**
**/temp/**
**/.vitepress/cache/**
**/.nuxt/**
**/.vercel/**
**/.changeset/**
**/.idea/**
**/.output/**
**/.vite-inspect/**
output/**
**/CHANGELOG*.md
**/*.min.*
**/LICENSE*
**/__snapshots__
**/auto-import?(s).d.ts
**/components.d.ts
**/typed-router.d.ts
**/pnpm-lock.yaml

Editor Integration

VS Code

Install the Prettier extension and add to your .vscode/settings.json:

{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true
}

License

MIT License © 2025-PRESENT king3