https://github.com/zixia/git-scripts
Git hooks integration for Node.js projects
https://github.com/zixia/git-scripts
Last synced: about 1 year ago
JSON representation
Git hooks integration for Node.js projects
- Host: GitHub
- URL: https://github.com/zixia/git-scripts
- Owner: zixia
- License: mit
- Created: 2013-09-01T17:37:52.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2022-04-14T00:17:58.000Z (about 4 years ago)
- Last Synced: 2025-04-12T15:11:45.241Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://npmjs.com/package/git-scripts
- Size: 76.2 KB
- Stars: 47
- Watchers: 4
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-scripts [](https://www.npmjs.com/package/git-scripts)
Manage [git hooks](http://git-scm.com/book/en/Customizing-Git-Git-Hooks) with the "git.scripts" field of the package.json like [npm-scripts](https://npmjs.org/doc/scripts.html).
```json
{
"name": "your-project",
"version": "0.0.0",
"description": "",
"devDependencies": {
"git-scripts": "*"
},
"git": {
"scripts": {
"pre-commit": "npm test",
"post-merge": "npm install"
}
}
}
```
See also [this module's package.json](https://github.com/nkzawa/git-scripts/blob/master/package.json) as an example.
## Installation
$ npm install git-scripts
NOTE: `.git/hooks` of your project is replaced when installed. You can restore it by uninstalling the module.
## Description
git-scripts supports all hooks including the following:
* applypatch-msg
* pre-applypatch
* post-applypatch
* pre-commit
* prepare-commit-msg
* commit-msg
* post-commit
* pre-rebase
* post-checkout
* post-merge
* pre-receive
* update
* post-receive
* post-update
* pre-auto-gc
* post-rewrite
* pre-push
## CLI
$ npm install -g git-scripts
```
Usage: git-scripts [options]
Options:
-h, --help output usage information
-V, --version output the version number
Commands:
install [path] install git-scripts
uninstall [path] uninstall git-scripts
run [args ...] run arbitrary scripts
```
NOTE: Usually, you don't need CLI. Hooks are enabled automatically when you install the module locally.
## Using Programmatically
If you would like to use git-scripts programmatically, you can do that.
```js
var scripts = require('git-scripts');
var project = scripts('somewhere/yourproject');
project.install(function(err) {
if (err) throw err;
console.log('git-scripts was installed.');
project.run('pre-commit', function(err) {
if (err) throw err;
console.log('pre-commit script succeeded.');
});
});
```
### Documentation
```js
var scripts = require('git-scripts');
var project = scripts('somewhere/yourproject');
```
#### scripts([path])
Create a git-scripts instance for `path`.
#### project.install([callback])
Install git-scripts.
#### project.uninstall([callback])
Uninstall git-scripts.
#### project.run(name, [args ...], [callback])
Run an arbitrary command of `name`.
## Author
Naoyuki Kanezawa
## Maintainer
[Huan LI](https://github.com/huan) ([李卓桓](http://linkedin.com/in/zixia))
## License
MIT