vite: Cannot watch specific dependencies in node_modules
Describe the bug
The documentation for server.watch contains the following example:
server: {
watch: {
ignored: ['!**/node_modules/your-package-name/**']
}
},
This example does not work. It appears that the builtin **/node_modules/** exclude causes chokidar to not even look in node_modules despite the negation in the subdirectory.
It appears this was originally tested (see #5023 and #5239) with ignored: ['!**/node_modules/**']. This does work, but in a real project will almost immediately result in Error: ENOSPC: System limit for number of file watchers reached.
See https://github.com/paulmillr/chokidar/issues/1225. I played with various chokidar options but I couldn’t see a way to achieve this.
Reproduction
See chokidar issue.
System Info
System:
OS: Linux 5.4 Linux Mint 20.3 (Una)
CPU: (12) x64 AMD Ryzen 5 2600 Six-Core Processor
Memory: 4.20 GB / 15.56 GB
Container: Yes
Shell: 5.0.17 - /bin/bash
Binaries:
Node: 16.15.1 - /usr/bin/node
npm: 8.1.1 - ~/npm/bin/npm
Browsers:
Chrome: 102.0.5005.61
Firefox: 101.0
npmPackages:
vite: ^2.9.12 => 2.9.12
Used Package Manager
npm
Logs
No response
Validations
- Follow our Code of Conduct
- Read the Contributing Guidelines.
- Read the docs.
- Check that there isn’t already an issue that reports the same bug to avoid creating a duplicate.
- Make sure this is a Vite issue and not a framework-specific issue. For example, if it’s a Vue SFC related bug, it should likely be reported to https://github.com/vuejs/core instead.
- Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
- The provided reproduction is a minimal reproducible example of the bug.
About this issue
- Original URL
- State: open
- Created 4 years ago
- Reactions: 54
- Comments: 45 (5 by maintainers)
Commits related to this issue
- fix: workaround to watch .vitest-preview under node_modules Reference: https://github.com/vitejs/vite/issues/8619#issuecomment-1170762244 — committed to nvh95/vitest-preview by nvh95 4 years ago
- Document working solutions to watch a package inside `node_modules/` The current `server.watch` docs aren't accurate and the solution proposed just doesn't work. See https://github.com/vitejs/vite/is... — committed to MadLittleMods/vite by MadLittleMods 3 years ago
- docs: update working solutions to watch a package inside `node_modules/` The current `server.watch` docs aren't accurate and the solution proposed just doesn't work. See https://github.com/vitejs/vit... — committed to MadLittleMods/vite by MadLittleMods 3 years ago
- docs: update working solutions to watch a package inside `node_modules/` The current `server.watch` docs aren't accurate and the solution proposed just doesn't work. See https://github.com/vitejs/vit... — committed to MadLittleMods/vite by MadLittleMods 3 years ago
- Make ornode dev server reload when dependencies change Tried to solve the same problem for gui. Currently you have to re-save the vite.config.ts file in order for dev server to rebuild with changed d... — committed to sim31/frapps by sim31 2 years ago
- Run gui dev server so that it is restarted if deps change * This is motivated by an issue where vite dev server rebuilds components when dependencies change (note that it's related to hmr so it's a b... — committed to sim31/ordao by sim31 2 years ago
✋ me for sure. It’s been bugging my team for a while.
Thanks, that’s very helpful as a temporary workaround until chokidar provides an official recommendation of how to fix this properly.
To preempt anyone who tries to close this:
Similar to https://github.com/vitejs/vite/issues/6718, it would be nice to exclude locally linked packages from being ignored by default. When I make a change in a sub-dependency, I want the bundle to rebuild.
Just packaged up @ryzr’s awesome little snippet into something reusable where you can also list multiple modules if you want 🚀
Then to use it, pass into your
pluginsarray like so:Edit: p.s. Don’t forget to ensure that you exclude these packages from
optimizeDepslike so:Waiting for a best practice.🤖
I currently can’t use vite because of this issue. I have a monorepo, where I build dependencies separately. but vite doesn’t detect changes to them and there seems to be no way of making it detect them. The trick with the plugin by @bluwy didn’t work for me either.
@SystemParadox
If it’s any help, creating a custom plugin to override the vite-enforced watch options seems to have worked for me
Tried everything on this page and could not get a dependency (workspace: or portal: in Yarn) to correctly HMR, or even refresh the cache to take changes in the dependency. Going to have to move away from the dev server to a much worse dummy Express server and do a
vite build --watch. Hopefully we can get a feature added for this soon.Has anyone got this working with a scoped package (
@myscope/package)?Hi, is there anyone still care about it? ALL workarounds above not work for me, that’s quite irritating… I am spending the whole night for this thing that shouldn’t happen at all.
The issue with using
optimizeDeps.excludefor this is that this also excludes deps of that package from vite’s esm/cjs interop magic. So you then have to run through and include a bunch of your deps-of-deps inoptimizeDeps.includeto re-opt them in to esm/cjs interop. (@quyle92 that’s probably the issue you’re running into.)I don’t know if something changed in the last month but @patricknelson snippet did not work for me. Been banging my head against this for hours but finally saw this in docs and so tried this:
And it worked! The other “gotcha” I wanted to call out is that if you need to include a dep of your excluded dep, you need to include EXACTLY what is in your import line. For me it was
react-iconsand I wasted a few hours until I realized I had to includereact-icons/fi/index.jsbecause that is what was in the import line in my esm package.Was unable to get it working until I added
server.watcher._userIgnored = undefinedpicked from chokidar source (whenconfigureServeris called,server.watcheris already instanciated).This throws error does not provide an export named ‘default’
Hi @TheTedAdams , Thanks for your reply. If I add
optimizeDeps: { exclude: modules, },vite failed to build my app and throw error atnode_modules/uncontrollable/lib/esm/utils.jswith message beingUncaught SyntaxError: ambiguous indirect export: default.@bluwy good thought but alas no, swapping the order doesn’t help:
Chokidar still seems to ignore the whole of
node_modulesand doesn’t bother looking inside it.Just updated the plugin to support hot-reload and no need for specifying your modules in
optimizeDeps.excludeanymore- its just a simple plugin that takes a list of modules you would like to watch.https://github.com/lostpebble/vite-plugin-watch-node-modules
This issue has been bothering me a lot because I link external modules into our project and update them frequently while developing.
So I’ve made a plugin to deal with this situation:
https://github.com/lostpebble/vite-plugin-watch-node-modules
Hopefully that solves the issues for you guys too! I will need to add “hot-reload” functionality still, but at least it triggers a reload on file changes in the package inside
node_modulesfor now.Unfortunately, using the
I reached 20+ entries in the
It doesn’t seem like a viable way to watch linked dependencies…
excludefor the linked dependency isn’t an option in my case. As then a ton of the following exceptions start to pop up:includeand got stuck with thereact-domone:Although the changes are tracked when I remove the
preserveSymlinks: true. However, there’s a catch! If a dependency(A) is used by a consumer (C->A) and by another dependency (C->B->A),Awill be duplicated in dev. And that’s devastating for the React Context that must be unique in the bundle.If it helps, it works with
npx vitewithout any custom scripts when re-saving the vite config file whileforceis truein the config:
optimizeDeps: { force: true },or if the command is started with:--forceAh bummer, I really need it with
vite serve.Did work for me:
But it works only for
build --watchmode. Linked packages (npm link/npm i <../../your/fs/path>) will work too.@quyle92 you may be running into cache stuff. Are you also listing your package in
optimizeDeps.exclude? This is the final version of plugin I’ve been using: