Class git

GitHub Command Helper For NodeJS

Hierarchy

Constructors

constructor

new git(dir: string): git
Parameters
- dir: string
Returns git
- Defined in node_modules/git-command-helper/dist/git.d.ts:54

Properties

branch

branch: string

cwd

cwd: string

email

email: string

`Private` exist

exist: any

getGithubBranches

getGithubBranches: ((opt?: SpawnOptions) => Promise<void | {
active: boolean;
branch: string;
}[]>)

Type declaration

- (opt?: SpawnOptions): Promise<void | {
  active: boolean;
  branch: string;
  }[]>
- get current branch informations
  
  Returns
  Parameters
  - Optional opt: SpawnOptions
  Returns Promise<void | {
  active: boolean;
  branch: string;
  }[]>

getGithubCurrentBranch

getGithubCurrentBranch: ((opt?: SpawnOptions) => Promise<string | void>)

Type declaration

- (opt?: SpawnOptions): Promise<string | void>
- get current branch
  
  Returns
  Parameters
  - Optional opt: SpawnOptions
  Returns Promise<string | void>

getGithubRemote

getGithubRemote: ((name?: null | string, opt?: SpawnOptions) => Promise<string | void>)

Type declaration

- (name?: null | string, opt?: SpawnOptions): Promise<string | void>
- get origin url
  - see https://stackoverflow.com/a/4090938
  Returns
  Parameters
  - Optional name: null | string
    
    remote name in config, default origin
  - Optional opt: SpawnOptions
  Returns Promise<string | void>

getGithubRepoUrl

getGithubRepoUrl: ((path: string, opt?: SpawnOptions) => Promise<{
rawURL: string;
remoteURL: string;
}>)

Type declaration

- (path: string, opt?: SpawnOptions): Promise<{
  rawURL: string;
  remoteURL: string;
  }>
- Get github url for single file or folder
  Parameters
  - path: string
    
    path subfolder or file
  - Optional opt: SpawnOptions
  Returns Promise<{
  rawURL: string;
  remoteURL: string;
  }>

getGithubRootDir

getGithubRootDir: ((opt?: SpawnOptions) => Promise<string | void>)

Type declaration

- (opt?: SpawnOptions): Promise<string | void>
- get root directory of local repository
  - see https://stackoverflow.com/a/957978
  Returns
  Parameters
  - Optional opt: SpawnOptions
  Returns Promise<string | void>

helper

helper: typeof default

infos

infos: {
    getGithubBranches: ((opt?: SpawnOptions) => Promise<void | {
        active: boolean;
        branch: string;
    }[]>);
    getGithubCurrentBranch: ((opt?: SpawnOptions) => Promise<string | void>);
    getGithubRemote: ((name?: null | string, opt?: SpawnOptions) => Promise<string | void>);
    getGithubRepoUrl: ((path: string, opt?: SpawnOptions) => Promise<{
        rawURL: string;
        remoteURL: string;
    }>);
    getGithubRootDir: ((opt?: SpawnOptions) => Promise<string | void>);
}

Type declaration

getGithubBranches: ((opt?: SpawnOptions) => Promise<void | {
active: boolean;
branch: string;
}[]>)
- - (opt?: SpawnOptions): Promise<void | {
    active: boolean;
    branch: string;
    }[]>
  - get current branch informations
    
    Returns
    Parameters
    - Optional opt: SpawnOptions
    Returns Promise<void | {
    active: boolean;
    branch: string;
    }[]>
getGithubCurrentBranch: ((opt?: SpawnOptions) => Promise<string | void>)
- - (opt?: SpawnOptions): Promise<string | void>
  - get current branch
    
    Returns
    Parameters
    - Optional opt: SpawnOptions
    Returns Promise<string | void>
getGithubRemote: ((name?: null | string, opt?: SpawnOptions) => Promise<string | void>)
- - (name?: null | string, opt?: SpawnOptions): Promise<string | void>
  - get origin url
    - see https://stackoverflow.com/a/4090938
    Returns
    Parameters
    - Optional name: null | string
      
      remote name in config, default origin
    - Optional opt: SpawnOptions
    Returns Promise<string | void>
getGithubRepoUrl: ((path: string, opt?: SpawnOptions) => Promise<{
rawURL: string;
remoteURL: string;
}>)
- - (path: string, opt?: SpawnOptions): Promise<{
    rawURL: string;
    remoteURL: string;
    }>
  - Get github url for single file or folder
    Parameters
    - path: string
      
      path subfolder or file
    - Optional opt: SpawnOptions
    Returns Promise<{
    rawURL: string;
    remoteURL: string;
    }>
getGithubRootDir: ((opt?: SpawnOptions) => Promise<string | void>)
- - (opt?: SpawnOptions): Promise<string | void>
  - get root directory of local repository
    - see https://stackoverflow.com/a/957978
    Returns
    Parameters
    - Optional opt: SpawnOptions
    Returns Promise<string | void>

latestCommit

latestCommit: ((path?: string, options?: Partial<GetLatestCommitHashOptions>) => Promise<string>)

Type declaration

- (path?: string, options?: Partial<GetLatestCommitHashOptions>): Promise<string>
- Parameters
  - Optional path: string
  - Optional options: Partial<GetLatestCommitHashOptions>
  Returns Promise<string>

remote

remote: string

`Private` spawnOpt

spawnOpt: any

Spawn option default stdio pipe

Param

Returns

submodule

submodule: submodule

user

user: string

`Static` helper

helper: typeof default

`Static` noop

noop: ((..._: any[]) => void)

Type declaration

- (..._: any[]): void
- Parameters
  - Rest ..._: any[]
  Returns void

`Static` shell

shell: ((cmd: string, args: string[], opt?: ShellOptions) => Promise<string | void | Buffer>)

Type declaration

- (cmd: string, args: string[], opt?: ShellOptions): Promise<string | void | Buffer>
- asynchronous spawner
  
  Returns
  Parameters
  - cmd: string
  - args: string[]
  - Optional opt: ShellOptions
  Returns Promise<string | void | Buffer>

Methods

add

add(path: string, optionSpawn?: SpawnOptions): Bluebird<string>
git add

Returns
Parameters
- path: string
  
  specific path or argument -A
- Optional optionSpawn: SpawnOptions
Returns Bluebird<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:166

addAndCommit

addAndCommit(path: string, msg: string, mode?: string): Bluebird<unknown>
add and commit file

Returns
Parameters
- path: string
- msg: string
- Optional mode: string
  
  am/m
Returns Bluebird<unknown>
- Defined in node_modules/git-command-helper/dist/git.d.ts:131

addSafe

addSafe(): Promise<string | void>
git config --global --add safe.directory PATH_FOLDER

Returns Promise<string | void>
- Defined in node_modules/git-command-helper/dist/git.d.ts:76

canPush

canPush(originName?: string, branchName?: string): Promise<boolean>
check if can be pushed
Parameters
- Optional originName: string
  
  origin name
- Optional branchName: string
Returns Promise<boolean>
- Defined in node_modules/git-command-helper/dist/git.d.ts:153

checkLock

checkLock(): boolean
Returns boolean
- Defined in node_modules/git-command-helper/dist/git.d.ts:232

checkout

checkout(branchName: string, optionSpawn?: SpawnOptions): Promise<string>
git checkout

Returns
Parameters
- branchName: string
- Optional optionSpawn: SpawnOptions
Returns Promise<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:173

commit

commit(msg: string, mode?: string, optionSpawn?: SpawnOptions): Bluebird<string>
git commit

Returns
Parameters
- msg: string
  
  commit messages
- Optional mode: string
  
  am, -m, etc
- Optional optionSpawn: SpawnOptions
Returns Bluebird<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:123

commits

commits(options: {
    msg?: string;
    path: string;
    [key: string]: any;
}[]): Bluebird<Error[]>
bulk add and commit

Returns
Parameters
- options: {
      msg?: string;
      path: string;
      [key: string]: any;
  }[]
  
  array of path and msg commit message
Returns Bluebird<Error[]>
- Defined in node_modules/git-command-helper/dist/git.d.ts:137

fetch

fetch(arg?: string[], optionSpawn?: SpawnOptions): Bluebird<string>
git fetch

Returns
Parameters
- Optional arg: string[]
  
  argument git-fetch, ex ['--all']
- Optional optionSpawn: SpawnOptions
Returns Bluebird<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:102

getbranch

getbranch(): Promise<{
active: boolean;
branch: string;
}[]>
get current branch informations

Returns

Returns Promise<{
active: boolean;
branch: string;
}[]>
- Defined in node_modules/git-command-helper/dist/git.d.ts:178

getremote

getremote(args?: string[]): Promise<{
    fetch: {
        origin: string;
        url: string;
    };
    push: {
        origin: string;
        url: string;
    };
}>
get remote information

Returns
Parameters
- Optional args: string[]
Returns Promise<{
    fetch: {
        origin: string;
        url: string;
    };
    push: {
        origin: string;
        url: string;
    };
}>
- Defined in node_modules/git-command-helper/dist/git.d.ts:222

info

info(): Promise<{
    branch: {
        active: boolean;
        branch: string;
    }[];
    opt: SpawnOptions;
    remote: {
        fetch: {
            origin: string;
            url: string;
        };
        push: {
            origin: string;
            url: string;
        };
    };
    status: StatusResult[];
}>
Returns Promise<{
    branch: {
        active: boolean;
        branch: string;
    }[];
    opt: SpawnOptions;
    remote: {
        fetch: {
            origin: string;
            url: string;
        };
        push: {
            origin: string;
            url: string;
        };
    };
    status: StatusResult[];
}>
- Defined in node_modules/git-command-helper/dist/git.d.ts:55

init

init(spawnOpt?: SpawnOptions): Promise<string | void>
git init

Returns
Parameters
- Optional spawnOpt: SpawnOptions
Returns Promise<string | void>
- Defined in node_modules/git-command-helper/dist/git.d.ts:196

isExist

isExist(): Bluebird<boolean>
Check if git folder exists

Returns

Returns Bluebird<boolean>
- Defined in node_modules/git-command-helper/dist/git.d.ts:201

isUpToDate

isUpToDate(): Bluebird<boolean>
Check if current repository is up to date with origin/remote

Returns

Returns Bluebird<boolean>
- Defined in node_modules/git-command-helper/dist/git.d.ts:186

pull

pull(arg?: string[], optionSpawn?: SpawnOptions): Promise<string>
git pull

Returns
Parameters
- Optional arg: string[]
  
  example: ['--recurse-submodule']
- Optional optionSpawn: SpawnOptions
Returns Promise<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:109

pullAcceptTheirs

pullAcceptTheirs(optionSpawn?: SpawnOptions): Promise<void>
git pull accept merge from remote (accept all incoming changes)

See
- https://stackoverflow.com/a/21777677
- https://www.folkstalk.com/tech/git-accept-incoming-changes-for-all-with-code-examples/
Parameters
- Optional optionSpawn: SpawnOptions
Returns Promise<void>
- Defined in node_modules/git-command-helper/dist/git.d.ts:115

push

push(force?: boolean, optionSpawn?: SpawnOptions): any
git push

Returns
Parameters
- Optional force: boolean
- Optional optionSpawn: SpawnOptions
Returns any
- Defined in node_modules/git-command-helper/dist/git.d.ts:148

reset

reset(branch?: string): Bluebird<string>
Reset to latest commit of remote branch
Parameters
- Optional branch: string
Returns Bluebird<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:243

setAutoRebase

setAutoRebase(): Bluebird<string>
setup merge on pull strategy

Returns

Returns Bluebird<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:89

setForceLF

setForceLF(): Bluebird<string>
setup end of line LF

Link
https://stackoverflow.com/a/13154031

Returns

Returns Bluebird<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:95

setbranch

setbranch(branchName: string, force?: boolean, spawnOpt?: SpawnOptions): Promise<string | void>
set branch (git checkout branchName)

Returns
Parameters
- branchName: string
- Optional force: boolean
- Optional spawnOpt: SpawnOptions
Returns Promise<string | void>
- Defined in node_modules/git-command-helper/dist/git.d.ts:238

setcwd

setcwd(v: string): void
Parameters
- v: string
Returns void
- Defined in node_modules/git-command-helper/dist/git.d.ts:202

setemail

setemail(v: string): Bluebird<string>
Parameters
- v: string
Returns Bluebird<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:203

setremote

setremote(v: string | URL, name?: string, spawnOpt?: SpawnOptions): Promise<any>
set remote url

Returns

Example
```
// default
git add remote origin https://
// custom name
git add remote customName https://
```
Parameters
- v: string | URL
- Optional name: string
  
  custom object name
- Optional spawnOpt: SpawnOptions
Returns Promise<any>
- Defined in node_modules/git-command-helper/dist/git.d.ts:216

setuser

setuser(v: string): Bluebird<string>
Parameters
- v: string
Returns Bluebird<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:204

spawn

spawn(cmd: string, args: string[], spawnOpt: SpawnOptions): Bluebird<string>
call spawn async

Returns
Parameters
- cmd: string
- args: string[]
- spawnOpt: SpawnOptions
Returns Bluebird<string>
- Defined in node_modules/git-command-helper/dist/git.d.ts:84

status

status(): Bluebird<StatusResult[]>
git status

Returns

Returns Bluebird<StatusResult[]>
- Defined in node_modules/git-command-helper/dist/git.d.ts:191

Class git

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dir: string

Returns git

Properties

branch

cwd

email

Private exist

getGithubBranches

Type declaration

Returns

Parameters

Optional opt: SpawnOptions

Returns Promise<void | { active: boolean; branch: string; }[]>

getGithubCurrentBranch

Type declaration

Returns

Parameters

Optional opt: SpawnOptions

Returns Promise<string | void>

getGithubRemote

Type declaration

Returns

Parameters

Optional name: null | string

Optional opt: SpawnOptions

Returns Promise<string | void>

getGithubRepoUrl

Type declaration

Parameters

path: string

Optional opt: SpawnOptions

Returns Promise<{ rawURL: string; remoteURL: string; }>

getGithubRootDir

Type declaration

Returns

Parameters

Optional opt: SpawnOptions

Returns Promise<string | void>

helper

infos

Type declaration

getGithubBranches: ((opt?: SpawnOptions) => Promise<void | { active: boolean; branch: string; }[]>)

Returns

Parameters

Optional opt: SpawnOptions

Returns Promise<void | { active: boolean; branch: string; }[]>

getGithubCurrentBranch: ((opt?: SpawnOptions) => Promise<string | void>)

Returns

Parameters

Optional opt: SpawnOptions

Returns Promise<string | void>

getGithubRemote: ((name?: null | string, opt?: SpawnOptions) => Promise<string | void>)

Returns

Parameters

Optional name: null | string

Optional opt: SpawnOptions

Returns Promise<string | void>

getGithubRepoUrl: ((path: string, opt?: SpawnOptions) => Promise<{ rawURL: string; remoteURL: string; }>)

Parameters

path: string

Optional opt: SpawnOptions

Returns Promise<{ rawURL: string; remoteURL: string; }>

getGithubRootDir: ((opt?: SpawnOptions) => Promise<string | void>)

Returns

Parameters

Optional opt: SpawnOptions

Returns Promise<string | void>

latestCommit

Type declaration

Parameters

Optional path: string

`Private` exist

`Optional` opt: SpawnOptions

Returns Promise<void | {
active: boolean;
branch: string;
}[]>

`Optional` opt: SpawnOptions

`Optional` name: null | string

`Optional` opt: SpawnOptions

`Optional` opt: SpawnOptions

Returns Promise<{
rawURL: string;
remoteURL: string;
}>

`Optional` opt: SpawnOptions

getGithubBranches: ((opt?: SpawnOptions) => Promise<void | {
active: boolean;
branch: string;
}[]>)

`Optional` opt: SpawnOptions

Returns Promise<void | {
active: boolean;
branch: string;
}[]>

`Optional` opt: SpawnOptions

`Optional` name: null | string

`Optional` opt: SpawnOptions

getGithubRepoUrl: ((path: string, opt?: SpawnOptions) => Promise<{
rawURL: string;
remoteURL: string;
}>)

`Optional` opt: SpawnOptions

Returns Promise<{
rawURL: string;
remoteURL: string;
}>

`Optional` opt: SpawnOptions

`Optional` path: string

`Optional` options: Partial<GetLatestCommitHashOptions>

`Private` spawnOpt

`Static` helper

`Static` noop

`Rest` ..._: any[]

`Static` shell

`Optional` opt: ShellOptions

`Optional` optionSpawn: SpawnOptions

`Optional` mode: string

`Optional` originName: string

`Optional` branchName: string

`Optional` optionSpawn: SpawnOptions

`Optional` mode: string

`Optional` optionSpawn: SpawnOptions

options: {
msg?: string;
path: string;
[key: string]: any;
}[]

`Optional` arg: string[]

`Optional` optionSpawn: SpawnOptions