Skip to content

Commit 96ab355

Browse files
Updated Badges
1 parent b033305 commit 96ab355

File tree

1 file changed

+21
-24
lines changed

1 file changed

+21
-24
lines changed

README.md

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# grunt-githooks
22

3-
[![Build Status](https://travis-ci.org/rhumaric/grunt-githooks.png?branch=master)](https://travis-ci.org/rhumaric/grunt-githooks)
4-
[![Code Climate](https://codeclimate.com/github/rhumaric/grunt-githooks.png)](https://codeclimate.com/github/rhumaric/grunt-githooks)
3+
[![Build Status](https://travis-ci.org/wecodemore/grunt-githooks.png?branch=master)](https://travis-ci.org/wecodemore/grunt-githooks)
4+
[![Code Climate](https://codeclimate.com/github/wecodemore/grunt-githooks.png)](https://codeclimate.com/github/wecodemore/grunt-githooks)
55

66
> A Grunt plugin to help bind Grunt tasks to Git hooks
77
@@ -43,9 +43,9 @@ grunt.initConfig({
4343

4444
#### Defining a few hooks
4545

46-
Hooks are listed as keys of your target configuration.
47-
**Any key other than `option`** is considered the name of a hook you want to create.
48-
The simplest way to define a hook is to provide a **space-separated list of the tasks you want the hook to run as the value**.
46+
Hooks are listed as keys of your target configuration.
47+
**Any key other than `option`** is considered the name of a hook you want to create.
48+
The simplest way to define a hook is to provide a **space-separated list of the tasks you want the hook to run as the value**.
4949

5050
For example:
5151
```js
@@ -64,8 +64,8 @@ It will still create the hook, though, in case Git introduces new hooks in the f
6464

6565
#### Hook specific options
6666

67-
If you need to override a few options for a given hook only, you can *use and Object instead of a String*.
68-
The `taskNames` property will then correspond to the tasks you want to run.
67+
If you need to override a few options for a given hook only, you can *use and Object instead of a String*.
68+
The `taskNames` property will then correspond to the tasks you want to run.
6969
Any other key will be merged into the options.
7070

7171
```js
@@ -75,7 +75,7 @@ grunt.initConfig({
7575
options: {
7676
template: 'path/to/a/template'
7777
},
78-
// Will bind the jshint and test:unit tasks
78+
// Will bind the jshint and test:unit tasks
7979
// with the template specified above
8080
'pre-commit': 'jshint test:unit',
8181

@@ -92,7 +92,7 @@ grunt.initConfig({
9292

9393
#### Working with existing hooks
9494

95-
If you happen to have existing hooks in your hook folder, the plugin *appends the code launching Grunt* at the end of your hooks.
95+
If you happen to have existing hooks in your hook folder, the plugin *appends the code launching Grunt* at the end of your hooks.
9696
You can also insert marker comments in your hooks to specify exactly where you want them inserted.
9797
Your existing hook would look something like this:
9898

@@ -108,9 +108,9 @@ The markers get automatically inserted when the plugin appends code, so hooks ge
108108

109109
#### Customising hook output
110110

111-
By default, the plugin generate NodeJS scripts for the hooks.
111+
By default, the plugin generate NodeJS scripts for the hooks.
112112
Reasonning behind this is that creating Shell scripts won't work well for people using Windows.
113-
Plus, NodeJS is already installed as Grunt kinda needs it.
113+
Plus, NodeJS is already installed as Grunt kinda needs it.
114114
However, you're not tied to it and you can customise the generated script entirely. In case of a Shell script:
115115

116116
```js
@@ -142,8 +142,8 @@ In the template, you've got access to the following variables:
142142

143143
#### Extending the plugin
144144

145-
Pretty annoying when you're using a library that's missing the exact extension point you need to tweak its functionalities?
146-
`grunt-githooks` is based on a lot of small functions and most of them are exposed so you can override them.
145+
Pretty annoying when you're using a library that's missing the exact extension point you need to tweak its functionalities?
146+
`grunt-githooks` is based on a lot of small functions and most of them are exposed so you can override them.
147147
If you need feel, free to tinker with the internals (at your own risk though ;)). Could be something along:
148148

149149
```js
@@ -188,7 +188,7 @@ code in it (to avoid inserting Node code in a Python hook for example).
188188
Type: `String`
189189

190190
Path to the Handlebars template used to generate the code that will run Grunt
191-
in the hook. Default template is the `node.js.hb` file located in the `templates` folder of the plugin.
191+
in the hook. Default template is the `node.js.hb` file located in the `templates` folder of the plugin.
192192
It also contains a `shell.hb` file with the template for a shell script hook.
193193

194194
> **Note**: Handlebars escapes HTML special characters if you use only two curly braces to insert
@@ -203,22 +203,22 @@ Default: `'// GRUNT-GITHOOKS START'`
203203
Type: `String`
204204
Default: `'// GRUNT-GITHOOKS END'`
205205

206-
`startMarker` and `endMarker` are markers the plugin use to know where to insert code if a hook already exist.
206+
`startMarker` and `endMarker` are markers the plugin use to know where to insert code if a hook already exist.
207207
If the existing hook doesn't have these markers, the code will simply be appended.
208208

209209
#### preventExit
210210
Type: `Boolean`
211211
Default `false`
212212

213-
By default, the inserted code will exit the process after Grunt has run, using a -1 exit code if the task(s) failed.
213+
By default, the inserted code will exit the process after Grunt has run, using a -1 exit code if the task(s) failed.
214214
If you're inserting the code running Grunt in the middle of an existing hook,
215215
you might want to disable this so any code after what was inserted by the plugin runs.
216216

217217
#### dest
218218
Type: `String`
219219
Default value: `'.git/hooks'`
220220

221-
This option allows you to choose in which directory the hooks should be generated.
221+
This option allows you to choose in which directory the hooks should be generated.
222222
Comes in handy if your Gruntfile is not at the root of your Git project.
223223

224224

@@ -228,12 +228,9 @@ In lieu of a formal styleguide, take care to maintain the existing coding style.
228228

229229

230230
## Release History
231-
232-
- 2013-12-17 v0.3.1 [Escaping fix in the hooks templates](https://github.com/rhumaric/grunt-githooks/pull/15) by @gyoshev.
231+
232+
- 2014-07-30 v0.3.2 Moved from @rhumaric to @wecodemore, updated default Nodejs template, updated badges
233+
- 2013-12-17 v0.3.1 [Escaping fix in the hooks templates](https://github.com/wecodemore/grunt-githooks/pull/15) by @gyoshev.
233234
- 2013-11-13 v0.3.0 New *command* option to specify which command to run, in case full path to Grunt is needed. NodeJS template now uses new `escapeBackslashes` helper to make sure backslashes ('\') are properly escaped when written in the hook
234235
- 2013-10-05 v0.2.0 New *args* option to specify arguments to hooked task. Bugfix to allow running grunt when the Gruntfile is not at the root of the project.
235-
- 2013-09-02 v0.1.0 Initial functionnalities
236-
237-
238-
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/rhumaric/grunt-githooks/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
239-
236+
- 2013-09-02 v0.1.0 Initial functionalities

0 commit comments

Comments
 (0)