Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "lib/cli/setup/addGitHooks"

Index

Variables

Functions

Variables

Const AtomistEndComment

AtomistEndComment: "######### Atomist end #########" = "######### Atomist end #########"

Const AtomistStartComment

AtomistStartComment: "######## Atomist start ########" = "######## Atomist start ########"

Const atomistContentRegExp

atomistContentRegExp: RegExp = /\n#+\s+Atomist start\s+#+\n[\S\s]*?\n#+\s+Atomist end\s+#+\n/

Functions

addGitHooks

  • addGitHooks(projectBaseDir: string): Promise<void>

addGitHooksToProject

  • addGitHooksToProject(p: LocalProject): Promise<void>

deatomizeScript

  • deatomizeScript(p: LocalProject, scriptPath: string): Promise<LocalProject>

markAsAtomistContent

  • markAsAtomistContent(toAppend: string): string

reatomizeScript

  • reatomizeScript(p: LocalProject, scriptPath: string, newContent: string): Promise<LocalProject>

  • Update the Atomist script element if found

    Parameters

    • p: LocalProject
    • scriptPath: string
    • newContent: string

    Returns Promise<LocalProject>

removeGitHooks

  • removeGitHooks(baseDir: string): Promise<void>

removeGitHooksFromProject

  • removeGitHooksFromProject(p: LocalProject): Promise<void>

scriptFragments

  • scriptFragments(): object

  • Indexed templates fragments for use in git hooks

    Returns object

    object whose keys are HookEvents and whose values are the shell script snippet for the hook

Generated using TypeDoc