Update README.md to add missing information about enabling sourcemaps

filipsobol · Oct 9, 2024 · 6468b98 · 6468b98
1 parent 413c2b3
commit 6468b98
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 6 deletions.
diff --git a/.changeset/early-pots-invite.md b/.changeset/early-pots-invite.md
@@ -0,0 +1,5 @@
+---
+"unplugin-sourcemaps": patch
+---
+
+Update README.md to add missing information about enabling sourcemaps
diff --git a/packages/unplugin-sourcemaps/README.md b/packages/unplugin-sourcemaps/README.md
@@ -12,9 +12,10 @@ Start by installing the package:
 npm install unplugin-sourcemaps --save-dev
 ```
 
-Then register the bundler-specific plugin.
+Then register the bundler-specific plugin and enable the source maps.
 
-### Vite
+<details>
+<summary>Vite</summary>
 
 ```javascript
 // vite.config.js
@@ -25,11 +26,17 @@ import { ViteSourcemap } from 'unplugin-sourcemaps';
 export default defineConfig( {
   plugins: [
     ViteSourcemap()
-  ]
+  ],
+  build: {
+    sourcemap: true
+  }
 } );
 ```
 
-### Rollup
+</details>
+
+<details>
+<summary>esbuild</summary>
 
 ```javascript
 // rollup.config.js
@@ -38,13 +45,20 @@ import { defineConfig } from 'rollup';
 import { RollupSourcemap } from 'unplugin-sourcemaps';
 
 export default defineConfig( {
+  output: {
+    // Other options are skipped for brevity
+    sourcemap: true,
+  },
   plugins: [
     RollupSourcemap()
   ]
 } );
 ```
 
-### esbuild
+</details>
+
+<details>
+<summary>esbuild</summary>
 
 ```javascript
 import { build } from 'esbuild';
@@ -58,7 +72,10 @@ build( {
 } );
 ```
 
-### webpack
+</details>
+
+<details>
+<summary>webpack</summary>
 
 ```javascript
 // webpack.config.js
@@ -72,3 +89,5 @@ module.exports = {
   ],
 };
 ```
+
+</details>