JSPM

nodemon

0.3.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 7701928
  • Score
    100M100P100Q199898F

Simple monitor script for use during development of a node.js app.

Package Exports

  • nodemon
  • nodemon/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nodemon) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

nodemon

For use during development of a node.js based application.

nodemon will watch all the files in the directory that nodemon was started, and if they change, it will automatically restart your node application.

nodemon does not require any changes to your code or method of development. nodemon simply wraps your node application and keeps an eye on any files that have changed.

Installation

Either through forking or:

npm install nodemon

And nodemon will be installed in to your bin path.

Usage

nodemon wraps your application, so you can pass all the arguments you would normally pass to your app:

nodemon [your node app]

For example, 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.

nodemon also supports running and monitoring coffee-script apps:

nodemon server.coffee

If no script is given, nodemon will test for a package.json file and if found, will run the file associated with the main property (ref).

Ignoring files

In some cases you will want to ignore some specific files, directories or file patterns, to prevent nodemon from prematurely restarting your application.

The nodemon-ignore file is automatically created in the directory that you run your application from, so that you can have application specific ignore lists.

You can use the example ignore file as a basis for your nodemon, but it's very simple to create your own:

# this is my ignore file with a nice comment at the top

/vendor/*     # ignore all external submodules
/public/*     # static files
./README.md   # a specific file
*.css         # ignore any CSS files too

The ignore file accepts:

  • Comments starting with a # symbol
  • Blank lines
  • Specific files
  • File patterns (this is converted to a regex, so you have full control of the pattern)

Prerequisites

nodemon currently depends on the unix find command (which also is installed on Macs)