Skip to content

feat(devtools): add dataInspector option + lazy-load integrations #1061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danielroe wants to merge 1 commit into from
Open

feat(devtools): add dataInspector option + lazy-load integrations #1061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/devtools-kit/src/_types/options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ export interface ModuleOptions {
*/
viteInspect?: boolean

/**
* Enable the Data Inspector integration, which registers the live
* `Nuxt Application` data source and mounts the Data Inspector panel.
*
* @default true
*/
dataInspector?: boolean

/**
* Disable the DevTools client authorization prompt, allowing any browser to
* connect without approving it first.
Expand Down
1 change: 1 addition & 0 deletions packages/devtools/src/constant.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export const defaultOptions: ModuleOptions = {
enabled: undefined, // determine multiple conditions
componentInspector: true,
viteInspect: true,
dataInspector: true,
codeServer: {
enabled: true,
},
Expand Down
19 changes: 13 additions & 6 deletions packages/devtools/src/module-main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type { AnyNitroConfig } from './utils/nitro-compat'
import { existsSync } from 'node:fs'
import fs from 'node:fs/promises'
import os from 'node:os'
import { NUXT_DEVTOOLS_GROUP_ID } from '@nuxt/devtools-kit'
import { deprecate, NUXT_DEVTOOLS_GROUP_ID } from '@nuxt/devtools-kit'
import { addImports, addPlugin, addTemplate, addVitePlugin, extendViteConfig, logger } from '@nuxt/kit'
import { colors } from 'consola/utils'
import { join } from 'pathe'
Expand Down Expand Up @@ -277,19 +277,26 @@ window.__NUXT_DEVTOOLS_TIME_METRIC__.appInit = Date.now()

await import('./integrations/plugin-metrics').then(({ setup }) => setup(ctx))

// Data Inspector is always mounted when DevTools is enabled (no module
// option): it registers the live `Nuxt Application` source and mounts the
// bundled SPA into the Nuxt dock group.
await import('./integrations/data-inspector').then(({ setup }) => setup(ctx))
if (options.dataInspector !== false)
await import('./integrations/data-inspector').then(({ setup }) => setup(ctx))

if (options.viteInspect !== false)
await import('./integrations/vite-inspect').then(({ setup }) => setup(ctx))

if (options.componentInspector !== false)
await import('./integrations/vue-tracer').then(({ setup }) => setup(ctx))

if (options.codeServer?.enabled === false && options.vscode !== undefined) {
deprecate(nuxt, 'NDT_DEP_0008', {
api: 'devtools.vscode',
replacement: 'devtools.codeServer',
})
}

const integrations = [
import('./integrations/code-server').then(({ setup }) => setup(ctx)),
options.codeServer?.enabled !== false
? import('./integrations/code-server').then(({ setup }) => setup(ctx))
: null,
(options.experimental?.timeline || options.timeline?.enabled)
? import('./integrations/timeline').then(({ setup }) => setup(ctx))
: null,
Expand Down
3 changes: 1 addition & 2 deletions packages/devtools/src/server-rpc/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import type { ModuleOptions, NuxtDevtoolsServerContext, ServerFunctions } from '
import { deprecate, registerHostDiagnostics } from '@nuxt/devtools-kit'
import { logger } from '@nuxt/kit'
import { colors } from 'consola/utils'
import { getServerData } from '../integrations/data-inspector'
import { RPC_NAMESPACE } from '../rpc-namespace'
import { setupAnalyzeBuildRPC } from './analyze-build'
import { setupAssetsRPC } from './assets'
Expand Down Expand Up @@ -165,7 +164,7 @@ export function setupRPC(nuxt: Nuxt, options: ModuleOptions) {
// Deprecated compat shim (NDT_DEP_0009). The capture + live source now live
// in the Data Inspector integration; `getServerConfig` is served by the
// canonical `setupGeneralRPC` above.
getServerData: async () => getServerData(nuxt),
getServerData: async () => import('../integrations/data-inspector').then(({ getServerData }) => getServerData(nuxt)),
} as ServerFunctions)

/**
Expand Down
Loading