@jmlweb/vite-config 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @jmlweb/vite-config
 
+## 0.1.4
+
+### Patch Changes
+
+- 4a9ece1: Update documentation to use pnpm commands instead of npm
+
+## 0.1.3
+
+### Patch Changes
+
+- 6b73301: Add changelog section with link to CHANGELOG.md in package READMEs
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -19,15 +19,17 @@
 ## 📦 Installation
 
 ```bash
-npm install --save-dev @jmlweb/vite-config vite
+pnpm add -D @jmlweb/vite-config vite
 ```
 
 For React projects, also install the React plugin:
 
 ```bash
-npm install --save-dev @vitejs/plugin-react
+pnpm add -D @vitejs/plugin-react
 ```
 
+> 💡 **Upgrading from a previous version?** See the [Migration Guide](#-migration-guide) for breaking changes and upgrade instructions.
+
 ## 🚀 Quick Start
 
 Create a `vite.config.ts` file in your project root:
@@ -179,6 +181,38 @@ export default createViteConfig({
 });
 ```
 
+## 🤔 Why Use This?
+
+> **Philosophy**: Modern build tools should provide instant feedback during development and optimized production builds with zero configuration.
+
+This package provides a Vite configuration that balances development speed with production optimization. It leverages Vite's native ESM dev server for instant HMR and esbuild for ultra-fast production builds, while remaining flexible enough for any project type.
+
+### Design Decisions
+
+**ESBuild Minification (`minify: 'esbuild'`)**: Fast production builds
+
+- **Why**: esbuild is orders of magnitude faster than terser while producing comparably small bundles. For most projects, the speed improvement far outweighs the minimal size difference. This keeps build times fast even for large applications
+- **Trade-off**: Terser can sometimes achieve slightly smaller bundles (1-3%). But esbuild's speed is almost always worth it
+- **When to override**: For bundle size-critical applications where every byte matters, consider terser. But try esbuild first
+
+**ESNext Target (`target: 'esnext'`)**: Modern JavaScript output
+
+- **Why**: Vite assumes modern browsers by default. Using esnext target produces the smallest, most performant code because it doesn't transpile modern features browsers already support. Your bundler only polyfills what's actually needed
+- **Trade-off**: Won't work in older browsers without additional configuration. But Vite is designed for modern development
+- **When to override**: For projects supporting older browsers - set specific targets like `['es2020', 'chrome87', 'firefox78']`
+
+**No Source Maps by Default (`sourcemap: false`)**: Faster production builds
+
+- **Why**: Source maps are valuable for debugging but significantly increase build time and bundle size. Most production deployments don't need them. Enable per-project when needed for production debugging or error tracking services
+- **Trade-off**: Harder to debug production issues. But you can enable source maps easily when needed
+- **When to override**: For production debugging or when using error tracking services (Sentry, etc.) - set `sourcemap: true`
+
+**Port Flexibility (`strictPort: false`)**: Development convenience
+
+- **Why**: If the default port is in use, Vite automatically finds an available port instead of failing. This is convenient when running multiple projects or when the port is already taken
+- **Trade-off**: Port might change between runs if default is busy. But Vite tells you the actual port
+- **When to override**: For projects that must run on a specific port (e.g., configured in OAuth callbacks) - set `strictPort: true`
+
 ## 📋 Configuration Details
 
 ### Default Settings
@@ -319,9 +353,9 @@ Add build scripts to your `package.json`:
 Then run:
 
 ```bash
-npm run dev      # Start development server
-npm run build    # Build for production
-npm run preview  # Preview production build
+pnpm dev      # Start development server
+pnpm build    # Build for production
+pnpm preview  # Preview production build
 ```
 
 ## 📋 Requirements
@@ -341,11 +375,36 @@ Optional peer dependency for React projects:
 
 ## 🔗 Related Packages
 
+### Internal Packages
+
 - [`@jmlweb/tsconfig-react`](../tsconfig-react) - TypeScript config for React projects
 - [`@jmlweb/eslint-config-react`](../eslint-config-react) - ESLint config for React projects
 - [`@jmlweb/vitest-config`](../vitest-config) - Vitest configuration for testing
 - [`@jmlweb/prettier-config-base`](../prettier-config-base) - Prettier config for consistent formatting
 
+### External Tools
+
+- [Vite](https://vite.dev/) - Next-generation frontend tooling
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react) - Official React plugin for Vite
+- [vite-plugin-svgr](https://github.com/pd4d10/vite-plugin-svgr) - SVG to React component transform
+- [rollup-plugin-visualizer](https://github.com/btd/rollup-plugin-visualizer) - Visualize bundle size
+
+## 🔄 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/vite-config",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Base Vite configuration for jmlweb projects with TypeScript support, build optimization, and optional React integration",
   "type": "module",
   "main": "./dist/index.cjs",