You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
if (err || !this._pendingWrites.has(path)) {
- if (err && err.code !== 'ENOENT') awfEmit(err);+ if (err && err.code !== 'ENOENT') {+ clearTimeout(timeoutHandler);+ awfEmit(err);+ }
return;
}
[To ensure code accuracy, apply this suggestion manually]
Suggestion importance[1-10]: 8
__
Why: The suggestion prevents memory leaks by properly cleaning up timeout handlers when errors occur, which is important for long-running file watchers.
Medium
Improve error handling in file watcher
Add error handling for the case when fs.stat() fails in _awaitWriteFinish(). Currently errors are silently ignored which could mask important issues.
Why: The suggestion improves error handling by explicitly cleaning up pending writes when errors occur, preventing potential state inconsistencies in the file watcher.
The added documentation for nodemon is extensive but includes numerous external links and examples that may not be directly relevant to the project. Ensure that the documentation is concise and tailored to the project's needs.
<palign="center">
<ahref="https://nodemon.io/"><imgsrc="https://user-images.githubusercontent.com/13700/35731649-652807e8-080e-11e8-88fd-1b2f6d553b2d.png"alt="Nodemon Logo"></a>
</p>
# nodemon
nodemon is a tool that helps develop Node.js based applications by automatically restarting the node application when file changes in the directory are detected.
nodemon does **not** require *any* additional changes to your code or method of development. nodemon is a replacement wrapper for `node`. To use `nodemon`, replace the word `node` on the command line when executing your script.
[](https://npmjs.org/package/nodemon)[](#backers)[](#sponsors)# Installation
Either through cloning with git or by using [npm](http://npmjs.org) (the recommended way):
```bash
npm install -g nodemon # or using yarn: yarn global add nodemon
And nodemon will be installed globally to your system path.
You can also install nodemon as a development dependency:
npm install --save-dev nodemon # or using yarn: yarn add nodemon -D
With a local installation, nodemon will not be available in your system path or you can't use it directly from the command line. Instead, the local installation of nodemon can be run by calling it from within an npm script (such as npm start) or using npx nodemon.
Usage
nodemon wraps your application, so you can pass all the arguments you would normally pass to your app:
nodemon [your node app]
For CLI options, use the -h (or --help) argument:
nodemon -h
Using nodemon is simple, if my application accepted a host and port as the arguments, I would start it as so:
nodemon ./server.js localhost 8080
Any output from this script is prefixed with [nodemon], otherwise all output from your application, errors included, will be echoed out as expected.
You can also pass the inspect flag to node through the command line as you would normally:
nodemon --inspect ./server.js 80
If you have a package.json file for your app, you can omit the main script entirely and nodemon will read the package.json for the main property and use that value as the app (ref).
nodemon will also search for the scripts.start property in package.json (as of nodemon 1.1.x).
nodemon was originally written to restart hanging processes such as web servers, but now supports apps that cleanly exit. If your script exits cleanly, nodemon will continue to monitor the directory (or directories) and restart the script if there are any changes.
Manual restarting
Whilst nodemon is running, if you need to manually restart your application, instead of stopping and restart nodemon, you can type rs with a carriage return, and nodemon will restart your process.
Config files
nodemon supports local and global configuration files. These are usually named nodemon.json and can be located in the current working directory or in your home directory. An alternative local configuration file can be specified with the --config <file> option.
The specificity is as follows, so that a command line argument will always override the config file settings:
command line arguments
local config
global config
A config file can take any of the command line arguments as JSON key values, for example:
The above nodemon.json file might be my global config so that I have support for ruby files and processing files, and I can run nodemon demo.pde and nodemon will automatically know how to run the script even though out of the box support for processing scripts.
If you want to keep all your package configurations in one place, nodemon supports using package.json for configuration.
Specify the config in the same format as you would for a config file but under nodemonConfig in the package.json file, for example, take the following package.json:
{
"name": "nodemon",
"homepage": "http://nodemon.io",
"...": "... other standard package.json values",
"nodemonConfig": {
"ignore": ["**/test/**", "**/docs/**"],
"delay": 2500
}
}
Note that if you specify a --config file or provide a local nodemon.json any package.json config is ignored.
This section needs better documentation, but for now you can also see nodemon --help config (also here).
nodemon can also be used to execute and monitor other programs. nodemon will read the file extension of the script being run and monitor that extension instead of .js if there's no nodemon.json:
nodemon --exec "python -v" ./app.py
Now nodemon will run app.py with python in verbose mode (note that if you're not passing args to the exec program, you don't need the quotes), and look for new or modified files with the .py extension.
Default executables
Using the nodemon.json config file, you can define your own default executables using the execMap property. This is particularly useful if you're working with a language that isn't supported by default by nodemon.
To add support for nodemon to know about the .pl extension (for Perl), the nodemon.json file would add:
{
"execMap": {
"pl": "perl"
}
}
Now running the following, nodemon will know to use perl as the executable:
nodemon script.pl
It's generally recommended to use the global nodemon.json to add your own execMap options. However, if there's a common default that's missing, this can be merged in to the project so that nodemon supports it by default, by changing default.js and sending a pull request.
Monitoring multiple directories
By default nodemon monitors the current working directory. If you want to take control of that option, use the --watch option to add specific paths:
nodemon --watch app --watch libs app/server.js
Now nodemon will only restart if there are changes in the ./app or ./libs directory. By default nodemon will traverse sub-directories, so there's no need in explicitly including sub-directories.
Nodemon also supports unix globbing, e.g --watch './lib/*'. The globbing pattern must be quoted. For advanced globbing, see picomatch documentation, the library that nodemon uses through chokidar (which in turn uses it through anymatch).
Specifying extension watch list
By default, nodemon looks for files with the .js, .mjs, .coffee, .litcoffee, and .json extensions. If you use the --exec option and monitor app.py nodemon will monitor files with the extension of .py. However, you can specify your own list with the -e (or --ext) switch like so:
nodemon -e js,pug
Now nodemon will restart on any changes to files in the directory (or subdirectories) with the extensions .js, .pug.
Ignoring files
By default, nodemon will only restart when a .js JavaScript file changes. In some cases you will want to ignore some specific files, directories or file patterns, to prevent nodemon from prematurely restarting your application.
This can be done via the command line:
nodemon --ignore lib/ --ignore tests/
Or specific files can be ignored:
nodemon --ignore lib/app.js
Patterns can also be ignored (but be sure to quote the arguments):
nodemon --ignore 'lib/*.js'
Important the ignore rules are patterns matched to the full absolute path, and this determines how many files are monitored. If using a wild card glob pattern, it needs to be used as ** or omitted entirely. For example, nodemon --ignore '**/test/**' will work, whereas --ignore '*/test/*' will not.
Note that by default, nodemon will ignore the .git, node_modules, bower_components, .nyc_output, coverage and .sass-cache directories and add your ignored patterns to the list. If you want to indeed watch a directory like node_modules, you need to override the underlying default ignore rules.
Application isn't restarting
In some networked environments (such as a container running nodemon reading across a mounted drive), you will need to use the legacyWatch: true which enables Chokidar's polling.
Via the CLI, use either --legacy-watch or -L for short:
nodemon -L
Though this should be a last resort as it will poll every file it can find.
Delaying restarting
In some situations, you may want to wait until a number of files have changed. The timeout before checking for new file changes is 1 second. If you're uploading a number of files and it's taking some number of seconds, this could cause your app to restart multiple times unnecessarily.
To add an extra throttle, or delay restarting, use the --delay command:
nodemon --delay 10 server.js
For more precision, milliseconds can be specified. Either as a float:
nodemon --delay 2.5 server.js
Or using the time specifier (ms):
nodemon --delay 2500ms server.js
The delay figure is number of seconds (or milliseconds, if specified) to delay before restarting. So nodemon will only restart your app the given number of seconds after the last file change.
If you are setting this value in nodemon.json, the value will always be interpreted in milliseconds. E.g., the following are equivalent:
nodemon --delay 2.5
{
"delay": 2500
}
Gracefully reloading down your script
It is possible to have nodemon send any signal that you specify to your application.
nodemon --signal SIGHUP server.js
Your application can handle the signal as follows.
Please note that nodemon will send this signal to every process in the process tree.
If you are using cluster, then each workers (as well as the master) will receive the signal. If you wish to terminate all workers on receiving a SIGHUP, a common pattern is to catch the SIGHUP in the master, and forward SIGTERM to all workers, while ensuring that all workers ignore SIGHUP.
nodemon sends a kill signal to your application when it sees a file update. If you need to clean up on shutdown inside your script you can capture the kill signal and handle it yourself.
The following example will listen once for the SIGUSR2 signal (used by nodemon to restart), run the clean up process and then kill itself for nodemon to continue control:
// important to use `on` and not `once` as nodemon can re-send the kill signalprocess.on('SIGUSR2',function(){gracefulShutdown(function(){process.kill(process.pid,'SIGTERM');});});
Note that the process.kill is only called once your shutdown jobs are complete. Hat tip to Benjie Gillam for writing this technique up.
Triggering events when nodemon state changes
If you want growl like notifications when nodemon restarts or to trigger an action when an event happens, then you can either require nodemon or add event actions to your nodemon.json file.
For example, to trigger a notification on a Mac when nodemon restarts, nodemon.json looks like this:
{
"events": {
"restart": "osascript -e 'display notification \"app restarted\" with title \"nodemon\"'"
}
}
A full list of available events is listed on the event states wiki. Note that you can bind to both states and messages.
Pipe output to somewhere else
nodemon({script: ...,stdout: false// important: this tells nodemon not to output to console}).on('readable',function(){// the `readable` event indicates that data is ready to pick upthis.stdout.pipe(fs.createWriteStream('output.txt'));this.stderr.pipe(fs.createWriteStream('err.txt'));});
Using nodemon in your gulp workflow
Check out the gulp-nodemon plugin to integrate nodemon with the rest of your project's gulp workflow.
Using nodemon in your Grunt workflow
Check out the grunt-nodemon plugin to integrate nodemon with the rest of your project's grunt workflow.
Pronunciation
nodemon, is it pronounced: node-mon, no-demon or node-e-mon (like pokémon)?
Well...I've been asked this many times before. I like that I've been asked this before. There's been bets as to which one it actually is.
The answer is simple, but possibly frustrating. I'm not saying (how I pronounce it). It's up to you to call it as you like. All answers are correct :)
Design principles
Fewer flags is better
Works across all platforms
Fewer features
Let individuals build on top of nodemon
Offer all CLI functionality as an API
Contributions must have and pass tests
Nodemon is not perfect, and CLI arguments has sprawled beyond where I'm completely happy, but perhaps it can be reduced a little one day.
FAQ
See the FAQ and please add your own questions if you think they would help others.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
%20(2).jpg)
.png){kind=logo}
PR Type
Documentation, Enhancement, Tests, Other
Description
Added comprehensive documentation for multiple libraries including
nodemon,is-glob,semver,picomatch,braces,balanced-match, and others.Implemented enhancements such as file watching with
chokidar, glob pattern parsing withpicomatch, and file path pattern matching withminimatch.Introduced new dependencies like
nodemon,chokidar, and related packages, updatingpackage-lock.jsonaccordingly.Added unit tests for the
simple-update-notifierpackage to ensure functionality in different scenarios.Included various utility and core implementation files for libraries and modules to support new features.
Changes walkthrough 📝
7 files
README.md
Added detailed documentation for the `nodemon` package.node_modules/nodemon/README.md
nodemonpackage.options, and FAQs.
and using as a module.
README.md
Added documentation for the `is-glob` package.node_modules/is-glob/README.md
is-globpackage.README.md
Added comprehensive documentation for semver module.node_modules/semver/README.md
semvermodule.versioning.
the API.
README.md
Added README documentation for `picomatch` library.node_modules/picomatch/README.md
picomatchlibrary.and options.
comparisons.
information.
README.md
Added README documentation for `braces` library.node_modules/braces/README.md
braceslibrary.compilation.
information.
README.md
Added README documentation for `debug` library within `nodemon`.node_modules/nodemon/node_modules/debug/README.md
debuglibrary used withinnodemon.variable configurations.
acknowledgments.
README.md
Added README documentation for `balanced-match` library.node_modules/balanced-match/README.md
balanced-matchlibrary.examples.
2 files
.package-lock.json
Updated package-lock.json with new dependencies.node_modules/.package-lock.json
package-lock.jsonto include new dependencies such asnodemon,chokidar, and related packages.anymatch,brace-expansion,chokidar, and others.package-lock.json
Updatedpackage-lock.jsonwith new dependencies includingnodemon.package-lock.json
nodemonas a new dependency with version^3.1.9.anymatch,chokidar,braces, and others.nodemonandrelated packages.
structure.
5 files
index.js
Added core implementation for `chokidar` file watcher.node_modules/chokidar/index.js
chokidarpackage.changes, additions, and deletions.
symlink resolution.
FSWatcherwith methods for adding, removing, andmanaging watched paths.
parse.js
Added a robust glob pattern parsing module.node_modules/picomatch/lib/parse.js
tokenization.
performance.
globbing features.
minimatch.js
Introduced a file path pattern matching library.node_modules/minimatch/minimatch.js
patterns.
fsevents-handler.js
Added file system events handler for chokidar.node_modules/chokidar/lib/fsevents-handler.js
FsEventsHandlerclass for handling file system events.index.js
Added rule management for nodemon configuration.node_modules/nodemon/lib/rules/index.js
1 files
index.spec.ts
Added unit tests for `simple-update-notifier`.node_modules/simple-update-notifier/src/index.spec.ts
simple-update-notifierpackage.hasNewVersionfunction to simulate different scenarios.101 files