feat: add `hasVitePlugin` and warn for duplicated Vite plugins

[BryceRussell]

Closes #51

• Add hasVitePlugin util/plugin (Using Option B laid out here)
• Update addVitePlugin util to warn when duplicate plugins are created

hasVitePlugin("vite-plugin-test-integration")
hasVitePlugin(vitePlugin())

Limitations

• Cannot detect the name of async plugins
• hasVitePlugin utility can only detect plugins added from previous integrations and not the current integration
• When using defineIntegration the hasVitePlugin plugin has to be located at the beginning of the plugins array in order to detect Vite plugins inside the current integration

Todo

• [x] Types
  • [x] Version mismatches on PluginOption between Astro and Vite types
  • [x] Update addVirtualImports and addDevToolbarFrameworkApp utils
• [x] Tests
  • [x] Write tests for hasVitePlugin util
  • [x] Test warnings for addVitePlugin util
  • [ ] Test current integration detection for hasVitePlugin plugin (Not sure how to mock this up in a test since hasVitePlugin overrides the updateConfig function)
  • [x] Update tests for addVitePlugin util
  • [x] Update tests for addVirtualImports util
• [x] Docs
  • [x] Create docs for hasVitePlugin
  • [x] Update docs for addVitePlugin
  • [x] Update docs for addVirtualImports
  • [x] Update docs for addDevToolbarFrameworkApp
  • [x] Add docs for breaking changes
• [x] JSDocs
  • [x] Create JSDoc for hasVitePlugin util
  • [x] Update JSDoc for addVitePlugin util
  • [x] Update JSDoc for addVirtualImports util
  • [x] Update JSDoc for addDevToolbarFrameworkApp util

[netlify[bot]]

✅ Deploy Preview for astro-integration-kit ready!

Name	Link
🔨 Latest commit	fb3f5c3a62508dda8bb9fa7f649d22f7a5e8155f
🔍 Latest deploy log	https://app.netlify.com/sites/astro-integration-kit/deploys/65eb13fe251f2b000756bc1b
😎 Deploy Preview	https://deploy-preview-74--astro-integration-kit.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[florian-lefebvre]

Feel free to assign us as reviewers once you feel like the PR is ready!

[BryceRussell]

I am ready for a review on this, I plan on finishing the docs once all of the changes have been reviewed/finalized

What changed?

The use and creation of Vite plugins is a lot safer now with warnings and incrementing names

Added hasVitePlugin utility/plugin:

// Utility
hasVitePlugin({ plugin: "vite-plugin-test-integration", config })
hasVitePlugin({ plugin: vitePlugin(), config })

// Plugin
hasVitePlugin("vite-plugin-test-integration")
hasVitePlugin(vitePlugin())

Limitations

• Cannot detect the name of async plugins
• hasVitePlugin utility can only detect plugins added from previous integrations and not the current integration
• When using defineIntegration the hasVitePlugin plugin has to be located at the beginning of the plugins array in order to detect Vite plugins inside the current integration

Updated addVitePlugin:

// Add `config` and `logger` to warn about duplicate plugins
addVitePlugin({
  plugin,
  config,
  logger
  updateConfig
})

// or

// Add `warnDuplicate: false` to disable warnings for duplicate plugins
addVitePlugin({
  warnDuplicate: false,
  plugin,
  updateConfig
})

// Add `warnDuplicate: false` AND `config` to increment plugin name if plugin already exists
// (for utils that depend on `addVitePlugin` so they don't need `logger` or `warnDuplicate` properties)
addVitePlugin({
  warnDuplicate: false,
  plugin,
  config
  updateConfig
})

Updated params for addVirtualImports and addDevToolbarFrameworkAppPlugin utils

// Now needs 'config' param to detect duplicate plugins and increment plugin name
addVirtualImports({
  ...
  config
})

// Now needs 'config' param to detect duplicate plugins and increment plugin name
addDevToolbarFrameworkAppPlugin({
  ...
  config
})

Thanks!

Let me know how this looks, and what can be improved

[florian-lefebvre]

You have a few conflicts to resolve because of me @BryceRussell!