# sails-generate-githooks

> sails generate githooks

Latest version **0.1.5** (published 2014-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install sails-generate-githooks
pnpm add sails-generate-githooks
yarn add sails-generate-githooks
bun add sails-generate-githooks
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2014-11-06 |
| First published | 2014-11-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | balderdashy |
| Maintainers | alexmarch |
| Keywords | githooks, generator, sails, generate, plugin |

## Links

- npm: https://www.npmjs.com/package/sails-generate-githooks
- npm.io page: https://npm.io/package/sails-generate-githooks

## Dependencies (5)

- [debug](https://npm.io/package/debug.md) ^2.1.0
- [lodash](https://npm.io/package/lodash.md) >=2.4.x
- [express](https://npm.io/package/express.md) ^4.10.1
- [body-parser](https://npm.io/package/body-parser.md) ^1.9.2
- [merge-defaults](https://npm.io/package/merge-defaults.md) >=0.1.0

## Recent versions

- 0.1.5 (latest) — 2014-11-06
- 0.1.4 — 2014-11-06
- 0.1.3 — 2014-11-06
- 0.1.2 — 2014-11-06
- 0.1.1 — 2014-11-06
- 0.1.0 — 2014-11-06
- 0.0.18 — 2014-11-06
- 0.0.17 — 2014-11-06
- 0.0.16 — 2014-11-06
- 0.0.15 — 2014-11-06
- 0.0.14 — 2014-11-06
- 0.0.13 — 2014-11-06
- 0.0.12 — 2014-11-06
- 0.0.11 — 2014-11-06
- 0.0.10 — 2014-11-06
- … 9 more at https://npm.io/package/sails-generate-githooks/versions

## README

# sails-generate-githooks

A `githooks` generator for use with the Sails command-line interface.

Certain generators are installed by default in Sails, but they can be overridden.  Other generators create entirely new things.  Check the [Sails docs](http://sailsjs.org/#!documentation) for information on installing generator overrides / custom generators and information on building your own generators.



### Installation

```sh
$ npm install sails-generate-githooks
```


### Usage

##### On the command line

```sh
$ sails generate githooks 
```

##### Start deployment

```sh
$ forever start githooks.js
```
### Configure
```sh
file: config/githooks.conf.js
```
```javascript
// GITHooks config file
var post = require('../hooks/post.hook'),
marge = require('../hooks/marge.hook');

module.exports = {
	appPath: "~/apps/hooks",
	user: [],
	hooks: {
		"post": post,
		"marge": marge
	},
	port: 8080
}
```
##### Hook example on post back
```javascript
	module.exports = function (hookParams, hook) {
	// Post hook filter
	hook.do('git', ['pull'], function(){
		hook.do('forever', ['restartall'], function(){
			console.log("POST hook done.");
			//...
		});
	});
}
```

### Development

To get started quickly and see this generator in action, ...

Also see `CONTRIBUTING.md` for more information on overriding/enhancing existing generators.


### Questions?

See `FAQ.md`.



### More Resources

- [Stackoverflow](http://stackoverflow.com/questions/tagged/sails.js)
- [#sailsjs on Freenode](http://webchat.freenode.net/) (IRC channel)
- [Twitter](https://twitter.com/sailsjs)
- [Professional/enterprise](https://github.com/balderdashy/sails-docs/blob/master/FAQ.md#are-there-professional-support-options)
- [Tutorials](https://github.com/balderdashy/sails-docs/blob/master/FAQ.md#where-do-i-get-help)
- <a href="http://sailsjs.org" target="_blank" title="Node.js framework for building realtime APIs."><img src="https://github-camo.global.ssl.fastly.net/9e49073459ed4e0e2687b80eaf515d87b0da4a6b/687474703a2f2f62616c64657264617368792e6769746875622e696f2f7361696c732f696d616765732f6c6f676f2e706e67" width=60 alt="Sails.js logo (small)"/></a>


### License

**[MIT](./LICENSE)**
&copy; 2014 [balderdashy](http://github.com/balderdashy) & contributors

As for [Sails](http://sailsjs.org)?  It's free and open-source under the [MIT License](http://sails.mit-license.org/).

![image_squidhome@2x.png](http://i.imgur.com/RIvu9.png)

---
_Source: https://npm.io/package/sails-generate-githooks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._