@jmlweb/vite-config 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @jmlweb/vite-config
 
+## 0.1.3
+
+### Patch Changes
+
+- 6b73301: Add changelog section with link to CHANGELOG.md in package READMEs
+
+## 0.1.2
+
+### Patch Changes
+
+- 21918eb: Standardize repository field format to object format across all packages and configure syncpack to preserve it.
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -7,16 +7,16 @@
 
 > Base Vite configuration for jmlweb projects. Provides sensible defaults for TypeScript support, build optimization, and development server settings.
 
-## Features
+## ✨ Features
 
-- **Sensible Defaults**: Pre-configured with optimized build and dev server settings
-- **TypeScript Support**: Works seamlessly with TypeScript projects
-- **React Ready**: Optional React integration via plugin injection
-- **Path Aliases**: Easy configuration for module path resolution
-- **Clean API**: Simple functions to create configurations
-- **Fully Typed**: Complete TypeScript support with exported types
+- 🎯 **Sensible Defaults**: Pre-configured with optimized build and dev server settings
+- 📦 **TypeScript Support**: Works seamlessly with TypeScript projects
+- ⚛️ **React Ready**: Optional React integration via plugin injection
+- 📁 **Path Aliases**: Easy configuration for module path resolution
+- 🔧 **Clean API**: Simple functions to create configurations
+- 🛠️ **Fully Typed**: Complete TypeScript support with exported types
 
-## Installation
+## 📦 Installation
 
 ```bash
 npm install --save-dev @jmlweb/vite-config vite
@@ -28,7 +28,9 @@ For React projects, also install the React plugin:
 npm install --save-dev @vitejs/plugin-react
 ```
 
-## Quick Start
+> 💡 **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:
 
@@ -38,7 +40,7 @@ import { createViteConfig } from '@jmlweb/vite-config';
 export default createViteConfig();
 ```
 
-## Examples
+## 💡 Examples
 
 ### Basic Setup
 
@@ -179,7 +181,7 @@ export default createViteConfig({
 });
 ```
 
-## Configuration Details
+## 📋 Configuration Details
 
 ### Default Settings
 
@@ -227,30 +229,109 @@ Creates a Vite configuration optimized for React applications.
 
 **Returns:** A complete Vite `UserConfig` object with React plugin included.
 
-#### `BASE_DEFAULTS`
+#### Exported Constants
+
+- `BASE_DEFAULTS` - Default configuration values for reference
+- `UserConfig`, `Plugin` - Re-exported from Vite
 
-Exported constant containing the default configuration values for reference.
+## 🎯 When to Use
 
-#### `UserConfig`, `Plugin` (re-exported from Vite)
+Use this configuration when you want:
 
-Vite types are re-exported for convenience when extending configurations.
+- ✅ Consistent Vite configuration across multiple projects
+- ✅ Optimized build settings out of the box
+- ✅ Easy integration with React and other plugins
+- ✅ Type-safe configuration with full TypeScript support
+- ✅ A clean, simple API for customization
 
-## When to Use
+## 🔧 Extending the Configuration
 
-Use this configuration when you want:
+You can extend the configuration for your specific needs:
+
+### Adding Custom Plugins
+
+```typescript
+// vite.config.ts
+import { createViteConfig } from '@jmlweb/vite-config';
+import react from '@vitejs/plugin-react';
+import svgr from 'vite-plugin-svgr';
+import { visualizer } from 'rollup-plugin-visualizer';
+
+export default createViteConfig({
+  plugins: [react(), svgr(), visualizer({ open: true })],
+});
+```
+
+### Overriding Build Settings
 
-- Consistent Vite configuration across multiple projects
-- Optimized build settings out of the box
-- Easy integration with React and other plugins
-- Type-safe configuration with full TypeScript support
-- A clean, simple API for customization
+```typescript
+// vite.config.ts
+import { createViteConfig } from '@jmlweb/vite-config';
+
+export default createViteConfig({
+  build: {
+    sourcemap: true,
+    minify: 'terser',
+    rollupOptions: {
+      output: {
+        manualChunks: {
+          vendor: ['react', 'react-dom'],
+        },
+      },
+    },
+  },
+});
+```
 
-## Requirements
+### Environment-Specific Configuration
+
+```typescript
+// vite.config.ts
+import { createViteConfig } from '@jmlweb/vite-config';
+import react from '@vitejs/plugin-react';
+
+export default createViteConfig({
+  plugins: [react()],
+  build: {
+    sourcemap: process.env.NODE_ENV !== 'production',
+  },
+  server: {
+    proxy: {
+      '/api': 'http://localhost:3001',
+    },
+  },
+});
+```
+
+## 📝 Usage with Scripts
+
+Add build scripts to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "typecheck": "tsc --noEmit"
+  }
+}
+```
+
+Then run:
+
+```bash
+npm run dev      # Start development server
+npm run build    # Build for production
+npm run preview  # Preview production build
+```
+
+## 📋 Requirements
 
 - **Node.js** >= 18.0.0
 - **Vite** >= 5.0.0
 
-## Peer Dependencies
+## 📦 Peer Dependencies
 
 This package requires the following peer dependency:
 
@@ -260,13 +341,38 @@ Optional peer dependency for React projects:
 
 - `@vitejs/plugin-react` (for React integration)
 
-## Related Packages
+## 🔗 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
 
-## License
+### 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.1",
+  "version": "0.1.3",
   "description": "Base Vite configuration for jmlweb projects with TypeScript support, build optimization, and optional React integration",
   "type": "module",
   "main": "./dist/index.cjs",