Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
simple-git
Advanced tools
simple-git - npm Package Compare versions
Comparing version 1.35.0 to 1.36.0
| { | ||
| "name": "simple-git", | ||
| "description": "Simple GIT interface for node.js", | ||
| "version": "1.35.0", | ||
| "version": "1.36.0", | ||
| "author": "Steve King <steve@mydev.co>", | ||
@@ -6,0 +6,0 @@ "contributors": [ |
154
readme.md
@@ -20,3 +20,3 @@ # Simple Git | ||
| where the `workingDirPath` is optional, defaulting to the current directory. | ||
| > where the `workingDirPath` is optional, defaulting to the current directory. | ||
@@ -27,106 +27,47 @@ Use `simpleGit` by chaining any of its functions together. Each function accepts an optional final argument which will | ||
| `.addConfig(key, value[, handlerFn])` add a local configuration property | ||
| |API | What it does | | ||
| |---------------------|---------------| | ||
| | `.addConfig(key, value[, handlerFn])` | add a local configuration property | | ||
| |`.init(bare, handlerFn)`| initialize a repository, optional `bare` parameter makes intialized repository bare | | ||
| |`.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 | | ||
| |`.clone(repoPath, localPath, handlerFn)`| clone a remote repo at `repoPath` to a local directory at `localPath` | | ||
| |`.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/DiffSummary.js) | | ||
| |`.pull(remote, branch, handlerFn)`| pull all updates from the repo ('origin'/'master') | | ||
| |`.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 | | ||
| |`.tags(handlerFn)`| list all tags | | ||
| |`.addTag(name, handlerFn)`| adds a lightweight tag to the head of the current branch | | ||
| |`.addAnnotatedTag(tagName, tagMessage, handlerFn)`| adds an annotated tag to the head of the current branch | | ||
| |`.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. 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 | | ||
| |`.checkout(checkoutWhat, handlerFn)`| checks out the supplied tag, revision or branch | | ||
| |`.checkoutBranch(branchName, startPoint, handlerFn)`| checks out a new branch from the supplied start point | | ||
| |`.checkoutLocalBranch(branchName, handlerFn)`| checks out a new local branch | | ||
| |`.checkoutLatestTag(handlerFn)`| convenience method to pull then checkout the latest tag | | ||
| |`.add([fileA, ...], handlerFn)`| adds one or more files to be under source control | | ||
| |`.branch([handlerFn])`| gets a list of all branches, calls `handlerFn` with two arguments, an error object and [BranchSummary](src/BranchSummary.js) instance | | ||
| |`.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 | | ||
| |`.mergeFromTo(from, to, [[options,] handlerFn])`| merge from one branch to another, when supplied the options should be an array of additional parameters to pass into the `git merge` command | | ||
| |`.push(remote, branch, handlerFn)`| pushes to a named remote and named branch | | ||
| |`.pushTags(remote, handlerFn)`| pushes tags to a named remote | | ||
| |`.silent(isSilent)`| sets whether the console should be used for logging errors (defaults to `true` when the `NODE_ENV` contains the string `prod`) | | ||
| |`.submoduleAdd(repo, path[, handlerFn])`| adds a new sub module | | ||
| |`.submoduleUpdate([args, ][handlerFn])`| updates sub modules, args should be an array of string arguments to pass to the `git submodule update` command | | ||
| |`.rm([fileA, ...], handlerFn)`| removes any number of files from source control | | ||
| |`.rmKeepLocal([fileA, ...], handlerFn)`| removes files from source control but leaves them on disk | | ||
| |`.addRemote(name, repo, handlerFn)`| adds a new named remote to be tracked as `name` at the path `repo` | | ||
| |`.removeRemote(name, handlerFn)`| removes the named remote | | ||
| |`.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 | | ||
| |`.reset([resetMode,] handlerFn)`| resets the repository, the optional first argument can either be an array of options supported by the `git reset` command or one of the string constants `hard` or `soft`, if omitted the reset will be a soft reset to head, handlerFn: (err) | | ||
| |`.revparse([options], handlerFn)`| wraps git rev-parse. Primarily used to convert friendly commit references (ie branch names) to SHA1 hashes. Options should be an array of string options compatible with the [git rev-parse](http://git-scm.com/docs/git-rev-parse) | | ||
| |`.status(handlerFn)`| gets the status of the current repo | | ||
| |`.show([options], handlerFn)`| Show various types of objects, for example the file content at a certain commit. `options` is the single value string or array of string commands you want to run | | ||
| |`.checkIgnore([filepath, ...], handlerFn)`| checks if filepath excluded by .gitignore rules | | ||
| |`.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))` | | ||
| |`outputHandler(handlerFn)`| attaches a handler that will be called with the name of the command being run and the `stdout` and `stderr` [readable streams](http://nodejs.org/api/stream.html#stream_class_stream_readable) created by the [child process](http://nodejs.org/api/child_process.html#child_process_class_childprocess) running that command | | ||
| |`.then(handlerFn)`| calls a simple function in the current step | | ||
| `.init(bare, handlerFn)` initialize a repository, optional `bare` parameter makes intialized repository bare. | ||
| `.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. | ||
| `.clone(repoPath, localPath, handlerFn)` clone a remote repo at `repoPath` to a local directory at `localPath` | ||
| `.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/DiffSummary.js) | ||
| `.pull(remote, branch, handlerFn)` pull all updates from the repo ('origin'/'master') | ||
| `.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 | ||
| `.tags(handlerFn)` list all tags | ||
| `.addTag(name, handlerFn)` adds a lightweight tag to the head of the current branch | ||
| `.addAnnotatedTag(tagName, tagMessage, handlerFn)` adds an annotated tag to the head of the current branch | ||
| `.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. 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. | ||
| `.checkout(checkoutWhat, handlerFn)` checks out the supplied tag, revision or branch | ||
| `.checkoutBranch(branchName, startPoint, handlerFn)` checks out a new branch from the supplied start point | ||
| `.checkoutLocalBranch(branchName, handlerFn)` checks out a new local branch | ||
| `.checkoutLatestTag(handlerFn)` convenience method to pull then checkout the latest tag | ||
| `.add([fileA, ...], handlerFn)` adds one or more files to be under source control | ||
| `.branch([handlerFn])` gets a list of all branches, calls `handlerFn` with two arguments, an error object | ||
| and [BranchSummary](src/BranchSummary.js) instance. | ||
| `.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 | ||
| `.mergeFromTo(from, to, [[options,] handlerFn])` merge from one branch to another, when supplied the options should be | ||
| an array of additional parameters to pass into the `git merge` command. | ||
| `.push(remote, branch, handlerFn)` pushes to a named remote and named branch | ||
| `.pushTags(remote, handlerFn)` pushes tags to a named remote | ||
| `.silent(isSilent)` sets whether the console should be used for logging errors (defaults to `true` when the `NODE_ENV` contains the string `prod`) | ||
| `.submoduleAdd(repo, path[, handlerFn])` adds a new sub module | ||
| `.submoduleUpdate([args, ][handlerFn])` updates sub modules, args should be an array of string arguments to pass to the `git submodule update` command. | ||
| `.rm([fileA, ...], handlerFn)` removes any number of files from source control | ||
| `.rmKeepLocal([fileA, ...], handlerFn)` removes files from source control but leaves them on disk | ||
| `.addRemote(name, repo, handlerFn)` adds a new named remote to be tracked as `name` at the path `repo` | ||
| `.removeRemote(name, handlerFn)` removes the named remote | ||
| `.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. | ||
| `.reset([resetMode,] handlerFn)` resets the repository, the optional first argument can either be an array of options | ||
| supported by the `git reset` command or one of the string constants `hard` or `soft`, if omitted the reset will be | ||
| a soft reset to head, handlerFn: (err)) | ||
| `.revparse([options], handlerFn)` wraps git rev-parse. Primarily used to convert friendly commit references (ie branch names) to SHA1 hashes. Options should be an array of string options compatible with the [git rev-parse](http://git-scm.com/docs/git-rev-parse) | ||
| `.status(handlerFn)` gets the status of the current repo | ||
| `.show([options], handlerFn)` Show various types of objects, for example the file content at a certain commit. `options` | ||
| is the single value string or array of string commands you want to run. | ||
| `.checkIgnore([filepath, ...], handlerFn)` checks if filepath excluded by .gitignore rules | ||
| `.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))`. | ||
| `outputHandler(handlerFn)` attaches a handler that will be called with the name of the command being run and the | ||
| `stdout` and `stderr` [readable streams](http://nodejs.org/api/stream.html#stream_class_stream_readable) created by | ||
| the [child process](http://nodejs.org/api/child_process.html#child_process_class_childprocess) running that command. | ||
| `.then(handlerFn)` calls a simple function in the current step | ||
| # Release History | ||
@@ -145,3 +86,3 @@ | ||
| # Examples | ||
| ```js | ||
| // update repo and get a list of tags | ||
@@ -154,3 +95,2 @@ require('simple-git')(__dirname + '/some-repo') | ||
| // update repo and when there are changes, restart the app | ||
@@ -181,3 +121,2 @@ require('simple-git')() | ||
| // piping to the console for long running tasks | ||
@@ -220,1 +159,2 @@ require('simple-git')() | ||
| .commit('committed as "Another Person"', 'file-two', { '--author': '"Another Person <another@person.com>"' }) | ||
| ``` |
@@ -56,3 +56,3 @@ | ||
| var behindReg = /behind (\d+)/; | ||
| var currentReg = /^([^\s\.]*)\.*/; | ||
| var currentReg = /^(.+?(?=(?:\.{3}|\s|$)))/; | ||
| var trackingReg = /\.{3}(\S*)/; | ||
@@ -59,0 +59,0 @@ var regexResult; |
@@ -945,2 +945,14 @@ | ||
| statusSummary = StatusSummary.parse('## release/0.34.0...origin/release/0.34.0'); | ||
| test.equals(statusSummary.current, 'release/0.34.0'); | ||
| test.equals(statusSummary.tracking, 'origin/release/0.34.0'); | ||
| test.equals(statusSummary.ahead, 0); | ||
| test.equals(statusSummary.behind, 0); | ||
| statusSummary = StatusSummary.parse('## HEAD (no branch)'); | ||
| test.equals(statusSummary.current, 'HEAD'); | ||
| test.equals(statusSummary.tracking, null); | ||
| test.equals(statusSummary.ahead, 0); | ||
| test.equals(statusSummary.behind, 0); | ||
| statusSummary = StatusSummary.parse('?? Not tracked File\nUU Conflicted\n D Removed'); | ||
@@ -947,0 +959,0 @@ test.same(statusSummary.not_added, ['Not tracked File']); |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.86%
89600
- Lines of code
- increased by0.48%
2106
Worsened metrics
- Number of lines in readme file
- decreased by-27.91%
155
No dependency changes