|
|
{ "name": "grunt-contrib-watch", "description": "Run predefined tasks whenever watched file patterns are added, changed or deleted.", "version": "0.4.0", "homepage": "https://github.com/gruntjs/grunt-contrib-watch", "author": { "name": "Grunt Team", "url": "http://gruntjs.com/" }, "repository": { "type": "git", "url": "git://github.com/gruntjs/grunt-contrib-watch.git" }, "bugs": { "url": "https://github.com/gruntjs/grunt-contrib-watch/issues" }, "licenses": [ { "type": "MIT", "url": "https://github.com/gruntjs/grunt-contrib-watch/blob/master/LICENSE-MIT" } ], "main": "Gruntfile.js", "engines": { "node": ">= 0.8.0" }, "scripts": { "test": "grunt nodeunit -v" }, "dependencies": { "gaze": "~0.3.4", "tiny-lr": "0.0.4" }, "devDependencies": { "grunt": "~0.4.0", "grunt-contrib-jshint": "~0.4.3", "grunt-contrib-nodeunit": "~0.1.2", "grunt-contrib-internal": "~0.4.5" }, "peerDependencies": { "grunt": "~0.4.0" }, "keywords": [ "gruntplugin", "watch" ], "contributors": [ { "name": "Kyle Robinson Young", "url": "http://dontkry.com" }, { "name": "\"Cowboy\" Ben Alman", "url": "http://benalman.com" }, { "name": "Tyler Kellen", "url": "http://goingslowly.com" }, { "name": "Gong Hao" }, { "name": "Jaime Pillora" }, { "name": "Chris Danford" }, { "name": "Jason San Jose" }, { "name": "Oleg Seletsky" }, { "name": "Jamie Stackhouse" }, { "name": "Chris Talkington" } ], "readme": "# grunt-contrib-watch [](https://travis-ci.org/gruntjs/grunt-contrib-watch)\n\n> Run predefined tasks whenever watched file patterns are added, changed or deleted.\n\n\n\n## Getting Started\nThis plugin requires Grunt `~0.4.0`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-contrib-watch --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-contrib-watch');\n```\n\n\n\n\n## Watch task\n_Run this task with the `grunt watch` command._\n\n\n### Settings\n\nThere are a number of options available. Please review the [minimatch options here](https://github.com/isaacs/minimatch#options). As well as some additional options as follows:\n\n#### files\nType: `String|Array`\n\nThis defines what file patterns this task will watch. Can be a string or an array of files and/or minimatch patterns.\n\n#### tasks\nType: `String|Array`\n\nThis defines which tasks to run when a watched file event occurs.\n\n#### options.nospawn\nType: `Boolean`\nDefault: false\n\nThis instructs the watch task to not spawn task runs in a child process. Setting this option also speeds up the reaction time of the watch (usually 500ms faster for most) and allows subsequent task runs to share the same context (i.e., using a reload task). Not spawning task runs can make the watch more prone to failing so please use as needed.\n\nExample:\n```js\nwatch: {\n scripts: {\n files: ['**/*.js'],\n tasks: ['livereload'],\n options: {\n nospawn: true\n }\n }\n}\n```\n\n#### options.interrupt\nType: `Boolean`\nDefault: false\n\nAs files are modified this watch task will spawn tasks in child processes. The default behavior will only spawn a new child process per target when the previous process has finished. Set the `interrupt` option to true to terminate the previous process and spawn a new one upon later changes.\n\nExample:\n```js\nwatch: {\n scripts: {\n files: '**/*.js',\n tasks: ['jshint'],\n options: {\n interrupt: true\n }\n }\n}\n```\n\n#### options.debounceDelay\nType: `Integer`\nDefault: 500\n\nHow long to wait before emitting events in succession for the same filepath and status. For example if your `Gruntfile.js` file was `changed`, a `changed` event will only fire again after the given milliseconds.\n\nExample:\n```js\nwatch: {\n scripts: {\n files: '**/*.js',\n tasks: ['jshint'],\n options: {\n debounceDelay: 250\n }\n }\n}\n```\n\n#### options.interval\nType: `Integer`\nDefault: 100\n\nThe `interval` is passed to `fs.watchFile`. Since `interval` is only used by `fs.watchFile` and this watcher also uses `fs.watch`; it is recommended to ignore this option. *Default is 100ms*.\n\n###### options.event\nType: `String|Array`\nDefault: `'all'`\n\nSpecify the type watch event that trigger the specified task. This option can be one or many of: `'all'`, `'changed'`, `'added'` and `'deleted'`.\n\nExample:\n```js\nwatch: {\n scripts: {\n files: '**/*.js',\n tasks: ['generateFileManifest'],\n options: {\n event: ['added', 'deleted']\n }\n }\n}\n```\n\n#### options.forever\nType: `Boolean`\nDefault: true\n\nThis is *only a task level option* and cannot be configured per target. By default the watch task will duck punch `grunt.fatal` and `grunt.warn` to try and prevent them from exiting the watch process. If you don't want `grunt.fatal` and `grunt.warn` to be overridden set the `forever` option to `false`.\n\n#### options.livereload\nType: `Boolean|Number|Object`\nDefault: false\n\nSet to `true` or set `livereload: 1337` to a port number to enable live reloading. Def "readmeFilename": "README.md", "_id": "grunt-contrib-watch@0.4.0", "_from": "grunt-contrib-watch@~0.4.0"}
|
