Node.js-git-js一个轻量级接口用于在任何node.js应用程序中运行git命令

# Simple Git [](https://www.npmjs.com/package/simple-git) [](https://travis-ci.org/steveukx/git-js) A light weight interface for running git commands in any [node.js](http://nodejs.org) application. # Installation Easiest through [npm](http://npmjs.org): `npm install simple-git` # Dependencies Requires [git](http://git-scm.com/downloads) to be installed and that it can be called using the command `git`. # Usage Include into your app using: ```js const simpleGit = require('simple-git')(workingDirPath); ``` > where the `workingDirPath` is optional, defaulting to the current directory. Use `simpleGit` by chaining any of its functions together. Each function accepts an optional final argument which will be called when that step has been completed. When it is called it has two arguments - firstly an error object (or null when no error occurred) and secondly the data generated by that call. | API | What it does | |-----|--------------| | `.add([fileA, ...], handlerFn)` | adds one or more files to be under source control | | `.addAnnotatedTag(tagName, tagMessage, handlerFn)` | adds an annotated tag to the head of the current branch | | `.addConfig(key, value[, handlerFn])` | add a local configuration property | | `.addRemote(name, repo, handlerFn)` | adds a new named remote to be tracked as `name` at the path `repo` | | `.addTag(name, handlerFn)` | adds a lightweight tag to the head of the current branch | | `.branch([options, ][handlerFn])` | gets a list of all branches, calls `handlerFn` with two arguments, an error object and [BranchSummary](src/responses/BranchSummary.js) instance. When supplied, the options can be either an array of arguments supported by the [branch](https://git-scm.com/docs/git-branch) command or a standard [options](#how-to-specify-options) object. | | `.branchLocal([handlerFn])` | gets a list of local branches, calls `handlerFn` with two arguments, an error object and [BranchSummary](src/responses/BranchSummary.js) instance | | `.catFile(options[, handlerFn])` | generate `cat-file` detail, `options` should be an array of strings as supported arguments to the [cat-file](https://git-scm.com/docs/git-cat-file) command | | `.checkIgnore([filepath, ...], handlerFn)` | checks if filepath excluded by .gitignore rules | | `.checkIsRepo(handlerFn)` | Determines whether the current working directory is part of a git repository, the handler will be called with standard error object and a boolean response. | | `.checkout(checkoutWhat, handlerFn)` | checks out the supplied tag, revision or branch. `checkoutWhat` can be one or more strings to be used as parameters appended to the `git checkout` command. | | `.checkoutBranch(branchName, startPoint, handlerFn)` | checks out a new branch from the supplied start point | | `.checkoutLatestTag(handlerFn)` | convenience method to pull then checkout the latest tag | | `.checkoutLocalBranch(branchName, handlerFn)` | checks out a new local branch | | `.clean(mode [, options [, handlerFn]])` | clean the working tree. Mode should be "n" - dry run or "f" - force | | `.clearQueue()` | immediately clears the queue of pending tasks (note: any command currently in progress will still call its completion callback) | | `.clone(repoPath, [localPath, [options]], [handlerFn])` | clone a remote repo at `repoPath` to a local directory at `localPath` (can be omitted to use the default of a directory with the same name as the repo name) with an optional array of additional arguments to include between `git clone` and the trailing `repo local` arguments | | `.commit(message, handlerFn)` | commits changes in the current working directory with the supplied message where the message can be either a single string or array of strings to be passed as separate arguments (the `git` command line interface converts these to be separated by double line breaks) | | `.commit(message, [fileA, ...], options, handlerFn)` | commits changes on the named files with the supplied message, when supplied, the optional options object can contain any other parameters to pass to the commit command, setting the value of the property to be a string will add `name=value` to the command string, setting any other type of value will result in just the key from the object being passed (ie: just `name`), an example of setting the author is below | | `.customBinary(gitPath)` | sets the command to use to reference git, allows for using a git binary not available on the path environment variable | | `.cwd(workingDirectory)` | Sets the current working directory for all commands after this step in the chain | | `.deleteLocalBranch(branchName, handlerFn)` | deletes a local branch | | `.diff(options, handlerFn)` | get the diff of the current repo compared to the last commit with a set of options supplied as a string | | `.diff(handlerFn)` | get the diff for all file in the current repo compared to the last commit | | `.diffSummary(handlerFn)` | gets a summary of the diff for files in the repo, uses the `git diff --stat` format to calculate changes. Handler is called with a nullable error object and an instance of the [DiffSummary](src/responses/DiffSummary.js) | | `.diffSummary(options, handlerFn)` | includes options in the call to `diff --stat options` and returns a [DiffSummary](src/responses/DiffSummary.js) | | `.env(name, value)` | Set environment variables to be passed to the spawned child processes, [see usage in detail below](#environment-variables). | | `.exec(handlerFn)` | calls a simple function in the current step | | `.fetch([options, ] handlerFn)` | update the local working copy database with changes from the default remote repo and branch, when supplied the options argument can be a standard [options object](#how-to-specify-options) either an array of string commands as supported by the [git fetch](https://git-scm.com/docs/git-fetch). On success, the returned data will be an instance of the [FetchSummary](src/responses/FetchSummary.js) | | `.fetch(remote, branch, handlerFn)` | update the local working copy database with changes from a remote repo | | `.fetch(handlerFn)` | update the local working copy database with changes from the default remote repo and branch | | `.getRemotes([verbose], handlerFn)` | gets a list of the named remotes, when the verbose option is supplied as true, includes the URLs and purpose of each ref | | `.init(bare, handlerFn)` | initialize a repository, optional `bare` parameter makes intialized repository bare | | `.listRemote([args], handlerFn)` | lists remote repositories - there are so many optional arguments in the underlying `git ls-remote` call, just supply any you want to use as the optional `args` array of strings eg: `git.listRemote(['--heads', '--tags'], console.log.bind(console))` | | `.log([options], handlerFn)` | list commits between `options.from` and `options.to` tags or branch (if not specified will show all history). Additionally you can provide `options.file`, which is the path to a file in your repository. Then only this file will be considered. `options.symmetric` allows you to specify whether you want to use [symmetric revision range](https://git-scm.com/docs/gitrevisions#_dotted_range_notations) (To be compatible, by default, its value is true). For any other set of options, supply `options` as an array of strings to be appended to the `git log` command. To use a custom splitter in the log format, set `options.splitter` to be the string the log should be split on. Set `options.multiLine` to true to include a multi-line body in the output format. Options can also be supplied as a standard [options](#how-to-specify-options) object for adding custom properties supported by the [git log](https://git-scm.com/docs/git-log) command. | | `.mergeFromTo(from, to, [[options,] handlerFn])` | merge from one branch to another, when supplied the options should be an array o