cartodb
/
grunt-contrib-watch
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Run nodeunit instead of test. Use the latest deps.

Browse Source
pull/23/head
Kyle Robinson Young 12 years ago
parent 4d76707d27
commit 38617875b4
5 changed files with 57 additions and 138 deletions
Show Stats Download Patch File Download Diff File

4
CHANGELOG
Unescape View File

@ -1,3 +1,7 @@
v0.1.5:
changes:
- Allow watch task to be renamed.
- Use grunt.util.spawn "grunt" option.
v0.1.4: v0.1.4:
date: 2012-11-01 date: 2012-11-01
changes: changes:

74
CONTRIBUTING.md
Unescape View File

@ -1,73 +1 @@
[Grunt homepage](http://gruntjs.com/) | [Documentation table of contents](https://github.com/gruntjs/grunt/blob/devel/docs/toc.md) Please see the [Contributing to grunt](http://gruntjs.com/contributing) guide for information on contributing to this project.
# Contributing to grunt
There are a number of grunt projects.
* [grunt](https://github.com/gruntjs/grunt) - the main grunt project
* [gruntjs.com](https://github.com/gruntjs/gruntjs.com) - the gruntjs.com website
* [grunt-contrib collection](https://github.com/gruntjs/grunt-contrib) - a collection of all grunt "contrib" plugins
In addition, each individual grunt-contrib plugin is a separate repository listed on the [gruntjs org homepage](https://github.com/gruntjs).
## Filing issues
If something isn't working like you think it should, please read the documentation first. If you'd like to chat with someone, [pop into IRC](#discussing-grunt) and ask your question there.
The best way to ensure an issue gets addressed is to file it in the appropriate issues tracker.
**If there's an issue with a specific grunt-contrib plugin:**
Please file an issue on that plugin's issues tracker.
**If you'd like to contribute a new plugin:**
Please file an issue on the [grunt-contrib collection issues tracker](https://github.com/gruntjs/grunt-contrib/issues). We don't accept all plugins, but we'll certainly consider yours.
**If there's an issue with the [website](http://gruntjs.com/):**
Please file an issue on the [gruntjs.com website issues tracker](https://github.com/gruntjs/gruntjs.com/issues).
**If there's an issue that isn't specific to any of the above:**
Please file an issue on the [grunt issues tracker](https://github.com/gruntjs/grunt/issues).
### Simplify the issue
Try to [reduce your code](http://www.webkit.org/quality/reduction.html) to the bare minimum required to reproduce the issue. This makes it much easier (and much faster) to isolate and fix the issue.
### Explain the issue
If we can't reproduce the issue, we can't fix it. Please list the exact steps required to reproduce the issue. Include versions of your OS, Node.js, grunt, etc. Include relevant logs or sample code.
## Discussing grunt
Join the [freenode](http://freenode.net/) IRC #grunt channel. We've got a bot and everything.
_No private messages, please._
## Modifying grunt
First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
1. Fork and clone the repo.
1. Check out the correct branch. Currently, grunt development happens in the `devel` branch.
1. Run `npm install` to install all grunt dependencies.
1. Run `npm link` to put the dev version of grunt in the system path (this is only needed for developing grunt, not for plugins or the website).
1. Run `grunt` to grunt grunt.
Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing breaks.
### Submitting pull requests
1. Create a new branch, please don't work in your `master` or `devel` branch directly.
1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
1. Fix stuff.
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
1. Update the documentation to reflect any changes.
1. Push to your fork and submit a pull request.
### Syntax
* Two space indents. Don't use tabs anywhere. Use `\t` if you need a tab character in a string.
* No trailing whitespace, except in markdown files where a linebreak must be forced.
* Don't go overboard with the whitespace.
* No more than [one assignment](http://benalman.com/news/2012/05/multiple-var-statements-javascript/) per `var` statement.
* Delimit strings with single-quotes `'`, not double-quotes `"`.
* Prefer `if` and `else` to ["clever"](http://programmers.stackexchange.com/a/25281) uses of `? :` conditional or `||`, `&&` logical operators.
* Comments are great. Just put them _before_ the line of code, _not_ at the _end_ of the line.
* **When in doubt, follow the conventions you see used in the source already.**
### Reverting back to the "official" grunt
If you've used `npm link` to put a dev version of grunt in the system path and, for some reason, need to revert back to the current official grunt release, just reinstall grunt globally with `npm install -g grunt`

6
Gruntfile.js
Unescape View File

@ -48,11 +48,7 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-nodeunit'); grunt.loadNpmTasks('grunt-contrib-nodeunit');
grunt.loadNpmTasks('grunt-contrib-internal'); grunt.loadNpmTasks('grunt-contrib-internal');
// Whenever the "test" task is run, first clean the "tmp" dir, then run this
// plugin's task(s), then test the result.
grunt.registerTask('test', ['nodeunit']);
// By default, lint and run all tests. // By default, lint and run all tests.
grunt.registerTask('default', ['jshint', 'test', 'build-contrib']); grunt.registerTask('default', ['jshint', 'nodeunit', 'build-contrib']);
}; };

105
README.md
Unescape View File

@ -26,69 +26,26 @@ If the plugin has been installed correctly, running `grunt --help` at the comman
[package.json]: https://npmjs.org/doc/json.html [package.json]: https://npmjs.org/doc/json.html
## The watch-examples task ## The watch task
# Examples ### Overview
```js Inside your `Gruntfile.js` file, add a section named `watch`. This section specifies the files to watch, tasks to run when an event occurs and the options used.
// Simple config to run jshint any time a file is added, changed or deleted ### Settings
grunt.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'],
options: {
nocase: true
}
},
src: {
files: ['lib/*.js', 'css/**/*.scss', '!lib/dontwatch.js'],
tasks: ['default']
},
test: {
files: '<%= jshint.test.src %>',
tasks: ['jshint:test', 'qunit']
}
}
});
```
## The watch-faqs task
# 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). Increase your limit with `ulimit -n 10480`, the number being the new max limit. If you're still running into issues then consider setting the option `forceWatchMethod: 'old'` to use the older and slower stat polling watch method.
## The watch-options task
# Settings
There 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: There 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:
## files #### files
Type: `String|Array` Type: `String|Array`
This defines what file patterns this task will watch. Can be a string or an array of files and/or minimatch patterns. This defines what file patterns this task will watch. Can be a string or an array of files and/or minimatch patterns.
## tasks #### tasks
Type: `String|Array` Type: `String|Array`
This defines which tasks to run when a watched file event occurs. This defines which tasks to run when a watched file event occurs.
## options.interrupt #### options.interrupt
Type: `boolean` Type: `boolean`
Default: false Default: false
@ -107,7 +64,7 @@ watch: {
} }
``` ```
## options.debounceDelay #### options.debounceDelay
Type: `Integer` Type: `Integer`
Default: 500 Default: 500
@ -126,13 +83,13 @@ watch: {
} }
``` ```
## options.interval #### options.interval
Type: `Integer` Type: `Integer`
Default: 100 Default: 100
The `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*. The `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*.
## options.forceWatchMethod #### options.forceWatchMethod
Type: `false|'new'|'old'` Type: `false|'new'|'old'`
Default: false Default: false
@ -140,18 +97,52 @@ Node.js has two file watching methods: 'old' (`fs.watchFile`) which uses stat po
There may be some setups where you would need to force a specific watch method, such as on networked file system. Set `options.forceWatchMethod: 'old'` to specifically use the old watch method, `fs.watchFile`. There may be some setups where you would need to force a specific watch method, such as on networked file system. Set `options.forceWatchMethod: 'old'` to specifically use the old watch method, `fs.watchFile`.
### Examples
## The watch-overview task ```js
// Simple config to run jshint any time a file is added, changed or deleted
# Overview grunt.initConfig({
watch: {
files: '**/*',
tasks: ['jshint']
}
});
```
Inside your `Gruntfile.js` file, add a section named `watch`. This section specifies the files to watch, tasks to run when an event occurs and the options used. ```js
// Advanced config. Run specific tasks when specific files are added, changed or deleted.
grunt.initConfig({
watch: {
gruntfile: {
files: 'Gruntfile.js',
tasks: ['jshint:gruntfile'],
options: {
nocase: true
}
},
src: {
files: ['lib/*.js', 'css/**/*.scss', '!lib/dontwatch.js'],
tasks: ['default']
},
test: {
files: '<%= jshint.test.src %>',
tasks: ['jshint:test', 'qunit']
}
}
});
```
## Release History ## Release History
* 2012-11-19 - v0.1.5 - Allow watch task to be renamed. Use grunt.util.spawn "grunt" option.
* 2012-10-31 - v0.1.4 - Prevent watch from spawning duplicate watch tasks * 2012-10-31 - v0.1.4 - Prevent watch from spawning duplicate watch tasks
* 2012-10-27 - v0.1.3 - Better method to spawn the grunt bin Bump gaze to v0.2.0. Better handles some events and new option forceWatchMethod Only support Node.js >= v0.8 * 2012-10-27 - v0.1.3 - Better method to spawn the grunt bin Bump gaze to v0.2.0. Better handles some events and new option forceWatchMethod Only support Node.js >= v0.8
* 2012-10-16 - v0.1.2 - Only spawn a process per task one at a time Add interrupt option to cancel previous spawned process Grunt v0.3 compatibility changes * 2012-10-16 - v0.1.2 - Only spawn a process per task one at a time Add interrupt option to cancel previous spawned process Grunt v0.3 compatibility changes
* 2012-10-15 - v0.1.1 - Fallback to global grunt bin if local doesnt exist. Fatal if bin cannot be found Update to gaze 0.1.6 * 2012-10-15 - v0.1.1 - Fallback to global grunt bin if local doesnt exist. Fatal if bin cannot be found Update to gaze 0.1.6
* 2012-10-07 - v0.1.0 - Release watch task Remove spawn from helper Run on Grunt v0.4 * 2012-10-07 - v0.1.0 - Release watch task Remove spawn from helper Run on Grunt v0.4
--
Task submitted by <a href="http://dontkry.com">Kyle Robinson Young</a>.
*Generated on Mon Nov 19 2012 12:58:44.*

6
package.json
Unescape View File

@ -25,14 +25,14 @@
"node": ">= 0.8.0" "node": ">= 0.8.0"
}, },
"scripts": { "scripts": {
"test": "grunt test -v" "test": "grunt nodeunit -v"
}, },
"dependencies": { "dependencies": {
"gaze": "~0.2.0" "gaze": "~0.2.0"
}, },
"devDependencies": { "devDependencies": {
"grunt-contrib-jshint": "0.1.0", "grunt-contrib-jshint": "~0.1.0",
"grunt-contrib-nodeunit": "0.1.0", "grunt-contrib-nodeunit": "~0.1.0",
"grunt-contrib-internal": "*", "grunt-contrib-internal": "*",
"grunt": "~0.4.0a" "grunt": "~0.4.0a"
}, },

Write Preview
Loading…
Cancel
Save