Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(nuxt): resolve nitro config entries in layers (nuxt aliases) #26679

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 34 additions & 4 deletions packages/nuxt/src/core/nitro.ts
Original file line number Diff line number Diff line change
Expand Up @@ -153,10 +153,7 @@ export async function initNitro (nuxt: Nuxt & { _nitro?: Nitro }) {
maxAge: 31536000 /* 1 year */,
baseURL: nuxt.options.app.buildAssetsDir,
},
...nuxt.options._layers
.map(layer => join(layer.config.srcDir, (layer.config.rootDir === nuxt.options.rootDir ? nuxt.options : layer.config).dir?.public || 'public'))
.filter(dir => existsSync(dir))
.map(dir => ({ dir })),
...(await resolvePublicFolders(nuxt)),
],
prerender: {
failOnError: true,
Expand Down Expand Up @@ -229,6 +226,8 @@ export async function initNitro (nuxt: Nuxt & { _nitro?: Nitro }) {
logLevel: logLevelMapReverse[nuxt.options.logLevel],
} satisfies NitroConfig)

await resolvePublicAssets(nuxt)

// Resolve user-provided paths
nitroConfig.srcDir = resolve(nuxt.options.rootDir, nuxt.options.srcDir, nitroConfig.srcDir!)
nitroConfig.ignore = [...(nitroConfig.ignore || []), ...resolveIgnorePatterns(nitroConfig.srcDir), `!${join(nuxt.options.buildDir, 'dist/client', nuxt.options.app.buildAssetsDir)}/**/*`]
Expand Down Expand Up @@ -594,3 +593,34 @@ async function spaLoadingTemplate (nuxt: Nuxt) {

return ''
}

async function resolvePublicFolders (nuxt: Nuxt) {
const { dir: rootDir, srcDir, alias: rootAlias } = nuxt.options
const dirs = await Promise.all(nuxt.options._layers.map((layer) => {
const [path, cwd, alias] = layer.config.rootDir === nuxt.options.rootDir
? [rootDir.public || 'public', srcDir, rootAlias]
: [layer.config.dir?.public || 'public', layer.config.srcDir, layer.config.alias]
return resolvePath(path, { cwd, alias: alias as Record<string, string> })
}))

return dirs.filter(dir => existsSync(dir)).map(dir => ({ dir }))
}

async function resolvePublicAssets (nuxt: Nuxt) {
const { dir: rootDir, srcDir, alias: rootAlias } = nuxt.options
await Promise.all(nuxt.options._layers.map((layer) => {
return Promise.all((layer.config.nitro?.publicAssets || []).map(async (publicAsset) => {
if (!publicAsset) {
Copy link
Member Author

@userquin userquin Apr 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shold we use !publicAssets?.dir instead: if so, we should also remove || rootDir.public || 'public' from L617 and || layer.config.dir?.public || 'public'from L618

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've exluded publicAssets without dir

return
}
const [path, cwd, alias] = layer.config.rootDir === nuxt.options.rootDir
? [publicAsset.dir || rootDir.public || 'public', srcDir, rootAlias]
: [publicAsset.dir || layer.config.dir?.public || 'public', layer.config.srcDir, layer.config.alias]
const dir = await resolvePath(path, { cwd, alias: alias as Record<string, string> })
// TODO: should warn if missing?
if (existsSync(dir)) {
publicAsset.dir = dir
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should warn or even throw?

}
}))
}))
}
13 changes: 7 additions & 6 deletions packages/nuxt/src/core/plugins/layer-aliasing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ export const LayerAliasingPlugin = createUnplugin((options: LayerAliasingOptions
const srcDir = layer.config.srcDir || layer.cwd
const rootDir = layer.config.rootDir || layer.cwd

aliases[srcDir] = {
'~': layer.config?.alias?.['~'] || srcDir,
'@': layer.config?.alias?.['@'] || srcDir,
'~~': layer.config?.alias?.['~~'] || rootDir,
'@@': layer.config?.alias?.['@@'] || rootDir,
}
// expose layer aliases
layer.config.alias ??= {}
layer.config.alias['~'] = layer.config.alias?.['~'] || srcDir
layer.config.alias['@'] = layer.config.alias?.['@'] || srcDir
layer.config.alias['~~'] = layer.config.alias?.['~~'] || rootDir
layer.config.alias['@@'] = layer.config.alias?.['@@'] || rootDir
aliases[srcDir] = { ...(layer.config.alias as Record<string, string>) }
}
const layers = Object.keys(aliases).sort((a, b) => b.length - a.length)

Expand Down
4 changes: 4 additions & 0 deletions test/basic.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1821,6 +1821,10 @@ describe('public directories', () => {
expect(html).toContain('"/public.svg"')
expect(html).toContain('"/custom/file.svg"')
})
it('should resolve subfolder image from public assets using alias in dir', async () => {
const html = await $fetch('/public-assets-alias')
expect(html).toContain('"/subfolder/1x1.png"')
})
})

// TODO: dynamic paths in dev
Expand Down
5 changes: 5 additions & 0 deletions test/fixtures/basic/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ export default defineNuxtConfig({
dir: '../custom-public',
baseURL: '/custom',
},
{
baseURL: 'subfolder',
dir: '~/public-alias/subfolder',
maxAge: 31536000,
},
],
esbuild: {
options: {
Expand Down
5 changes: 5 additions & 0 deletions test/fixtures/basic/pages/public-assets-alias.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<template>
<div>
<img src="/subfolder/1x1.png">
</div>
</template>
Binary file added test/fixtures/basic/public-alias/subfolder/1x1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.