Skip to content

fix(dev,preview,typecheck): use explicit --dotenv filename #381

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

Merged
merged 11 commits into from
Apr 3, 2025
Merged
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
5 changes: 3 additions & 2 deletions packages/nuxi/src/commands/dev-child.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { isTest } from 'std-env'
import { _getDevServerDefaults, _getDevServerOverrides, createNuxtDevServer } from '../utils/dev'
import { overrideEnv } from '../utils/env'
import { logger } from '../utils/logger'
import { cwdArgs, envNameArgs, legacyRootDirArgs, logLevelArgs } from './_shared'
import { cwdArgs, dotEnvArgs, envNameArgs, legacyRootDirArgs, logLevelArgs } from './_shared'

export default defineCommand({
meta: {
Expand All @@ -21,6 +21,7 @@ export default defineCommand({
...cwdArgs,
...logLevelArgs,
...envNameArgs,
...dotEnvArgs,
...legacyRootDirArgs,
},
async run(ctx) {
Expand Down Expand Up @@ -71,7 +72,7 @@ export default defineCommand({
defaults: devServerDefaults,
logLevel: ctx.args.logLevel as 'silent' | 'info' | 'verbose',
clear: !!ctx.args.clear,
dotenv: !!ctx.args.dotenv,
dotenv: { cwd, fileName: ctx.args.dotenv },
envName: ctx.args.envName,
port: process.env._PORT ?? undefined,
devContext,
Expand Down
8 changes: 5 additions & 3 deletions packages/nuxi/src/commands/dev.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import type { NuxtDevContext, NuxtDevIPCMessage } from '../utils/dev'
import { fork } from 'node:child_process'
import process from 'node:process'

import { setupDotenv } from 'c12'
import { defineCommand } from 'citty'
import defu from 'defu'
import { createJiti } from 'jiti'
Expand Down Expand Up @@ -88,12 +87,12 @@ const command = defineCommand({
overrideEnv('development')
const cwd = resolve(ctx.args.cwd || ctx.args.rootDir)
await showVersions(cwd)
await setupDotenv({ cwd, fileName: ctx.args.dotenv })

// Load Nuxt Config
const { loadNuxtConfig } = await loadKit(cwd)
const nuxtOptions = await loadNuxtConfig({
cwd,
dotenv: { cwd, fileName: ctx.args.dotenv },
envName: ctx.args.envName, // c12 will fall back to NODE_ENV
overrides: {
dev: true,
Expand Down Expand Up @@ -131,7 +130,10 @@ const command = defineCommand({
defaults: devServerDefaults,
logLevel: ctx.args.logLevel as 'silent' | 'info' | 'verbose',
clear: ctx.args.clear,
dotenv: !!ctx.args.dotenv,
dotenv: {
cwd,
fileName: ctx.args.dotenv,
},
envName: ctx.args.envName,
loadingTemplate: nuxtOptions.devServer.loadingTemplate,
devContext: {},
Expand Down
13 changes: 8 additions & 5 deletions packages/nuxi/src/commands/preview.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,18 @@ const command = defineCommand({
),
)

const envExists = ctx.args.dotenv
? existsSync(resolve(cwd, ctx.args.dotenv))
: existsSync(cwd)
const envFileName = ctx.args.dotenv || '.env'

const envExists = existsSync(resolve(cwd, envFileName))

if (envExists) {
logger.info(
`Loading \`${ctx.args.dotenv || '.env'}\`. This will not be loaded when running the server in production.`,
`Loading \`${envFileName}\`. This will not be loaded when running the server in production.`,
)
await setupDotenv({ cwd, fileName: ctx.args.dotenv })
await setupDotenv({ cwd, fileName: envFileName })
}
else {
logger.error(`Cannot find \`${envFileName}\`.`)
}

const { port } = _resolveListenOptions(ctx.args)
Expand Down
4 changes: 3 additions & 1 deletion packages/nuxi/src/commands/typecheck.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { isBun } from 'std-env'
import { x } from 'tinyexec'

import { loadKit } from '../utils/kit'
import { cwdArgs, legacyRootDirArgs, logLevelArgs } from './_shared'
import { cwdArgs, dotEnvArgs, legacyRootDirArgs, logLevelArgs } from './_shared'

export default defineCommand({
meta: {
Expand All @@ -18,6 +18,7 @@ export default defineCommand({
args: {
...cwdArgs,
...logLevelArgs,
...dotEnvArgs,
...legacyRootDirArgs,
},
async run(ctx) {
Expand All @@ -28,6 +29,7 @@ export default defineCommand({
const { loadNuxt, buildNuxt, writeTypes } = await loadKit(cwd)
const nuxt = await loadNuxt({
cwd,
dotenv: { cwd, fileName: ctx.args.dotenv },
overrides: {
_prepare: true,
logLevel: ctx.args.logLevel as 'silent' | 'info' | 'verbose',
Expand Down
9 changes: 7 additions & 2 deletions packages/nuxi/src/utils/dev.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { Nuxt, NuxtConfig } from '@nuxt/schema'
import type { DotenvOptions } from 'c12'
import type { FSWatcher } from 'chokidar'
import type { Jiti } from 'jiti'
import type { HTTPSOptions, Listener, ListenOptions, ListenURL } from 'listhen'
Expand Down Expand Up @@ -45,7 +46,7 @@ export interface NuxtDevContext {
interface NuxtDevServerOptions {
cwd: string
logLevel?: 'silent' | 'info' | 'verbose'
dotenv: boolean
dotenv: DotenvOptions
envName?: string
clear?: boolean
defaults: NuxtConfig
Expand Down Expand Up @@ -197,6 +198,10 @@ class NuxtDevServer extends EventEmitter {
dev: true,
ready: false,
envName: this.options.envName,
dotenv: {
cwd: this.options.cwd,
fileName: this.options.dotenv.fileName,
},
defaults: defu(this.options.defaults, devServerDefaults),
overrides: {
logLevel: this.options.logLevel as 'silent' | 'info' | 'verbose',
Expand Down Expand Up @@ -321,7 +326,7 @@ class NuxtDevServer extends EventEmitter {
return
}
const file = relative(this.options.cwd, _file)
if (file === (this.options.dotenv || '.env')) {
if (file === (this.options.dotenv.fileName || '.env')) {
this.emit('restart')
}
if (RESTART_RE.test(file)) {
Expand Down