@jmlweb/prettier-config-base 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @jmlweb/prettier-config-base
 
+## 1.0.5
+
+### Patch Changes
+
+- 30f8ffb: Add "Why Use This?" sections to package READMEs explaining configuration philosophy and design decisions
+
+## 1.0.4
+
+### Patch Changes
+
+- 4a9ece1: Update documentation to use pnpm commands instead of npm
+
 ## 1.0.3
 
 ### Patch Changes

package/README.md

@@ -16,7 +16,7 @@
 ## 📦 Installation
 
 ```bash
-npm install --save-dev @jmlweb/prettier-config-base prettier
+pnpm add -D @jmlweb/prettier-config-base prettier
 ```
 
 > 💡 **Upgrading from a previous version?** See the [Migration Guide](#-migration-guide) for breaking changes and upgrade instructions.
@@ -88,6 +88,38 @@ function greet(user) {
 }
 ```
 
+## 🤔 Why Use This?
+
+> **Philosophy**: Stop arguing about code style. Let Prettier handle formatting so you can focus on writing code.
+
+This package provides an opinionated Prettier configuration that prioritizes readability and modern JavaScript conventions. The goal is to eliminate formatting debates and establish consistent code style across all projects.
+
+### Design Decisions
+
+**Semicolons (`semi: true`)**: Always use semicolons
+
+- **Why**: Prevents ASI (Automatic Semicolon Insertion) edge cases and ambiguity
+- **Trade-off**: Slightly more verbose, but eliminates an entire class of potential bugs
+- **When to override**: If your team strongly prefers semicolon-free style and understands ASI rules
+
+**Single Quotes (`singleQuote: true`)**: Use single quotes for strings
+
+- **Why**: Consistent with most modern JavaScript codebases and requires less escaping in JSX
+- **Trade-off**: None significant - purely stylistic choice for consistency
+- **When to override**: If working in a codebase that already uses double quotes
+
+**Trailing Commas (`trailingComma: 'all'`)**: Add trailing commas everywhere possible
+
+- **Why**: Cleaner git diffs (changes only affect modified lines) and easier to add items without modifying previous line
+- **Trade-off**: Slightly unusual for developers from other languages, but widely adopted in modern JS
+- **When to override**: If targeting older environments that don't support trailing commas (rare with modern transpilation)
+
+**2 Spaces Indentation (`tabWidth: 2`)**: Use 2 spaces for indentation
+
+- **Why**: Balances readability with horizontal space, standard in JavaScript ecosystem
+- **Trade-off**: May feel cramped compared to 4 spaces, but prevents excessive nesting visibility
+- **When to override**: If your team or organization has standardized on 4 spaces
+
 ## 🎯 When to Use
 
 Use this package when you want:
@@ -131,8 +163,8 @@ Add formatting scripts to your `package.json`:
 Then run:
 
 ```bash
-npm run format        # Format all files
-npm run format:check  # Check formatting without modifying files
+pnpm format        # Format all files
+pnpm format:check  # Check formatting without modifying files
 ```
 
 ## 📋 Requirements
@@ -187,7 +219,7 @@ See real-world usage examples:
 Install `eslint-config-prettier` to disable conflicting ESLint rules:
 
 ```bash
-npm install --save-dev eslint-config-prettier
+pnpm add -D eslint-config-prettier
 ```
 
 Then add it to your ESLint config (must be last):
@@ -255,7 +287,7 @@ For VS Code, install the Prettier extension and add to `.vscode/settings.json`:
 To verify Prettier finds your config:
 
 ```bash
-npx prettier --find-config-path src/index.ts
+pnpm exec prettier --find-config-path src/index.ts
 ```
 
 ## 🔄 Migration Guide

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jmlweb/prettier-config-base",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Base Prettier configuration for jmlweb projects",
   "type": "module",
   "main": "./dist/index.cjs",