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.

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

Jump to bottom

feat(kit): addBuildPlugin for builder-agnostic implementation #20587

Merged
merged 7 commits into from May 14, 2023
Merged

feat(kit): addBuildPlugin for builder-agnostic implementation #20587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4b77cd7
feat(kit): `addBuildPlugin` for builder-agnostic implementation
danielroe Apr 29, 2023
fc16727
fix: remove generic for passing options to plugin
danielroe Apr 30, 2023
97f5217
Merge remote-tracking branch 'origin/main' into feat/add-build-plugin
danielroe Apr 30, 2023
b8aea21
chore: remove unused imports
danielroe Apr 30, 2023
512bfb2
Merge remote-tracking branch 'origin/main' into feat/add-build-plugin
danielroe May 11, 2023
4a47994
refactor: use built-in getters
danielroe May 11, 2023
9ec1d76
Merge branch 'main' into feat/add-build-plugin
danielroe May 13, 2023
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
15 changes: 15 additions & 0 deletions packages/kit/src/build.ts
View file
Open in desktop
Expand Up @@ -136,3 +136,18 @@ export function addVitePlugin (pluginOrGetter: VitePlugin | VitePlugin[] | (() =
}
}, options)
}

interface AddBuildPluginFactory {
vite?: () => VitePlugin | VitePlugin[]
webpack?: () => WebpackPluginInstance | WebpackPluginInstance[]
}

export function addBuildPlugin (pluginFactory: AddBuildPluginFactory, options?: ExtendConfigOptions) {
if (pluginFactory.vite) {
addVitePlugin(pluginFactory.vite, options)
}

if (pluginFactory.webpack) {
addWebpackPlugin(pluginFactory.webpack, options)
}
}
Copy link
Member

Choose a reason for hiding this comment

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

Just an idea: This function would also check if current builder is supported or not and make a warning a build plugin is added without vite/webpack support

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 love the idea. Also maybe provide verbose warning and suggestion in module building mode?

Copy link
Member

Choose a reason for hiding this comment

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

For module building (i guess testing is only possible) we could do if partial in either case too :)

5 changes: 2 additions & 3 deletions test/fixtures/basic/nuxt.config.ts
View file
Open in desktop
@@ -1,4 +1,4 @@
import { addComponent, addVitePlugin, addWebpackPlugin } from 'nuxt/kit'
import { addBuildPlugin, addComponent } from 'nuxt/kit'
import type { NuxtPage } from 'nuxt/schema'
import { createUnplugin } from 'unplugin'
import { withoutLeadingSlash } from 'ufo'
Expand Down Expand Up @@ -104,8 +104,7 @@ export default defineNuxtConfig({
if (id === 'virtual.css') { return ':root { --virtual: red }' }
}
}))
addVitePlugin(() => plugin.vite())
addWebpackPlugin(() => plugin.webpack())
addBuildPlugin(plugin)
},
function (_options, nuxt) {
const routesToDuplicate = ['/async-parent', '/fixed-keyed-child-parent', '/keyed-child-parent', '/with-layout', '/with-layout2']
Expand Down