JSDoc: Module: api/'0.1'/projectFs/gitHooks

This module deals with installing/removing a project's local git hooks

Source:

src/api/0.1/project-fs/git-hooks.js, line 2

Methods

(inner) chmodExec(root, hook, permsopt) → {Q.Promise}

Parameters:

Name	Type	Attributes
`root`	string
`hook`	string
`perms`	string	<optional>

Source:

src/api/0.1/project-fs/git-hooks.js, line 51

Returns:

Type: Q.Promise

(inner) clusternateHook(hook) → {string}

Parameters:

Name	Type	Description
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 41

Returns:

Type: string

(inner) getHookSkeleton(hook) → {Q.Promise.<string>}

Parameters:

Name	Type	Description
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 75

Returns:

Type: Q.Promise.<string>

(inner) hpath(root, hook) → {string}

Parameters:

Name	Type	Description
`root`	string
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 33

Returns:

Type: string

(inner) ignoreFileNotFound(err)

Parameters:

Name	Type	Description
`err`	Error

Source:

src/api/0.1/project-fs/git-hooks.js, line 157

Throws:

Error

(inner) installExecutable(root, hook) → {Q.Promise}

Parameters:

Name	Type	Description
`root`	string
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 65

Returns:

Type: Q.Promise

(inner) installHook(root, hook) → {Q.Promise}

Parameters:

Name	Type	Description
`root`	string
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 209

Returns:

Type: Q.Promise

(inner) installHooks(root)

Parameters:

Name	Type	Description
`root`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 229

(inner) installHookText(hookText, hook) → {string}

Parameters:

Name	Type	Description
`hookText`	string
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 136

Returns:

Type: string

(inner) invokeHookName(hook) → {string}

Parameters:

Name	Type	Description
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 107

Returns:

Type: string

(inner) pruneExecutable(root, hook) → {Q.Promise}

Parameters:

Name	Type	Description
`root`	string
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 185

Returns:

Type: Q.Promise

(inner) pruneHook(root, hook) → {Q.Promise}

Parameters:

Name	Type	Description
`root`	string
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 197

Returns:

Type: Q.Promise

(inner) pruneHooks(root) → {Q.Promise}

Parameters:

Name	Type	Description
`root`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 220

Returns:

Type: Q.Promise

(inner) pruneHookText(hookText, hook) → {string}

Parameters:

Name	Type	Description
`hookText`	string
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 127

Returns:

Type: string

(inner) pruneMasterExecutable() → {Q.Promise.<T>}

Source:

src/api/0.1/project-fs/git-hooks.js, line 147

Returns:

Type: Q.Promise.<T>

(inner) readFile(root, fileName) → {Q.Promise.<string>}

Parameters:

Name	Type	Description
`root`	string
`fileName`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 84

Returns:

Type: Q.Promise.<string>

(inner) updateMasterExecutable(root, hook) → {Q.Promise}

Parameters:

Name	Type	Description
`root`	string
`hook`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 171

Returns:

Type: Q.Promise

(inner) writeFile(root, fileName, data) → {Q.Promise}

Parameters:

Name	Type	Description
`root`	string
`fileName`	string
`data`	string

Source:

src/api/0.1/project-fs/git-hooks.js, line 94

Returns:

Type: Q.Promise

Methods

(inner) chmodExec(root, hook, permsopt) → {Q.Promise}

Parameters:

Returns:

(inner) clusternateHook(hook) → {string}

Parameters:

Returns:

(inner) getHookSkeleton(hook) → {Q.Promise.<string>}

Parameters:

Returns:

(inner) hpath(root, hook) → {string}

Parameters:

Returns:

(inner) ignoreFileNotFound(err)

Parameters:

Throws:

(inner) installExecutable(root, hook) → {Q.Promise}

Parameters:

Returns:

(inner) installHook(root, hook) → {Q.Promise}

Parameters:

Returns:

(inner) installHooks(root)

Parameters:

(inner) installHookText(hookText, hook) → {string}

Parameters:

Returns:

(inner) invokeHookName(hook) → {string}

Parameters:

Returns:

(inner) pruneExecutable(root, hook) → {Q.Promise}

Parameters:

Returns:

(inner) pruneHook(root, hook) → {Q.Promise}

Parameters:

Returns:

(inner) pruneHooks(root) → {Q.Promise}

Parameters:

Returns:

(inner) pruneHookText(hookText, hook) → {string}

Parameters:

Returns:

(inner) pruneMasterExecutable() → {Q.Promise.<T>}

Returns:

(inner) readFile(root, fileName) → {Q.Promise.<string>}

Parameters:

Returns:

(inner) updateMasterExecutable(root, hook) → {Q.Promise}

Parameters:

Returns:

(inner) writeFile(root, fileName, data) → {Q.Promise}

Parameters:

Returns:

Docs