Weave Code
Nova Devtool Laravel Package
laravel/nova-devtool
Laravel Nova Devtool streamlines Nova component development with a Workbench-based Nova install, optional auto-login, and commands to install common JS deps. Easily enable/disable Vue Devtools in Nova and upgrade from Nova 4 with a generic Mix extension.
Devtool for Laravel Nova Development
Frequently asked questions about Nova Devtool
- How do I quickly set up a Laravel Nova development environment with this package?
- Run `composer require --dev laravel/nova-devtool` followed by `php vendor/bin/testbench nova:devtool setup`. This automates Workbench initialization, creating a sandboxed Nova instance in the `workbench` directory. Serve it with `composer run serve` for instant access. The package handles PHP and frontend dependencies, including Nova’s core setup.
- Does laravel/nova-devtool support Laravel 13 and Nova 6.x?
- Yes, the package is actively maintained and explicitly supports Laravel 10–13 and Nova 5.x–6.x. Check the [GitHub releases](https://github.com/laravel/nova-devtool/releases) for version-specific notes, but compatibility is guaranteed for these ranges. For Nova 4, use the documented upgrade path via `webpack.mix.js` adjustments.
- Can I use this package without Orchestra Workbench?
- The package primarily uses Workbench for isolation, but you can bypass it by running `composer run serve` directly after setup. Workbench is optional for teams already using it, but the package provides a lightweight alternative for simpler workflows. Note that some features (e.g., auto-login) rely on Workbench’s configuration.
- How do I enable Vue DevTools for debugging custom Nova fields?
- Run `php vendor/bin/testbench nova:devtool enable-vue-devtool` to inject Vue DevTools into Nova’s build. This modifies `webpack.mix.js` automatically, adding source maps and debugging tools. Disable it later with `nova:devtool disable-vue-devtool` to revert to production builds. Requires Node.js and NPM for frontend asset compilation.
- What JavaScript dependencies does `nova:devtool install` add?
- The `nova:devtool install` command installs Axios, Lodash, Tailwind CSS, and Vue DevTools dependencies via NPM. These are common for Nova component development but are optional—you can manually manage dependencies if needed. The package updates `package.json` and `package-lock.json` to ensure consistency across the project.
- Will this package conflict with third-party Nova components?
- Potential conflicts may arise if third-party components override `webpack.mix.js` or use custom Mix extensions. Test thoroughly, especially when combining multiple packages. The package provides a generic `nova.mix.js` for Nova 4 upgrades, but teams should review the [upgrade documentation](https://github.com/laravel/nova-devtool#upgrading-from-nova-4) for compatibility notes.
- How do I upgrade from Nova 4 to Nova 5/6 using this tool?
- Replace `require('./nova.mix')` with `mix.extend('nova', new require('laravel-nova-devtool'))` in your `webpack.mix.js`. Run `nova:devtool setup` to generate a compatible Workbench environment, then update Nova’s core files via Composer. The package handles Mix configuration changes, but PHP service providers or policies may need manual adjustments.
- Is there a way to auto-login to Nova without Workbench?
- No, the auto-login feature (`user: nova@laravel.com` in `testbench.yaml`) requires Workbench. For non-Workbench setups, manually log in via `/nova` or use Laravel’s session drivers. The package prioritizes Workbench for isolation, but you can simulate auto-login with environment variables or middleware if needed.
- Does this package support TypeScript for Nova components?
- The package includes a `tsconfig` action, but TypeScript support requires additional setup (e.g., installing `@types/vue` or `@types/lodash`). Run `php vendor/bin/testbench nova:devtool install --typescript` to generate a basic `tsconfig.json`. Ensure your `webpack.mix.js` is configured for TypeScript transpilation.
- What’s the rollback plan if this package causes issues?
- If instability occurs, revert changes to `webpack.mix.js` and `package.json` manually. For Workbench issues, delete the `workbench` directory and reinstall Nova manually. The package avoids critical overrides, but back up your project before installation. Forking the package is an option for long-term customization, though active maintenance reduces this need.
Weaver
How can I help you explore Laravel packages today?