Metro bundler plugin for Rozenite.
npm install @rozenite/metro[![mit licence][license-badge]][license] [![npm downloads][npm-downloads-badge]][npm-downloads] [![Chat][chat-badge]][chat] [![PRs Welcome][prs-welcome-badge]][prs-welcome]
The Rozenite Metro plugin seamlessly integrates custom DevTools plugins into your React Native development environment. It automatically discovers installed plugins, serves them through Metro's development server, and provides the necessary infrastructure for plugin communication and UI rendering.
- Automatic Plugin Discovery: Automatically finds and loads installed Rozenite plugins from node_modules
- Metro Integration: Seamlessly integrates with Metro bundler's middleware system
- Plugin Serving: Serves plugin assets and panels through Metro's development server
- DevTools Frontend Integration: Patches React Native DevTools frontend for plugin support
- Express Middleware: Provides custom Express middleware for plugin routing and serving
- Configuration Options: Flexible configuration for including/excluding specific plugins
Install the Metro plugin as a development dependency:
``bash`
npm install --save-dev @rozenite/metro
Add the Rozenite plugin to your Metro configuration:
`javascript
// metro.config.js
import { withRozenite } from '@rozenite/metro';
export default withRozenite({
// Your existing Metro configuration
});
`
Configure plugin discovery and filtering:
`javascript
// metro.config.js
import { withRozenite } from '@rozenite/metro';
export default withRozenite(
{
// Your existing Metro configuration
},
{
include: ['@my-org/my-plugin', 'another-plugin'],
exclude: ['unwanted-plugin'],
destroyOnDetachPlugins: ['@rozenite/network-activity-plugin'],
}
);
`
The configuration object for the Metro plugin:
`typescript`
type RozeniteMetroConfig = {
include?: string[]; // Only load these specific plugins
exclude?: string[]; // Exclude these plugins from loading
destroyOnDetachPlugins?: string[]; // Plugins that should be destroyed when switching panels
};
Options:
- include - Array of package names to explicitly include (optional)exclude
- - Array of package names to exclude from loading (optional)destroyOnDetachPlugins
- - Array of package names that should be destroyed when switching panels instead of maintaining their state (optional, by default all plugins persist their state)
The Metro plugin automatically discovers Rozenite plugins by:
1. Scanning node_modules: Searches all node_modules directories in the project
2. Checking for Rozenite manifest: Looks for the Rozenite manifest file in each package
3. Validating plugin structure: Ensures the plugin has the required build output
4. Loading plugin metadata: Extracts plugin information for integration
1. Install plugins in your React Native project
2. Configure Metro with the Rozenite plugin
3. Start Metro server - plugins are automatically discovered and loaded
4. Access DevTools - plugins appear in the React Native DevTools interface
5. Develop plugins - use hot reload for plugin development
For a package to be recognized as a Rozenite plugin, it must:
1. Have a Rozenite manifest: dist/rozenite.json filedist
2. Be properly built: Plugin assets must be available in the directory.
3. Follow naming conventions: Package name should not start with
4. Be accessible: Package must be readable from node_modules
- Ensure plugins are properly installed in node_modules
- Check that plugins have been built and contain
- Verify plugin package names are not excluded in configuration
- Check Metro server logs for plugin discovery messages
- Verify plugin manifest file exists and is valid
- Ensure plugin assets are properly built and accessible
- The Rozenite middleware is designed to work alongside existing Metro middleware
- Custom middleware is preserved and enhanced, not replaced
- Check for conflicts with other Metro plugins
- Node.js >= 22
- Metro bundler
- React Native project
- Installed Rozenite plugins
rozenite` is an open source project and will always remain free to use. If you think it's cool, please star it 🌟.
[Callstack][callstack-readme-with-love] is a group of React and React Native geeks, contact us at hello@callstack.com if you need any help with these or just want to say hi!
Like the project? ⚛️ Join the team who does amazing stuff for clients and drives React Native Open Source! 🔥
[callstack-readme-with-love]: https://callstack.com/?utm_source=github.com&utm_medium=referral&utm_campaign=rozenite&utm_term=readme-with-love
[license-badge]: https://img.shields.io/npm/l/rozenite?style=for-the-badge
[license]: https://github.com/callstackincubator/rozenite/blob/main/LICENSE
[npm-downloads-badge]: https://img.shields.io/npm/dm/rozenite?style=for-the-badge
[npm-downloads]: https://www.npmjs.com/package/@rozenite/metro
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
[prs-welcome]: https://github.com/callstackincubator/rozenite/blob/main/CONTRIBUTING.md
[chat-badge]: https://img.shields.io/discord/426714625279524876.svg?style=for-the-badge
[chat]: https://discord.gg/xgGt7KAjxv