Class git

GitHub Command Helper For NodeJS

Hierarchy

Constructors

constructor

new git(gitdir, branch?): git
Parameters
- gitdir: string
- branch: string = 'master'
Returns git
- Defined in src/git.ts:81

Properties

branch

branch: string

cwd

cwd: string

email

email: string

`Private` exist

exist: boolean

ext

ext: index-exports = extension

getGithubBranches

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

Type declaration

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

getGithubCurrentBranch

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

Type declaration

- (opt?): Promise<string | void>
- get current branch
  Parameters
  - opt: spawnAsync.SpawnOptions = {}
  Returns Promise<string | void>

getGithubRemote

getGithubRemote: ((name?, opt?) => Promise<string | void>) = GithubInfo.getGithubRemote

Type declaration

- (name?, opt?): Promise<string | void>
- get origin url
  - see https://stackoverflow.com/a/4090938
  Parameters
  - name: string = 'origin'
    
    remote name in config, default origin
  - opt: infoOptions = {}
  Returns Promise<string | void>

getGithubRootDir

getGithubRootDir: ((opt?) => Promise<string>) = GithubInfo.getGithubRootDir

Type declaration

- (opt?): Promise<string>
- get root directory of local repository
  - see https://stackoverflow.com/a/957978
  Parameters
  - opt: infoOptions = {}
  Returns Promise<string>

helper

helper: typeof default = helper

infos

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

exports infos

Type declaration

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

remote

remote: string

submodule

submodule: submodule

user

user: string

`Static` ext

ext: index-exports = extension

`Static` helper

helper: typeof default = helper

Methods

add

add(path, optionSpawn?): Bluebird<string>
git add
Parameters
- path: string
  
  specific path or argument -A
- optionSpawn: SpawnOptions = ...
Returns Bluebird<string>
- Defined in src/git.ts:362

addAndCommit

addAndCommit(path, msg, mode?): Bluebird<unknown>
add and commit file
Parameters
- path: string
- msg: string
- mode: string = 'm'
  
  am/m
Returns Bluebird<unknown>
- Defined in src/git.ts:235

addSafe

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

Returns Promise<string | void>
- Defined in src/git.ts:115

canPush

canPush(): Promise<boolean>
check if can be pushed

Returns Promise<boolean>
- Defined in src/git.ts:300

checkLock

checkLock(): boolean
Returns boolean
- Defined in src/git.ts:593

checkout

checkout(branchName, optionSpawn?): Promise<string>
git checkout
Parameters
- branchName: string
- optionSpawn: SpawnOptions = ...
Returns Promise<string>
- Defined in src/git.ts:372

commit

commit(msg, mode?, optionSpawn?): Bluebird<string>
git commit
Parameters
- msg: string
  
  commit messages
- mode: string = 'm'
  
  am, -m, etc
- optionSpawn: SpawnOptions = ...
Returns Bluebird<string>
- Defined in src/git.ts:212

commits

commits(options): Bluebird<Error[]>
bulk add and commit
Parameters
- options: {
      msg?: string;
      path: string;
      [key: string]: any;
  }[]
  
  array of path and msg commit message
Returns Bluebird<Error[]>
- Defined in src/git.ts:248

fetch

fetch(arg?, optionSpawn?): Bluebird<string>
git fetch
Parameters
- Optional arg: string[]
  
  argument git-fetch, ex ['--all']
- optionSpawn: SpawnOptions = ...
Returns Bluebird<string>
- Defined in src/git.ts:159

getGithubRepoUrl

getGithubRepoUrl(file): Promise<{
rawURL: string;
remoteURL: string;
}>
get repository and raw file url
Parameters
- file: string
  
  relative to git root without leading /
Returns Promise<{
rawURL: string;
remoteURL: string;
}>
- Defined in src/git.ts:63

getbranch

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

Returns Promise<{
active: boolean;
branch: string;
}[]>
- Defined in src/git.ts:380

getremote

getremote(args): Promise<string>
get remote information. default origin
Parameters
- args: string
Returns Promise<string>
remote url
- Defined in src/git.ts:525
getremote(args?): Promise<{
    fetch: {
        origin: string;
        url: string;
    };
    push: {
        origin: string;
        url: string;
    };
}>
get remote origin information
Parameters
- Optional args: string[]
Returns Promise<{
    fetch: {
        origin: string;
        url: string;
    };
    push: {
        origin: string;
        url: string;
    };
}>
object remote
- Defined in src/git.ts:531

hasChanged

hasChanged(): Promise<boolean>
check has any file changed

Returns Promise<boolean>
- Defined in src/git.ts:339

info

info(): Promise<{
    branch: {
        active: boolean;
        branch: string;
    }[];
    remote: {
        fetch: {
            origin: string;
            url: string;
        };
        push: {
            origin: string;
            url: string;
        };
    };
    root: string;
    status: StatusResult[];
}>
Returns Promise<{
    branch: {
        active: boolean;
        branch: string;
    }[];
    remote: {
        fetch: {
            origin: string;
            url: string;
        };
        push: {
            origin: string;
            url: string;
        };
    };
    root: string;
    status: StatusResult[];
}>
- Defined in src/git.ts:102

init

init(spawnOpt?): Promise<string | void>
git init
Parameters
- spawnOpt: SpawnOptions = ...
Returns Promise<string | void>
- Defined in src/git.ts:463

isExist

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

Returns Bluebird<boolean>
- Defined in src/git.ts:472

isIgnored

isIgnored(filePath, options?): Promise<boolean | Return>
is file ignored by .gitignore?
Parameters
- filePath: string
- Optional options: isIgnoredOpt
Returns Promise<boolean | Return>
- Defined in src/git.ts:350

isUntracked

isUntracked(file): Promise<boolean>
check file is untracked
Parameters
- file: string
  
  relative to git root without leading /
Returns Promise<boolean>
- Defined in src/git.ts:72

isUpToDate

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

Returns Bluebird<boolean>
- Defined in src/git.ts:400

latestCommit

latestCommit(customPath?, options?): Promise<string>
get latest commit hash
Parameters
- Optional customPath: string
- Optional options: Partial<GetLatestCommitHashOptions>
Returns Promise<string>
- Defined in src/git.ts:98

pull

pull(arg?, optionSpawn?): Promise<string>
git pull
Parameters
- Optional arg: string[]
  
  example: ['--recurse-submodule']
- optionSpawn: SpawnOptions = ...
Returns Promise<string>
- Defined in src/git.ts:178

pullAcceptTheirs

pullAcceptTheirs(optionSpawn?): 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
- optionSpawn: SpawnOptions = ...
Returns Promise<void>
- Defined in src/git.ts:200

push

push(force?, optionSpawn?): any
git push
Parameters
- force: boolean = false
- optionSpawn: SpawnOptions = ...
Returns any
- Defined in src/git.ts:276

reset

reset(branch?): Bluebird<string>
Reset to latest commit of remote branch
Parameters
- branch: string = ...
Returns Bluebird<string>
- Defined in src/git.ts:624

setAutoRebase

setAutoRebase(): Promise<{
    err: string;
    output: string;
    stderr: string;
    stdout: string;
}>
setup merge on pull strategy

Returns Promise<{
    err: string;
    output: string;
    stderr: string;
    stdout: string;
}>
- Defined in src/git.ts:140

setForceLF

setForceLF(): Promise<{
    err: string;
    output: string;
    stderr: string;
    stdout: string;
}>
setup end of line LF

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

Returns Promise<{
    err: string;
    output: string;
    stderr: string;
    stdout: string;
}>
- Defined in src/git.ts:149

setbranch

setbranch(branchName, force?, spawnOpt?): Promise<string | void>
set branch (git checkout branchName)
Parameters
- branchName: string
- force: boolean = false
- Optional spawnOpt: SpawnOptions
Returns Promise<string | void>
- Defined in src/git.ts:602

setcwd

setcwd(v): void
Parameters
- v: string
Returns void
- Defined in src/git.ts:485

setemail

setemail(v): Bluebird<string>
Parameters
- v: string
Returns Bluebird<string>
- Defined in src/git.ts:489

setremote

setremote(remoteURL, name?, spawnOpt?): Promise<any>
set remote url

Example
```
// default
git add remote origin https://
// custom name
git add remote customName https://
```
Parameters
- remoteURL: string | URL
  
  repository url
- Optional name: string
  
  custom object name
- spawnOpt: SpawnOptions = {}
Returns Promise<any>
- Defined in src/git.ts:510

setuser

setuser(v): Bluebird<string>
Parameters
- v: string
Returns Bluebird<string>
- Defined in src/git.ts:494

spawn

spawn(cmd, args, spawnOpt): Bluebird<string>
call spawn async
Parameters
- cmd: string
- args: string[]
- spawnOpt: SpawnOptions
Returns Bluebird<string>
- Defined in src/git.ts:132

spawnOpt

spawnOpt<T>(opt?): Record<string, any> & CommonSpawnOptions & T
Spawn option default stdio pipe
Type Parameters
- T
Parameters
- opt: SpawnOptions = {}
Returns Record<string, any> & CommonSpawnOptions & T
- Defined in src/git.ts:332

status

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

Returns Bluebird<StatusResult[]>
- Defined in src/git.ts:413

Class git

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

gitdir: string

branch: string = 'master'

Returns git

Properties

branch

cwd

email

Private exist

ext

getGithubBranches

Type declaration

Parameters

opt: spawnAsync.SpawnOptions = {}

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

getGithubCurrentBranch

Type declaration

Parameters

opt: spawnAsync.SpawnOptions = {}

Returns Promise<string | void>

getGithubRemote

Type declaration

Parameters

name: string = 'origin'

opt: infoOptions = {}

Returns Promise<string | void>

getGithubRootDir

Type declaration

Parameters

opt: infoOptions = {}

Returns Promise<string>

helper

infos

Type declaration

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

Parameters

opt: spawnAsync.SpawnOptions = {}

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

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

Parameters

opt: spawnAsync.SpawnOptions = {}

Returns Promise<string | void>

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

Parameters

name: string = 'origin'

opt: infoOptions = {}

Returns Promise<string | void>

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

Parameters

path: string

opt: infoOptions = ...

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

getGithubRootDir: ((opt?) => Promise<string>)

Parameters

opt: infoOptions = {}

Returns Promise<string>

getIgnores: ((param0) => Promise<string[]>)

Parameters

param0: Object

Returns Promise<string[]>

remote

submodule

user

Static ext

Static helper

Methods

add

Parameters

path: string

optionSpawn: SpawnOptions = ...

Returns Bluebird<string>

addAndCommit

`Private` exist

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

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

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

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

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

`Static` ext

`Static` helper

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

`Optional` arg: string[]

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

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

`Optional` args: string[]

Returns Promise<{
fetch: {
origin: string;
url: string;
};
push: {
origin: string;
url: string;
};
}>

Returns Promise<{
branch: {
active: boolean;
branch: string;
}[];
remote: {
fetch: {
origin: string;
url: string;
};
push: {
origin: string;
url: string;
};
};
root: string;
status: StatusResult[];
}>

`Optional` options: isIgnoredOpt

`Optional` customPath: string

`Optional` options: Partial<GetLatestCommitHashOptions>