|
|
# Examples
```js// Simple config to run jshint any time a file is added, changed or deletedgrunt.initConfig({ watch: { files: ['**/*'], tasks: ['jshint'], },});```
```js// Advanced config. Run specific tasks when specific files are added, changed or deleted.grunt.initConfig({ watch: { gruntfile: { files: 'Gruntfile.js', tasks: ['jshint:gruntfile'], }, src: { files: ['lib/*.js', 'css/**/*.scss', '!lib/dontwatch.js'], tasks: ['default'], }, test: { files: '<%= jshint.test.src %>', tasks: ['jshint:test', 'qunit'], }, },});```
## Using the `watch` event
This task will emit a `watch` event when watched files are modified. This is useful if you would like a simple notification when files are edited or if you're using this task in tandem with another task. Here is a simple example using the `watch` event:
```jsgrunt.initConfig({ watch: { scripts: { files: ['lib/*.js'], }, },});grunt.event.on('watch', function(action, filepath) { grunt.log.writeln(filepath + ' has ' + action);});```
**The `watch` event is not intended for replacing the standard Grunt API for configuring and running tasks. If you're trying to run tasks from within the `watch` event you're more than likely doing it wrong. Please read [configuring tasks](http://gruntjs.com/configuring-tasks).**
### Compiling Files As Needed
A very common request is to only compile files as needed. Here is an example that will only lint changed files with the `jshint` task:
```jsgrunt.initConfig({ watch: { scripts: { files: ['lib/*.js'], tasks: ['jshint'], options: { nospawn: true, }, }, }, jshint: { all: ['lib/*.js'], },});
// on watch events configure jshint:all to only run on changed filegrunt.event.on('watch', function(action, filepath) { grunt.config(['jshint', 'all'], filepath);});```
If you need to dynamically modify your config, the `nospawn` option must be enabled to keep the watch running under the same context.
If you save multiple files simultaneously you may opt for a more robust method:
```jsvar changedFiles = Object.create(null);var onChange = grunt.util._.debounce(function() { grunt.config(['jshint', 'all'], Object.keys(changedFiles)); changedFiles = Object.create(null);}, 200);grunt.event.on('watch', function(action, filepath) { changedFiles[filepath] = action; onChange();});```
## Live Reloading
Live reloading is built into the watch task. Set the option `livereload` to `true` to enable on the default port `35729` or set to a custom port: `livereload: 1337`.
The simplest way to add live reloading to all your watch targets is by setting `livereload` to `true` at the task level. This will run a single live reload server and trigger the live reload for all your watch targets:
```jsgrunt.initConfig({ watch: { options: { livereload: true, }, css: { files: ['public/scss/*.scss'], tasks: ['compass'], }, },});```
You can also configure live reload for individual watch targets or run multiple live reload servers. Just be sure if you're starting multiple servers they operate on different ports:
```jsgrunt.initConfig({ watch: { css: { files: ['public/scss/*.scss'], tasks: ['compass'], options: { // Start a live reload server on the default port 35729 livereload: true, }, }, another: { files: ['lib/*.js'], tasks: ['anothertask'], options: { // Start another live reload server on port 1337 livereload: 1337, }, }, dont: { files: ['other/stuff/*'], tasks: ['dostuff'], }, },});```
### Enabling Live Reload in Your HTML
Once you've started a live reload server you'll be able to access the live reload script. To enable live reload on your page, add a script tag before your closing `</body>` tag pointing to the `livereload.js` script:
```html<script src="http://localhost:35729/livereload.js"></script>```
Feel free to add this script to your template situation and toggle with some sort of `dev` flag.
### Using Live Reload with the Browser Extension
Instead of adding a script tag to your page, you can live reload your page by installing a browser extension. Please visit [how do I install and use the browser extensions](http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions-) for help installing an extension for your browser.
Once installed please use the default live reload port `35729` and the browser extension will automatically reload your page without needing the `<script>` tag.
### Using Connect Middleware
Since live reloading is used when developing, you may want to disable building for production (and are not using the browser extension). One method is to use Connect middleware to inject the script tag into your page. Try the [connect-livereload](https://github.com/intesso/connect-livereload) middleware for injecting the live reload script into your page.
# FAQs
## How do I fix the error `EMFILE: Too many opened files.`?
This is because of your system's max opened file limit. For OSX the default is very low (256). Temporarily increase your limit with `ulimit -n 10480`, the number being the new max limit.
In some versions of OSX the above solution doesn't work. In that case try `launchctl limit maxfiles 10480 10480 ` and restart your terminal. See [here](http://superuser.com/questions/261023/how-to-change-default-ulimit-values-in-mac-os-x-10-6).
## Can I use this with Grunt v0.3?
Yes. Although `grunt-contrib-watch` is a replacement watch task for Grunt v0.4, version `grunt-contrib-watch@0.1.x` is compatible with Grunt v0.3. `grunt-contrib-watch >= 0.2.x` is **only* compatible and recommended to use with Grunt v0.4.
## Why is the watch devouring all my memory?
Likely because of an enthusiastic pattern trying to watch thousands of files. Such as `'**/*.js'` but forgetting to exclude the `node_modules` folder with `'!node_modules/**/*.js'`. Try grouping your files within a subfolder or be more explicit with your file matching pattern.
## Why spawn as child processes as a default?
The goal of this watch task is as files are changed, run tasks as if they were triggered by the user themself. Each time a user runs `grunt` a process is spawned and tasks are ran in succession. In an effort to keep the experience consistent and continualy produce expected results, this watch task spawns tasks as child processes by default.
Sandboxing task runs also allows this watch task to run more stable over long periods of time. As well as more efficiently with more complex tasks and file structures.
Spawning does cause a performance hit (usually 500ms for most environments). It also cripples tasks that rely on the watch task to share the context with each subsequent run (i.e., reload tasks). If you would like a faster watch task or need to share the context please set the `nospawn` option to `true`. Just be aware that with this option enabled, the watch task is more prone to failure.
|
