fix(schema): warn if user provides vite.publicDir
#21847
Conversation
packages/schema/src/config/vite.ts
Outdated
| @@ -30,6 +30,7 @@ export default defineUntypedSchema({ | |||
| extensions: ['.mjs', '.js', '.ts', '.jsx', '.tsx', '.json', '.vue'] | |||
| }, | |||
| publicDir: { | |||
| $schema: { deprecated: 'use `dir.public` option instead' }, | |||
There was a problem hiding this comment.
Just to confirm, is this used for documentation auto-generation and no influence on coding actual application code?
There was a problem hiding this comment.
By the way, the message is quoted from dir.static option.
There was a problem hiding this comment.
Although I deprecate it at docs level, developers still can specify vite.publicDir option in Nuxt config file, because Nuxt accepts ViteConfig as vite option that extends/inherits all the properties from Vite's UserConfig.
There was a problem hiding this comment.
yes, that's tricky. Setting $schema here won't have any effect, as you say, because it's being shadowed by ViteConfig. So instead we can set the deprecation on ViteConfig directly.
packages/vite/src/vite.ts
Outdated
| nuxt.hook('vite:extendConfig', (config) => { | ||
| if (config.publicDir) { | ||
| consola.warn('Using `options.vite.publicDir` option is not supported together with Nuxt. Use `options.dir.public` instead. You can read more in `https://nuxt.com/docs/api/configuration/nuxt-config#public`.') | ||
| } | ||
| }) |
There was a problem hiding this comment.
if (config.publicDir) {...} checks that config.publicDir !== false && config.publicDir !== '', both of which prevent public assets from being copied.
This warning message is shown twice in Terminal, because it's run for client build and server build. Should I show it only in either of them by checking isClient or isServer props?
There was a problem hiding this comment.
I've moved the warning to schema so it will only warn when user options are read in. what do you think?
Did this work previously? I would think it would always be set as Nuxt schema should always resolve the publicDir?
danielroe
changed the title
vite.publicDir optionvite.publicDir
|
Oh, sorry I couldn't reply to your comments. |
🔗 Linked issue
Resolves #21831
❓ Type of change
📚 Description
This PR is based on #21831 (comment)
I hope I'm doing it in right way and as @danielroe intended. 🙏
References:
📝 Checklist