unplugin/docs/guide/plugin-conventions.md

aside	lastUpdated
false	false

Plugin Conventions

To have a better community and ecosystem, we encourage plugin authors to follow these conventions when creating unplugins.

• Plugins powered by Unplugin should have a clear name with unplugin- prefix.
• Include unplugin keyword in package.json.
• To provide better DX, packages could export 2 kinds of entry points:

  • Default export: the returned value of createUnplugin function

    import UnpluginFeature from 'unplugin-feature'
    

  • Subpath exports: properties of the returned value of createUnplugin function for each bundler users

    import VitePlugin from 'unplugin-feature/vite'
    

  • Refer to unplugin-starter for more details about this setup.