Skip to content

feat: ignoreGenerateWarning option #872

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
Niki2k1 wants to merge 2 commits into
base: main
Choose a base branch
from
+21 −7
Open

feat: ignoreGenerateWarning option #872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d592923
feat: ignoreGenerateWarning option
Niki2k1 Mar 17, 2026
4780c09
docs: added ignoreGenrateWarning option
Niki2k1 Mar 17, 2026
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
5 changes: 5 additions & 0 deletions docs/content/docs/1.getting-started/2.installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,11 @@ export default defineNuxtConfig({
::field{name="dir" type="string"}
Default to `'.data'` - The directory used for storage (database, kv, cache, etc.) during local development.
::

::field{name="ignoreGenerateWarning" type="boolean"}
Default to `false` - When generating with `nuxi generate` the default behaviour is to exit with an error because NuxtHub is not designed for static hosting.
In certain scenarios it might be desirable to ignore this warning.
::
::

::tip{icon="i-lucide-rocket"}
Expand Down
22 changes: 15 additions & 7 deletions src/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,9 @@ export default defineNuxtModule<ModuleOptions>({
},
defaults: {},
async setup(options, nuxt) {
// Cannot be used with `nuxt generate`
if (nuxt.options.nitro.static || (nuxt.options as any)._generate) {
log.error('NuxtHub is not compatible with `nuxt generate` as it needs a server to run.')
log.info('To pre-render all pages: `https://hub.nuxt.com/docs/recipes/pre-rendering#pre-render-all-pages`')
return process.exit(1)
}

const rootDir = nuxt.options.rootDir
const hosting = process.env.NITRO_PRESET || nuxt.options.nitro.preset || provider

const hub = defu(options, {
// Local storage
dir: '.data',
Expand All @@ -49,6 +43,20 @@ export default defineNuxtModule<ModuleOptions>({
// resolve the hub directory
hub.dir = await resolveFs(nuxt.options.rootDir, hub.dir)

// Cannot be used with `nuxt generate`
if (
!hub.ignoreGenerateWarning
&& (nuxt.options.nitro.static || (nuxt.options as any)._generate)
) {
log.error(
'NuxtHub is not compatible with `nuxt generate` as it needs a server to run.'
)
log.info(
'To pre-render all pages: `https://hub.nuxt.com/docs/recipes/pre-rendering#pre-render-all-pages`'
)
return process.exit(1)
}

// Create the hub directory
await mkdir(hub.dir, { recursive: true })
.catch((e: any) => {
Expand Down
1 change: 1 addition & 0 deletions src/types/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export interface HubConfig {
kv: boolean | KVConfig
dir: string
hosting: string
ignoreGenerateWarning: boolean
}

export interface ResolvedHubConfig extends HubConfig {
Expand Down