Skip to content

Commit

Permalink
Merge branch 'main' into pr/JessicaSachs/739
Browse files Browse the repository at this point in the history
  • Loading branch information
antfu committed Feb 6, 2025
2 parents 56aa458 + c20c724 commit d4d5175
Show file tree
Hide file tree
Showing 127 changed files with 9,431 additions and 8,026 deletions.
6 changes: 4 additions & 2 deletions .github/workflows/autofix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: corepack enable
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 18
node-version: lts/*
cache: pnpm
- run: npm install -g corepack@latest
- run: corepack enable
- run: pnpm install
- run: pnpm lint --fix
- uses: autofix-ci/action@ea32e3a12414e6d3183163c3424a7d7a8631ad84
Expand Down
12 changes: 7 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,20 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: corepack enable
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 18
node-version: lts/*
cache: pnpm
- run: npm install -g corepack@latest
- run: corepack enable
- run: pnpm install
- run: pnpm lint
- run: pnpm build
- run: pnpm typecheck
- name: Release Edge
- name: Release Nightly
if: github.event_name == 'push' && !contains(github.event.head_commit.message, '[skip-release]')
run: ./scripts/release-edge.sh
run: ./scripts/release-nightly.sh
env:
NPM_CONFIG_PROVENANCE: true
NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN_NIGHTLY}}
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,10 @@ Temporary Items
packages/devtools/README.md

clones

/test-results/
/playwright-report/
/blob-report/
/playwright/.cache/

packages/devtools/client/public/discovery/index.html
147 changes: 147 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,150 @@
# [2.0.0-beta.7](https://github.com/nuxt/devtools/compare/v2.0.0-beta.6...v2.0.0-beta.7) (2025-02-05)


### Bug Fixes

* build analyzer, close [#701](https://github.com/nuxt/devtools/issues/701) ([5ace123](https://github.com/nuxt/devtools/commit/5ace1235dca5086f6d85398f34bb38237048d7f0))



# [2.0.0-beta.6](https://github.com/nuxt/devtools/compare/v2.0.0-beta.5...v2.0.0-beta.6) (2025-02-05)


### Bug Fixes

* vue-devtools runtime injection, close [#667](https://github.com/nuxt/devtools/issues/667) ([1888974](https://github.com/nuxt/devtools/commit/1888974aa0dd00fa72f7884dfc605f66657823d4))



# [2.0.0-beta.5](https://github.com/nuxt/devtools/compare/v2.0.0-beta.4...v2.0.0-beta.5) (2025-02-04)


### Bug Fixes

* downgrade quicktype, bring back schema generator, fix [#753](https://github.com/nuxt/devtools/issues/753) ([7b9dd87](https://github.com/nuxt/devtools/commit/7b9dd8796d7a4629af57baf0432450b03bb209df))
* rpc serialization error with Vite configs ([9033ce2](https://github.com/nuxt/devtools/commit/9033ce2cd5b0aa6ef54b53e29ce0a26139ec6bb6))



# [2.0.0-beta.4](https://github.com/nuxt/devtools/compare/v2.0.0-beta.3...v2.0.0-beta.4) (2025-01-31)



# [2.0.0-beta.3](https://github.com/nuxt/devtools/compare/v2.0.0-beta.2...v2.0.0-beta.3) (2025-01-18)



# [2.0.0-beta.2](https://github.com/nuxt/devtools/compare/v2.0.0-beta.1...v2.0.0-beta.2) (2025-01-16)


### Bug Fixes

* support Nuxt 4 window context format ([0459d44](https://github.com/nuxt/devtools/commit/0459d4459348f25188ebe75f0a5dbce96759fbc5))


### Features

* show module setup time ([a81055d](https://github.com/nuxt/devtools/commit/a81055dfe297fd08ffb1ce9ada3f24220255ce08))
* show the floating panel by default, close [#717](https://github.com/nuxt/devtools/issues/717) ([6108b17](https://github.com/nuxt/devtools/commit/6108b173a7e555e959b9cd70f5676fe774b83053))
* support basic view of resolved options with Discovery.js ([#771](https://github.com/nuxt/devtools/issues/771)) ([59b738c](https://github.com/nuxt/devtools/commit/59b738cead5815a0f677f19bb2e6918bd017c260))
* use slimmer shiki bundle ([91bc060](https://github.com/nuxt/devtools/commit/91bc06030a723e705551806f4f9820fc28145cfd))



# [2.0.0-beta.1](https://github.com/nuxt/devtools/compare/v1.7.0...v2.0.0-beta.1) (2025-01-13)


### Bug Fixes

* component tree format ([f4017f3](https://github.com/nuxt/devtools/commit/f4017f35cd9a959e3cdf3c573db4223d995d372f))
* components graph ([1bae95a](https://github.com/nuxt/devtools/commit/1bae95acec9aef8c3be8035a3675de56abdd446d))
* improve filepath item ui ([8f4ff4a](https://github.com/nuxt/devtools/commit/8f4ff4a0bd96b55692ffceee047c2b45edf04d79))
* **vscode:** set a default value for the vscode host parameter ([#766](https://github.com/nuxt/devtools/issues/766)) ([2e6b4e4](https://github.com/nuxt/devtools/commit/2e6b4e4f7da8f8dc926cc0a9f13cbf6dd1562bac))


### Features

* add copy button for filepath item ([94b3822](https://github.com/nuxt/devtools/commit/94b3822c901ebd1159ba22a4011e1b8c9ef381db))
* allow to customize editor to open, fix [#748](https://github.com/nuxt/devtools/issues/748) ([fe98c80](https://github.com/nuxt/devtools/commit/fe98c8046e88f4bb1ca979c5e8071743286f4ab1))
* enhance module resolution paths for getPackageInfo ([#767](https://github.com/nuxt/devtools/issues/767)) ([04269d0](https://github.com/nuxt/devtools/commit/04269d03b5ce89388528b42f3de8a40a3ddc8bf5))
* migrate to `my-ua-parser` ([a290648](https://github.com/nuxt/devtools/commit/a2906483a42978269e8f831b6e1612cf7821a6a0))
* put vue devtools ui in a separate category ([5b566fb](https://github.com/nuxt/devtools/commit/5b566fbae4da751e044a8aec198cddd82aeacbc1))



# [1.7.0](https://github.com/nuxt/devtools/compare/v1.6.4...v1.7.0) (2024-12-26)


### Features

* improves vscode integration, support multiple backends ([#763](https://github.com/nuxt/devtools/issues/763)) ([463f6ad](https://github.com/nuxt/devtools/commit/463f6adef61f94c0a82495889f06b16ad2d2d55f))



## [1.6.4](https://github.com/nuxt/devtools/compare/v1.6.3...v1.6.4) (2024-12-12)


### Bug Fixes

* upgrade `@vue/devtools` ([8485fcb](https://github.com/nuxt/devtools/commit/8485fcbea2e841c15cdfc4018def83108b49143f))



## [1.6.3](https://github.com/nuxt/devtools/compare/v1.6.2...v1.6.3) (2024-12-03)


### Bug Fixes

* revert [#757](https://github.com/nuxt/devtools/issues/757), pin `vite-plugin-inspect` version ([a399082](https://github.com/nuxt/devtools/commit/a39908296345d8e5941dca320b3dff2244f34532))



## [1.6.2](https://github.com/nuxt/devtools/compare/v1.6.1...v1.6.2) (2024-12-03)


### Bug Fixes

* add v4 compatibility version handeling for pages tab ([#758](https://github.com/nuxt/devtools/issues/758)) ([bd8651c](https://github.com/nuxt/devtools/commit/bd8651cc66d21314f101334527332759f4940035))


### Features

* support `vite-plugin-inspect` for both Vite 5 and 6 ([#757](https://github.com/nuxt/devtools/issues/757)) ([cfcbc24](https://github.com/nuxt/devtools/commit/cfcbc244bfaa3d2d0a647504b422cb35e2419026))



## [1.6.1](https://github.com/nuxt/devtools/compare/v1.6.0...v1.6.1) (2024-11-20)


### Bug Fixes

* missing pinia store modules ([#751](https://github.com/nuxt/devtools/issues/751)) ([be243e4](https://github.com/nuxt/devtools/commit/be243e42e0db1fa9694b9f9c7aa69760e0898cff))


### Features

* apply lint, use explict import ([2c6d2d3](https://github.com/nuxt/devtools/commit/2c6d2d37199ab8419b51c8a56c5eb7d647192787))



# [1.6.0](https://github.com/nuxt/devtools/compare/v1.5.2...v1.6.0) (2024-10-12)


### Bug Fixes

* **devtools:** remove cjs entrypoint ([#746](https://github.com/nuxt/devtools/issues/746)) ([9e4a22e](https://github.com/nuxt/devtools/commit/9e4a22ec73cdde89713e3b046275f4484f62b100))



## [1.5.2](https://github.com/nuxt/devtools/compare/v1.5.1...v1.5.2) (2024-10-02)


### Bug Fixes

* try downgrade `vite-plugin-vue-inspector` ([572a0d6](https://github.com/nuxt/devtools/commit/572a0d60dcc771f820aaa75568269d5e46d997ce))



## [1.5.1](https://github.com/nuxt/devtools/compare/v1.5.0...v1.5.1) (2024-09-23)


Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,12 @@ Unleash Nuxt Developer Experience.

<br>

> [!NOTE]
> You are viewing the v2.x branch which are in active development. For the latest stable version, please refer to the [v1.x branch](https://github.com/nuxt/devtools/tree/v1)
## Installation

> Nuxt DevTools requires **Nuxt v3.9.0 or higher**.
> Nuxt DevTools v2 requires **Nuxt v3.15.0 or higher**.
Nuxt DevTools is **enabled by default** in Nuxt v3.8.0. You can press <kbd>Shift</kbd> + <kbd>Alt</kbd> / <kbd>⇧ Shift</kbd> + <kbd>⌥ Option</kbd> + <kbd>D</kbd> in your app to open it up.

Expand All @@ -41,17 +44,17 @@ export default defineNuxtConfig({
})
```

### Edge Release Channel
### Nightly Release Channel

Similar to [Nuxt's Nightly Channel](https://nuxt.com/docs/guide/going-further/nightly-release-channel#opting-into-the-edge-channel), DevTools also offers an edge release channel, that automatically releases for every commit to `main` branch.
Similar to [Nuxt's Nightly Channel](https://nuxt.com/docs/guide/going-further/nightly-release-channel), DevTools also offers a nightly release channel, that automatically releases for every commit to `main` branch.

You can opt-in to the edge release channel by running:
You can opt-in to the nightly release channel by running:

```diff
{
"devDependencies": {
-- "@nuxt/devtools": "^0.1.0"
++ "@nuxt/devtools": "npm:@nuxt/devtools-edge@latest"
++ "@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```
Expand Down Expand Up @@ -117,7 +120,7 @@ On top of the [default Nuxt Telemetry events](https://github.com/nuxt/telemetry#
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/devtools/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt/devtools
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/devtools.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@nuxt/devtools
[npm-downloads-href]: https://npm.chart.dev/@nuxt/devtools
[license-src]: https://img.shields.io/npm/l/@nuxt/devtools.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@nuxt/devtools
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
Expand Down
12 changes: 7 additions & 5 deletions docs/content/1.guide/0.getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Using Nuxt DevTools in your Nuxt project is only a command away.
## Installation

::callout
Nuxt DevTools requires **Nuxt v3.9.0 or higher**.
Nuxt DevTools v2 requires **Nuxt v3.15.0 or higher**.
::

### Auto Install
Expand All @@ -29,6 +29,8 @@ You can opt-in Nuxt DevTools per-project by going to the project root and run:
npx nuxi@latest devtools enable
```

### Open the DevTools Panel

Restart your Nuxt server and open your app in browser. Click the Nuxt icon on the bottom (or press <kbd>Shift</kbd> + <kbd>Alt</kbd> / <kbd>⇧ Shift</kbd> + <kbd>⌥ Option</kbd> + <kbd>D</kbd>) to toggle the DevTools.

::callout
Expand Down Expand Up @@ -57,17 +59,17 @@ export default defineNuxtConfig({
})
```

### Edge Release Channel
### Nightly Release Channel

Similar to [Nuxt's Edge Channel](https://nuxt.com/docs/guide/going-further/edge-channel#opting-into-the-edge-channel), DevTools also offers an edge release channel, that automatically releases for every commit to `main` branch.
Similar to [Nuxt's Nightly Channel](https://nuxt.com/docs/guide/going-further/nightly-release-channel), DevTools also offers a nightly release channel, that automatically releases for every commit to `main` branch.

You can opt-in to the edge release channel by running:
You can opt-in to the nightly release channel by running:

```diff
{
"devDependencies": {
-- "@nuxt/devtools": "^0.1.0"
++ "@nuxt/devtools": "npm:@nuxt/devtools-edge@latest"
++ "@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```
Expand Down
67 changes: 66 additions & 1 deletion docs/content/1.guide/1.features.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,72 @@ Learn more about [Nitro Storage](https://nitro.unjs.io/guide/storage)

The VS Code Server integration in Nuxt DevTools enhances your development experience by bringing the power of Visual Studio Code directly into your browser. With this feature, you can seamlessly edit and debug your Nuxt projects using the familiar interface of VS Code.

To get started with VS Code Server, follow the installation instructions provided by [Code Server Installation Guide](https://coder.com/docs/code-server/latest/install)
Nuxt DevTools supports the following ways of integrating with VS Code:

### Connecting to an existing code-server instance

Set `reuseExistingServer` to true in runtime config for `devtools/vscode` and set the `port` option to specify a port (defalts to 3080):

```ts [nuxt.config.ts]
export default defineNuxtConfig({
devtools: {
vscode: {
reuseExistingServer: true,
port: 3090
}
}
})
```

### Running a code-server instance locally

You can use either the [Microsoft Visual Studio Code Server](https://code.visualstudio.com/docs/remote/vscode-server) (via the `code` or `code-server` cli tools) or the [Coder VS Code Server](https://coder.com/docs/code-server/latest/install) (via the `code-server` cli tool) by setting the `codeServer` parameter under `devtools/vscode` in the runtime configuration.

Options for the codeServer parameter are:
|Type|Option|
|----|------|
|MS Code CLI|`ms-code-cli`|
|MS Code Server|`ms-code-server`|
|Coder Code Server|`coder-code-server`|

You can set the `port` parameter to listen on a specific port (default 3080) and you can set the `host` parameter if you need to listen on a particular host interface (useful for devcontainers or docker containers that listen on ipv6 by default).

**Example**:

```ts [nuxt.config.ts]
export default defineNuxtConfig({
devtools: {
vscode: {
codeServer: 'ms-code-server',
host: '0.0.0.0',
port: 3090
}
}
})
```

### Remotely via a MS VS Code server tunnel

Set the `mode` option in `devtools/vscode` runtime configuration to `tunnel`. You can set the name of the tunnel to connect to using the `tunnel` option under `devtools/vscode/tunnel` in runtime configuration)

```ts [nuxt.config.ts]
export default defineNuxtConfig({
devtools: {
vscode: {
mode: 'tunnel',
tunnel: {
name: 'my-tunnel-name'
}
}
}
})
```

### Code Server Installation Instructions

To get started with Microsoft VS Code Server, follow the installation instructions provided by [Microsoft Visual Studio Code Server](https://code.visualstudio.com/docs/remote/vscode-server)

To get started with Coder Code Server, follow the installation instructions provided by [Code Server Installation Guide](https://coder.com/docs/code-server/latest/install)

For more information on the benefits and features of VS Code Server, refer to [the official Visual Studio Code blog](https://code.visualstudio.com/blogs/2022/07/07/vscode-server)

Expand Down
2 changes: 1 addition & 1 deletion docs/content/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ sections:
title: Trusted and supported by our<br />amazing community
avatarText: Created and maintained by 50+ contributors
- title: Get started<br><span class="text-primary-400">Now</span>
description: Start using Nuxt DevTools quickly by installing it in your projects in a few lines! <br><i>Nuxt DevTools requires Nuxt v3.9.0 or higher.</i>
description: Start using Nuxt DevTools quickly by installing it in your projects in a few lines!
slot: get-started
button: Read the documentation
Loading

0 comments on commit d4d5175

Please sign in to comment.