Skip to content

Commit 40bc2fd

Browse files
authored
Fixed README.md to update process for enabling babel plugin at overlay. (#334)
2 parents 9f97f87 + 2010f72 commit 40bc2fd

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

.changeset/dull-sloths-bow.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@solid-devtools/overlay": patch
3+
---
4+
5+
Fixed README.md to update process for enabling babel plugin at overlay.

packages/overlay/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ attachDevtoolsOverlay({
5151

5252
Don't worry about wrapping it with a `isDev` guard, the Overlay takes care of that for you. It should be excluded from production builds automatically.
5353

54-
### Enabling the Babel plugin
54+
### Enabling the autoname
5555

56-
Enabling the [babel plugin](https://github.com/thetarnav/solid-devtools/tree/main/packages/transform#readme) is optional, but can offer some extra improvements.
56+
Enabling the autoname setting is optional, but can display name of SolidJS's reactive state in overlay.
5757

5858
To enable it you need to add it to plugins array in your `.vite.config.ts` file:
5959

@@ -62,19 +62,19 @@ To enable it you need to add it to plugins array in your `.vite.config.ts` file:
6262

6363
import { defineConfig } from 'vite'
6464
import solid from 'vite-plugin-solid'
65-
import devtools from '@solid-devtools/transform'
65+
import devtools from 'solid-devtools/vite'
6666

6767
export default defineConfig({
6868
plugins: [
6969
devtools({
70-
name: true,
70+
autoname: true,
7171
}),
7272
solid(),
7373
],
7474
})
7575
```
7676

77-
[**See transform options**](https://github.com/thetarnav/solid-devtools/tree/main/packages/transform#options)
77+
[**See vite plugin**](https://github.com/thetarnav/solid-devtools/blob/main/packages/main/src/vite/vite.ts)
7878

7979
## Changelog
8080

0 commit comments

Comments
 (0)