@jmlweb/prettier-config-tailwind 1.0.2 → 1.0.4

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @jmlweb/prettier-config-tailwind
 
+## 1.0.4
+
+### Patch Changes
+
+- 4a9ece1: Update documentation to use pnpm commands instead of npm
+- Updated dependencies [4a9ece1]
+  - @jmlweb/prettier-config-base@1.0.4
+
+## 1.0.3
+
+### Patch Changes
+
+- 6b73301: Add changelog section with link to CHANGELOG.md in package READMEs
+- Updated dependencies [6b73301]
+  - @jmlweb/prettier-config-base@1.0.3
+
 ## 1.0.2
 
 ### Patch Changes

package/README.md

@@ -16,11 +16,13 @@
 ## 📦 Installation
 
 ```bash
-npm install --save-dev @jmlweb/prettier-config-tailwind prettier prettier-plugin-tailwindcss
+pnpm add -D @jmlweb/prettier-config-tailwind prettier prettier-plugin-tailwindcss
 ```
 
 **Note**: The `prettier-plugin-tailwindcss` plugin must be installed as a dev dependency.
 
+> 💡 **Upgrading from a previous version?** See the [Migration Guide](#-migration-guide) for breaking changes and upgrade instructions.
+
 ## 🚀 Quick Start
 
 ### Option 1: Using `package.json` (Recommended)
@@ -82,6 +84,32 @@ This package extends `@jmlweb/prettier-config-base` and adds:
   - And all other base settings
 - ✅ `prettier-plugin-tailwindcss` - Automatically sorts Tailwind CSS classes
 
+## 🤔 Why Use This?
+
+> **Philosophy**: Tailwind class order should be consistent and automatic. Don't waste time manually organizing utility classes.
+
+This package extends the base Prettier config with Tailwind-specific class sorting. Following Tailwind's recommended class order improves readability and makes it easier to scan markup quickly.
+
+### Design Decisions
+
+**Automatic Class Sorting**: Uses the official `prettier-plugin-tailwindcss`
+
+- **Why**: Tailwind's recommended order groups related utilities together (layout → spacing → typography → visual effects), making classes easier to read and understand at a glance
+- **Trade-off**: Initial formatting may reorder classes you've manually organized, but consistency across the codebase outweighs individual preferences
+- **When to override**: If you have a strong reason to deviate from Tailwind's official recommendations (rare)
+
+**Plugin Load Order**: The Tailwind plugin is loaded last in Prettier's plugin chain
+
+- **Why**: Ensures Tailwind class sorting doesn't conflict with other Prettier plugins and runs after all other formatting
+- **Trade-off**: None - this is the recommended approach by Tailwind Labs
+- **When to override**: Never - this is a technical requirement, not a stylistic choice
+
+**Extends Base Config**: Inherits all settings from `@jmlweb/prettier-config-base`
+
+- **Why**: Maintains consistency with non-Tailwind projects while adding Tailwind-specific features
+- **Trade-off**: If you need to change base formatting rules, you must override the base config settings
+- **When to override**: When you need different base Prettier settings than the standard config
+
 ## 🎯 When to Use
 
 Use this package when:
@@ -124,8 +152,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
@@ -150,9 +178,33 @@ See real-world usage examples:
 
 ## 🔗 Related Packages
 
+### Internal Packages
+
 - [`@jmlweb/prettier-config-base`](../prettier-config-base) - Base Prettier configuration (extended by this package)
 - [`@jmlweb/eslint-config-base`](../eslint-config-base) - ESLint config for TypeScript projects
 
+### External Tools
+
+- [Prettier](https://prettier.io/) - Opinionated code formatter
+- [Tailwind CSS](https://tailwindcss.com/) - Utility-first CSS framework
+- [prettier-plugin-tailwindcss](https://github.com/tailwindlabs/prettier-plugin-tailwindcss) - Official Tailwind class sorting plugin
+
+## 🔄 Migration Guide
+
+### Upgrading to a New Version
+
+> **Note:** If no breaking changes were introduced in a version, it's safe to upgrade without additional steps.
+
+**No breaking changes have been introduced yet.** This package follows semantic versioning. When breaking changes are introduced, detailed migration instructions will be provided here.
+
+For version history, see the [Changelog](./CHANGELOG.md).
+
+**Need Help?** If you encounter issues during migration, please [open an issue](https://github.com/jmlweb/tooling/issues/new).
+
+## 📜 Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md) for version history and release notes.
+
 ## 📄 License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jmlweb/prettier-config-tailwind",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Prettier configuration for jmlweb projects with Tailwind CSS support",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -49,7 +49,7 @@
   },
   "dependencies": {
     "prettier-plugin-tailwindcss": "^0.7.2",
-    "@jmlweb/prettier-config-base": "1.0.2"
+    "@jmlweb/prettier-config-base": "1.0.4"
   },
   "devDependencies": {
     "prettier": "^3.3.3",