fs
Kind: global typedef
Access: public
Since: 1.0.0
Properties
| Name | Type | Description |
|---|---|---|
| copy | function |
Copies folders and files from a source path to a target path asynchronously. |
| copySync | function |
Copies folders and files from a source path to a target path. |
| createFolderPath | function |
Creates nested folder apth if it doesn't exist. |
| getFolders | function |
Gets folders in a folder. |
| pathExists | function |
Checks if target path exists. |
| deleteFolderSync | function |
Removes a folder synchronously. |
| deleteFolder | function |
Removes a folder asynchronously. |
git
Kind: global typedef
Access: public
Since: 1.0.0
Properties
| Name | Type | Description |
|---|---|---|
| branch | function |
Creates a branch. |
| commit | function |
Git commits to current branch. |
| clean | function |
Cleans/Discards all changes to current branch. |
| clone | function |
Clones a repo. |
| checkout | function |
Checksout a branch and pulls latest. |
| deleteTag | function |
Deletes a tag remotely and locally. |
| getBranchName | function |
Gets the name of the current branch. |
| getDefaultBranch | function |
Gets the name of the default branch. |
| getIssue | function |
Gets issue from repo. |
| getIssues | function |
Gets issues from repo. |
| getLastCommit | function |
Gets the last commit. |
| getLastCommitHash | function |
Gets the last commit hash. |
| getLastCommitMsg | function |
Gets the last commit message. |
| getLastTag | function |
Gets the last tag. |
| getLastTags | function |
Gets the last tags. |
| getRepoName | function |
Gets the repository name. |
| getPullRequestUrl | function |
Gets an Url if there is a PR for current branch and the PS is open, otherwise null. |
| merge | function |
Merge base branch into current branch. |
| pullRequest | function |
Creates a PR. |
| pull | function |
Pulls latest. |
| push | function |
Push commits to given remote branch. |
| pushTags | function |
Push tags to given remote branch. |
| reset | function |
Discards all changes to current branch. |
| rebase | function |
Rebase current branch with base branch. |
| stash | function |
Stashes all changes of current branch. |
| isStatusClean | function |
Checks if status is clean. |
| tag | function |
Creates a pointer (tag) to current commmit. |
object
Kind: global typedef
Access: public
Since: 1.0.0
Properties
| Name | Type | Description |
|---|---|---|
| toString | function |
Converts objects to a string value. |
shell
Kind: global typedef
Access: public
Since: 1.0.0
Properties
| Name | Type | Description |
|---|---|---|
| cwd | function |
Gets current working directory name. |
| execAsync | function |
Execute shell commands asynchronously. |
| execSync | function |
Execute shell commands. |
| commandExists | function |
Checks if command exists in PATH. |
string
Kind: global typedef
Access: public
Since: 1.0.0
Properties
| Name | Type | Description |
|---|---|---|
| replace | function |
Replaces all entries of template with given data. |