Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janl/grunt-hoodie
Start hoodie and delay grunting till it is ready.
https://github.com/janl/grunt-hoodie
Last synced: 3 months ago
JSON representation
Start hoodie and delay grunting till it is ready.
- Host: GitHub
- URL: https://github.com/janl/grunt-hoodie
- Owner: janl
- License: mit
- Fork: true (hoodiehq-archive/grunt-hoodie)
- Created: 2014-03-29T10:43:33.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-03-11T18:02:19.000Z (almost 11 years ago)
- Last Synced: 2024-04-07T01:27:40.978Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 259 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-hoodie
[](http://badge.fury.io/js/grunt-hoodie)
> Start hoodie and delay grunting till it is ready. Triggers a callback with hosts and ports of couchDB, www and pocket.
## Getting Started
This plugin requires Grunt `~0.4.1`
If 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:
```shell
npm install grunt-hoodie --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-hoodie');
```
## The "hoodie" task
### Overview
In your project's Gruntfile, add a section named `hoodie` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
hoodie: {
start: {
options: {
callback: function (stack) {
// For example, set the port of grunt-connect-proxy:
// grunt.config.set('connect.proxies.0.port', stack.www.port);
}
}
}
},
})
```
### Options
#### options.callback
Type: `Function`
Default value: `function(stack) {}`
A callback that is called when hoodie is up and running. Has one param called `stack` which contains the host and port information.
### Usage Example
In this example, the port of [grunt-connect-proxy](https://npmjs.org/package/grunt-connect-proxy) for the `/_api` of hoodie is set after hoodie started.
```js
grunt.initConfig({
hoodie: {
start: {
options: {
callback: function(config) {
grunt.config.set('connect.proxies.0.port', config.stack.www.port);
}
}
}
},
connect: {
options: {
port: 9000,
hostname: 'localhost'
},
proxies: [
{
context: '/_api',
host: 'localhost',
port: false,
https: false,
changeOrigin: false
}
],
…
},
})
```
## The "hoodie\_stop" task
This will stop any Hoodie servers started by the 'hoodie' task. No config
is required.
## Contributing
Take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## Release History
0.3.0 Added stop task
0.2.1 Updated dev dependencies
0.2.0 Updated to work with new hoodie version
0.1.0 Initial release