Skip to content

feat: automatic HMR code (nuxt only) #2954

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.

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

Draft
wants to merge 2 commits into
base: v3
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 0 additions & 4 deletions packages/nuxt/playground/stores/counter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,3 @@ export const useCounter = defineStore('counter', {
getCount: (state) => state.count,
},
})

if (import.meta.hot) {
import.meta.hot.accept(acceptHMRUpdate(useCounter, import.meta.hot))
}
4 changes: 0 additions & 4 deletions packages/nuxt/playground/stores/nested/some-store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,3 @@ export const useSomeStoreStore = defineStore('some-store', () => {
console.log('I was defined within a nested store directory')
return {}
})

if (import.meta.hot) {
import.meta.hot.accept(acceptHMRUpdate(useSomeStoreStore, import.meta.hot))
}
6 changes: 0 additions & 6 deletions packages/nuxt/playground/stores/with-skip-hydrate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,3 @@ export const useWithSkipHydrateStore = defineStore('with-skip-hydrate', () => {
)
return { skipped }
})

if (import.meta.hot) {
import.meta.hot.accept(
acceptHMRUpdate(useWithSkipHydrateStore, import.meta.hot)
)
}
66 changes: 66 additions & 0 deletions packages/nuxt/src/auto-hmr-plugin.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import type { Nuxt } from 'nuxt/schema'

function getStoreDeclaration(nodes?: import('estree').VariableDeclarator[]) {
return nodes?.find(
(x) =>
x.init?.type === 'CallExpression' &&
x.init.callee.type === 'Identifier' &&
x.init.callee.name === 'defineStore'
)
}

function nameFromDeclaration(node?: import('estree').VariableDeclarator) {
return node?.id.type === 'Identifier' && node.id.name
}

export function autoRegisterHMRPlugin(
nuxt: Nuxt,
{ resolve }: { resolve: (...path: string[]) => string }
) {
const projectBasePath = resolve(nuxt.options.rootDir)

return {
name: 'pinia:auto-hmr-registration',

transform(code, id) {
if (id.startsWith('\x00')) return
if (!id.startsWith(projectBasePath)) return
if (!code.includes('defineStore') || code.includes('acceptHMRUpdate')) {
return
}

const ast = this.parse(code)

// walk top-level nodes
for (const n of ast.body) {
if (
n.type === 'VariableDeclaration' ||
n.type === 'ExportNamedDeclaration'
) {
// find export or variable declaration that uses `defineStore`
const storeDeclaration = getStoreDeclaration(
n.type === 'VariableDeclaration'
? n.declarations
: n.declaration?.type === 'VariableDeclaration'
? n.declaration?.declarations
: undefined
)

// retrieve the variable name
const storeName = nameFromDeclaration(storeDeclaration)
if (storeName) {
// append HMR code
return {
code: [
code,
'if (import.meta.hot) {',
` import.meta.hot.accept(acceptHMRUpdate(${storeName}, import.meta.hot))`,
'}',
].join('\n'),
}
}
}
}
},
} satisfies import('vite').Plugin
}
7 changes: 7 additions & 0 deletions packages/nuxt/src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ import {
addImports,
createResolver,
addImportsDir,
addVitePlugin,
} from '@nuxt/kit'
import type { NuxtModule } from '@nuxt/schema'
import { fileURLToPath } from 'node:url'
import { autoRegisterHMRPlugin } from './auto-hmr-plugin'

export interface ModuleOptions {
/**
Expand Down Expand Up @@ -76,6 +78,11 @@ const module: NuxtModule<ModuleOptions> = defineNuxtModule<ModuleOptions>({
addImportsDir(resolve(nuxt.options.rootDir, storeDir))
}
}

// Register automatic hmr code plugin - dev mode only
if (nuxt.options.dev) {
addVitePlugin(autoRegisterHMRPlugin(nuxt, { resolve }))
}
},
})

Expand Down