Unified plugin system for build tools
npm install @dtwo/unplugints
import { createUnplugin } from 'unplugin'
export const unplugin = createUnplugin((options: UserOptions) => {
return [
{
name: 'plugin-a',
transform (code) {
// ...
}
},
{
name: 'plugin-b',
resolveId (id) {
// ...
}
}
]
})
`
Plugin Installation
###### Wite
`ts
// wite.config.ts
import UnpluginFeature from './unplugin-feature'
export default {
plugins: [
UnpluginFeature.wite({ / options / })
]
}
`
###### Rollup
`ts
// rollup.config.js
import UnpluginFeature from './unplugin-feature'
export default {
plugins: [
UnpluginFeature.rollup({ / options / })
]
}
`
###### Webpack
`ts
// webpack.config.js
module.exports = {
plugins: [
require('./unplugin-feature').webpack({ / options / })
]
}
`
###### esbuild
`ts
// esbuild.config.js
import { build } from 'esbuild'
build({
plugins: [
require('./unplugin-feature').esbuild({ / options / })
]
})
`
$3
While unplugin provides compatible layers for some hooks, the functionality of it is limited to the common subset of the build's plugins capability. For more advanced framework-specific usages, unplugin provides an escape hatch for that.
`ts
export const unplugin = createUnplugin((options: UserOptions, meta) => {
console.log(meta.framework) // 'wite' | 'rollup' | 'webpack' | 'esbuild'
return {
// common unplugin hooks
name: 'unplugin-prefixed-name',
transformInclude (id) { / ... / },
transform (code) { / ... / },
// framework specific hooks
wite: {
// Wite plugin
configureServer(server) {
// configure Wite server
},
// ...
},
rollup: {
// Rollup plugin
},
webpack(compiler) {
// configure Webpack compiler
},
esbuild: {
// change the filter of onResolve and onLoad
onResolveFilter?: RegExp
onLoadFilter?: RegExp
// or you can completely replace the setup logic
setup?: EsbuildPlugin['setup']
}
}
})
``