simple-git
Advanced tools
simple-git - npm Package Compare versions
Comparing version 3.17.0 to 3.18.0
@@ -902,2 +902,4 @@ import * as resp from './response'; | ||
| showBuffer(option: string | types.TaskOptions): Response<Buffer>; | ||
| /** | ||
@@ -904,0 +906,0 @@ * @deprecated |
| { | ||
| "name": "simple-git", | ||
| "description": "Simple GIT interface for node.js", | ||
| "version": "3.17.0", | ||
| "version": "3.18.0", | ||
| "author": "Steve King <steve@mydev.co>", | ||
@@ -6,0 +6,0 @@ "contributors": [ |
@@ -189,7 +189,7 @@ # Simple Git | ||
| | 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 | | ||
| | `.addTag(name, handlerFn)` | adds a lightweight tag to the head of the current branch | | ||
| | `.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 | | ||
| | `.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 | | ||
@@ -205,6 +205,6 @@ | `.clearQueue()` | immediately clears the queue of pending tasks (note: any command currently in progress will still call its completion callback) | | ||
| | `.fetch(handlerFn)` | update the local working copy database with changes from the default remote repo and branch | | ||
| | `.outputHandler(handlerFn)` | attaches a handler that will be called with the name of the command being run and the `stdout` and `stderr` [readable streams](https://nodejs.org/api/stream.html#stream_class_stream_readable) created by the [child process](https://nodejs.org/api/child_process.html#child_process_class_childprocess) running that command | | ||
| | `.raw(args[, handlerFn])` | Execute any arbitrary array of commands supported by the underlying git binary. When the git process returns a non-zero signal on exit and it printed something to `stderr`, the command will be treated as an error, otherwise treated as a success. | | ||
| | `.outputHandler(handlerFn)` | attaches a handler that will be called with the name of the command being run and the `stdout` and `stderr` [readable streams](https://nodejs.org/api/stream.html#stream_class_stream_readable) created by the [child process](https://nodejs.org/api/child_process.html#child_process_class_childprocess) running that command, see [examples](https://github.com/steveukx/git-js/blob/main/examples/git-output-handler.md) | | ||
| | `.raw(args, [handlerFn])` | Execute any arbitrary array of commands supported by the underlying git binary. When the git process returns a non-zero signal on exit and it printed something to `stderr`, the command will be treated as an error, otherwise treated as a success. | | ||
| | `.rebase([options,] handlerFn)` | Rebases the repo, `options` should be supplied as an array of string parameters supported by the [git rebase](https://git-scm.com/docs/git-rebase) command, or an object of options (see details below for option formats). | | ||
| | `.revert(commit [, options [, handlerFn]])` | reverts one or more commits in the working copy. The commit can be any regular commit-ish value (hash, name or offset such as `HEAD~2`) or a range of commits (eg: `master~5..master~2`). When supplied the [options](#how-to-specify-options) argument contain any options accepted by [git-revert](https://git-scm.com/docs/git-revert). | | ||
| | `.revert(commit , [options , [handlerFn]])` | reverts one or more commits in the working copy. The commit can be any regular commit-ish value (hash, name or offset such as `HEAD~2`) or a range of commits (eg: `master~5..master~2`). When supplied the [options](#how-to-specify-options) argument contain any options accepted by [git-revert](https://git-scm.com/docs/git-revert). | | ||
| | `.rm([fileA, ...], handlerFn)` | removes any number of files from source control | | ||
@@ -214,3 +214,2 @@ | `.rmKeepLocal([fileA, ...], handlerFn)` | removes files from source control but leaves them on disk | | ||
| | `.tags([options, ] handlerFn)` | list all tags, use the optional [options](#how-to-specify-options) object to set any options allows by the [git tag](https://git-scm.com/docs/git-tag) command. Tags will be sorted by semantic version number by default, for git versions 2.7 and above, use the `--sort` option to set a custom sort. | | ||
| | `.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 | | ||
@@ -238,3 +237,3 @@ ## git apply | ||
| - `.checkout(checkoutWhat [, options])` - checks out the supplied tag, revision or branch when supplied as a string, | ||
| - `.checkout(checkoutWhat , [options])` - checks out the supplied tag, revision or branch when supplied as a string, | ||
| additional arguments supported by [git checkout](https://git-scm.com/docs/git-checkout) can be supplied as an | ||
@@ -293,3 +292,3 @@ [options](#how-to-specify-options) object/array. | ||
| - `.init(bare [, options])` initialize a repository using the boolean `bare` parameter to intialise a bare repository. | ||
| - `.init(bare , [options])` initialize a repository using the boolean `bare` parameter to intialise a bare repository. | ||
| Any number of other arguments supported by [git init](https://git-scm.com/docs/git-init) can be supplied as an | ||
@@ -329,3 +328,3 @@ [options](#how-to-specify-options) object/array. | ||
| - `.mergeFromTo(remote, branch [, options])` - merge from the specified branch into the currently checked out branch, | ||
| - `.mergeFromTo(remote, branch , [options])` - merge from the specified branch into the currently checked out branch, | ||
| similar to `.merge` but with the `remote` and `branch` supplied as strings separately to any additional | ||
@@ -345,3 +344,3 @@ [options](#how-to-specify-options). | ||
| - `.pull(remote, branch[, options])` pulls all updates from the specified remote branch (eg 'origin'/'master') along | ||
| - `.pull(remote, branch, [options])` pulls all updates from the specified remote branch (eg 'origin'/'master') along | ||
| with any custom [options](#how-to-specify-options) object/array | ||
@@ -355,6 +354,6 @@ | ||
| - `.push(remote, branch[, options])` pushes to a named remote/branch, supports additional | ||
| - `.push(remote, branch, [options])` pushes to a named remote/branch, supports additional | ||
| [options](#how-to-specify-options) from the [git push](https://git-scm.com/docs/git-push) command. | ||
| - `.pushTags(remote[, options])` pushes local tags to a named remote (equivalent to using `.push([remote, '--tags'])`) | ||
| - `.pushTags(remote, [options])` pushes local tags to a named remote (equivalent to using `.push([remote, '--tags'])`) | ||
@@ -387,2 +386,7 @@ ## git remote | ||
| ## git show | ||
| - `.show(options)` show various types of objects for example the file content at a certain commit. `options` is the single value string or any [options](#how-to-specify-options) supported by the [git show](https://git-scm.com/docs/git-show) command. | ||
| - `.showBuffer(options)` same as the `.show` api, but returns the Buffer content directly to allow for showing binary file content. | ||
| ## git status | ||
@@ -389,0 +393,0 @@ |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
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.35%
868914
- Number of package files
- increased by0.95%
106
- Lines of code
- increased by0.41%
10573
- Number of lines in readme file
- increased by0.48%
830