simple-git
Advanced tools
Comparing version 2.48.0 to 3.0.1
525
CHANGELOG.md
@@ -1,529 +0,28 @@ | ||
# Change History & Release Notes | ||
# Changelog | ||
## [2.48.0](https://www.github.com/steveukx/git-js/compare/v2.47.1...v2.48.0) (2021-12-01) | ||
### [3.0.1](https://www.github.com/steveukx/git-js/compare/repo-v3.0.0...repo-v3.0.1) (2022-01-18) | ||
### Features | ||
* `StatusResult` returned by `git.status()` should include `detached` state of the working copy. ([#695](https://www.github.com/steveukx/git-js/issues/695)) ([f464ebe](https://www.github.com/steveukx/git-js/commit/f464ebe567c6c5cd4e99fd7e6300d9efdd4cbb1b)) | ||
### Bug Fixes | ||
* Add example for empty commit message in `git.commit()` ([61089cb](https://www.github.com/steveukx/git-js/commit/61089cbcb791acf9dc596dcc903e7b9c6c76c0e1)) | ||
* Documentation update ([4e000f6](https://www.github.com/steveukx/git-js/commit/4e000f69aa876b3999ec98fe42e94186facd5790)) | ||
* Enable releasing v3 to `npm` under `canary` tag ([14e233f](https://www.github.com/steveukx/git-js/commit/14e233f976eab8c99398dbc2c9744b6654add126)) | ||
### [2.47.1](https://www.github.com/steveukx/git-js/compare/v2.47.0...v2.47.1) (2021-11-29) | ||
## [3.0.0](https://www.github.com/steveukx/git-js/compare/repo-v2.48.0...repo-v3.0.0) (2022-01-16) | ||
### Bug Fixes | ||
### ⚠ BREAKING CHANGES | ||
* Add support for node@17 in unit tests ([0d3bf47](https://www.github.com/steveukx/git-js/commit/0d3bf479dd52e68e3af502685568c8e376ba2af3)) | ||
* Add support for node@17 in unit tests ([0d3bf47](https://www.github.com/steveukx/git-js/commit/0d3bf479dd52e68e3af502685568c8e376ba2af3)) | ||
* monorepo structure (#716) | ||
## [2.47.0](https://www.github.com/steveukx/git-js/compare/v2.46.0...v2.47.0) (2021-10-19) | ||
### Features | ||
* git-grep ([653065e](https://www.github.com/steveukx/git-js/commit/653065ebb19bb6718466fc00d9c77047b83aca5d)) | ||
* monorepo structure ([#716](https://www.github.com/steveukx/git-js/issues/716)) ([777a02a](https://www.github.com/steveukx/git-js/commit/777a02a37b3f6345fad86e7ab0105414755c940a)) | ||
* Support loading with ES modules ([c761863](https://www.github.com/steveukx/git-js/commit/c761863166f870e25af171e7aa8d27df869cad03)) | ||
## [2.46.0](https://www.github.com/steveukx/git-js/compare/v2.45.1...v2.46.0) (2021-09-29) | ||
### Features | ||
* `completion` plugin ([#684](https://www.github.com/steveukx/git-js/issues/684)) ([ecb7bd6](https://www.github.com/steveukx/git-js/commit/ecb7bd6688b5e6d970cf64ac36ebb4c2bf7f081a)) | ||
* `completion` plugin to allow configuring when `simple-git` determines the `git` tasks to be complete. ([ecb7bd6](https://www.github.com/steveukx/git-js/commit/ecb7bd6688b5e6d970cf64ac36ebb4c2bf7f081a)) | ||
### [2.45.1](https://www.github.com/steveukx/git-js/compare/v2.45.0...v2.45.1) (2021-09-04) | ||
### Bug Fixes | ||
* support progress events in locales other than western european character sets. ([8cc42f8](https://www.github.com/steveukx/git-js/commit/8cc42f83b5cb99de5b2960bf0cada2a259d09d57)) | ||
## [2.45.0](https://www.github.com/steveukx/git-js/compare/v2.44.0...v2.45.0) (2021-08-27) | ||
### Features | ||
* Use author email field that respects mailmap ([589d624](https://www.github.com/steveukx/git-js/commit/589d62419139ce5ace5081c9c9ae77f83d3f85ab)) | ||
### Bug Fixes | ||
* getConfig always returns `null` despite values being present in configuration ([9fd483a](https://www.github.com/steveukx/git-js/commit/9fd483aa88ee3f6f8674978b36f08811cfb8812a)) | ||
## [2.44.0](https://www.github.com/steveukx/git-js/compare/v2.43.0...v2.44.0) (2021-08-14) | ||
### Features | ||
* add support for getting the current value of a git configuration setting based on its name. ([1d09204](https://www.github.com/steveukx/git-js/commit/1d09204526556a76c5b82979842e6ba5018b083e)) | ||
## [2.43.0](https://www.github.com/steveukx/git-js/compare/v2.42.0...v2.43.0) (2021-08-13) | ||
### Features | ||
* task callback types defined as single function type ([b0a832c](https://www.github.com/steveukx/git-js/commit/b0a832ce22093ff7c9d24aa2b010dd005760acf6)) | ||
## [2.42.0](https://www.github.com/steveukx/git-js/compare/v2.41.2...v2.42.0) (2021-07-31) | ||
### Features | ||
* move `log` task to separate task builder ([0712f86](https://www.github.com/steveukx/git-js/commit/0712f86cf03be04c844cfda0e00fc8cbdb634bb7)) | ||
* support `scope` argument in `listConfig` to return a specific scope's configuration ([0685a8b](https://www.github.com/steveukx/git-js/commit/0685a8b5d8558252bb50451d9c6c8b2bd474d0c8)) | ||
### [2.41.2](https://www.github.com/steveukx/git-js/compare/v2.41.1...v2.41.2) (2021-07-29) | ||
### Bug Fixes | ||
* use literal `true` and `false` in `DiffResultTextFile | DiffResultBinaryFile` to aid type assertions. ([8059099](https://www.github.com/steveukx/git-js/commit/80590997b62573b5cf6483054676efaf7d379d52)) | ||
### [2.41.1](https://www.github.com/steveukx/git-js/compare/v2.41.0...v2.41.1) (2021-07-11) | ||
### Bug Fixes | ||
* Commit parsing should cater for file names with square brackets ([ae81134](https://www.github.com/steveukx/git-js/commit/ae811348fd7c78bf970887fe76a76014b7f64bc1)) | ||
## [2.41.0](https://www.github.com/steveukx/git-js/compare/v2.40.0...v2.41.0) (2021-07-11) | ||
### Features | ||
* allow setting the scope of `git config add` to work on the `local`, `global` or `system` configuration. ([c7164e7](https://www.github.com/steveukx/git-js/commit/c7164e77b98553a5e837da301bc63430741ec092)) | ||
* allow setting the scope of git config add to work on the `local`, `global` or `system` configuration. ([00ada06](https://www.github.com/steveukx/git-js/commit/00ada06057c21193bfbdba917b78a6d3de4ff6c9)) | ||
## [2.40.0](https://www.github.com/steveukx/git-js/compare/v2.39.1...v2.40.0) (2021-06-12) | ||
### Features | ||
* create the `spawnOptions` plugin to allow setting `uid` / `gid` owner for the spawned `git` child processes. ([cc70220](https://www.github.com/steveukx/git-js/commit/cc70220f7636372a4aacd0fb5a74ee98dee54e0d)) | ||
### [2.39.1](https://www.github.com/steveukx/git-js/compare/v2.39.0...v2.39.1) (2021-06-09) | ||
### Bug Fixes | ||
* add types and tests for the documented .exec api ([#631](https://www.github.com/steveukx/git-js/issues/631)) ([c9207da](https://www.github.com/steveukx/git-js/commit/c9207da1d8196193b580c5d4fed6101e5c4d4ff8)) | ||
* add types and tests for the documented `.exec` api ([c9207da](https://www.github.com/steveukx/git-js/commit/c9207da1d8196193b580c5d4fed6101e5c4d4ff8)) | ||
* updates the documentation for `mergeFromTo` to more closely represent its functionality (see [#50](https://www.github.com/steveukx/git-js/issues/50) for the original requirement). ([dd2244e](https://www.github.com/steveukx/git-js/commit/dd2244e1bd84911668b0d23184afb736dc5386b8)) | ||
## [2.39.0](https://www.github.com/steveukx/git-js/compare/v2.38.1...v2.39.0) (2021-05-13) | ||
### Features | ||
* `git.cwd` can now be configured to affect just the chain rather than root instance. ([4110662](https://www.github.com/steveukx/git-js/commit/411066241c014c609d18a37e128c38f2c947c6e7)) | ||
### [2.38.1](https://www.github.com/steveukx/git-js/compare/v2.38.0...v2.38.1) (2021-05-09) | ||
### Bug Fixes | ||
* Export `GitPluginError` from the main package. ([2aa7e55](https://www.github.com/steveukx/git-js/commit/2aa7e55216cdf57ca905cd6c23ff6b71002450c6)), closes [#616](https://www.github.com/steveukx/git-js/issues/616) | ||
## [2.38.0](https://www.github.com/steveukx/git-js/compare/v2.37.0...v2.38.0) (2021-04-14) | ||
### Features | ||
* Support enabling / disabling `debug` logs programmatically. ([#610](https://www.github.com/steveukx/git-js/issues/610)) ([c901b9c](https://www.github.com/steveukx/git-js/commit/c901b9c9e1913ccf8d5d630396f1753d057cd851)) | ||
## [2.37.0](https://www.github.com/steveukx/git-js/compare/v2.36.2...v2.37.0) (2021-03-15) | ||
### Features | ||
* `errorDetectionPlugin` to handle creating error messages when tasks fail. ([c65a419](https://www.github.com/steveukx/git-js/commit/c65a4197e36b5c6f0b2afab46668ab092620a6cc)) | ||
### [2.36.2](https://www.github.com/steveukx/git-js/compare/v2.36.1...v2.36.2) (2021-03-11) | ||
### Bug Fixes | ||
* Export missing `SimpleGitProgressEvent` ([038870e](https://www.github.com/steveukx/git-js/commit/038870eb9ae35be78c1dd7fe1977ad8ba35913f2)), closes [#601](https://www.github.com/steveukx/git-js/issues/601) | ||
### [2.36.1](https://www.github.com/steveukx/git-js/compare/v2.36.0...v2.36.1) (2021-03-06) | ||
### Bug Fixes | ||
* Documentation update for `outputHandler` ([775d81e](https://www.github.com/steveukx/git-js/commit/775d81e4decac8677e879e591e519fbbb6996667)) | ||
* Support parsing `git.branch` where branches have carriage returns in the commit detail. ([5b71012](https://www.github.com/steveukx/git-js/commit/5b710125a5afde5fc1310c5a092cc7c48930c9bb)) | ||
## [2.36.0](https://www.github.com/steveukx/git-js/compare/v2.35.2...v2.36.0) (2021-03-03) | ||
### Features | ||
* Timeout Plugin ([59f3d98](https://www.github.com/steveukx/git-js/commit/59f3d98017b27c251c71758e4641a6aa055549f5)) | ||
### Bug Fixes | ||
* Fix broken link in `no-response` auto-generated comment ([16fe73f](https://www.github.com/steveukx/git-js/commit/16fe73f36514a827d9aa8ea6b9f33b6aa0ea575d)) | ||
### [2.35.2](https://www.github.com/steveukx/git-js/compare/v2.35.1...v2.35.2) (2021-02-23) | ||
### Bug Fixes | ||
* Progress plugin should request progress events for fetch as well as other common long running tasks. ([ea68857](https://www.github.com/steveukx/git-js/commit/ea688570fb444afdaa442d69f8111fd24ef53844)) | ||
* upgrade debug from 4.3.1 to 4.3.2 ([4b6eda8](https://www.github.com/steveukx/git-js/commit/4b6eda85277a549d408d1449284b0bc03fb93c48)) | ||
* While use of the `ListLogSummary` type is deprecated in favour of the new `LogResult`, the alias type should also support the default generic `DefaultLogFields` to allow downstream consumers to upgrade to newer `2.x` versions without the need to specify a generic. ([508e602](https://www.github.com/steveukx/git-js/commit/508e6021716cb220fbf8fca9a57a3616d2246a51)), closes [#586](https://www.github.com/steveukx/git-js/issues/586) | ||
### [2.35.1](https://www.github.com/steveukx/git-js/compare/v2.35.0...v2.35.1) (2021-02-19) | ||
### Bug Fixes | ||
* Update documentation for configuring `SimpleGit` - `options` should be a `Partial<SimpleGitOptions>` to allow for supplying just some of its properties. ([30523df](https://www.github.com/steveukx/git-js/commit/30523dff5bcd483b8fa778ae73caaa84057faad4)), closes [#580](https://www.github.com/steveukx/git-js/issues/580) | ||
## [2.35.0](https://www.github.com/steveukx/git-js/compare/v2.34.2...v2.35.0) (2021-02-16) | ||
### Features | ||
* Progress Handler ([5508bd4](https://www.github.com/steveukx/git-js/commit/5508bd4b10c7bb5233f93446931cdaa90ffeae4f)) | ||
### [2.34.2](https://www.github.com/steveukx/git-js/compare/v2.34.1...v2.34.2) (2021-02-07) | ||
### Bug Fixes | ||
* fix npm publish token definition ([fb066c3](https://www.github.com/steveukx/git-js/commit/fb066c379fcf60423348f827238521350087474d)) | ||
### [2.34.1](https://www.github.com/steveukx/git-js/compare/v2.34.0...v2.34.1) (2021-02-07) | ||
### Bug Fixes | ||
* auto-release with release-please ([0ed2d96](https://www.github.com/steveukx/git-js/commit/0ed2d9695ef3ee4136df12dd59802d7faaf710a6)) | ||
## [2.34.0](https://www.github.com/steveukx/git-js/compare/v2.33.0...v2.34.0) (2021-02-06) | ||
### Features | ||
* refactor `git push` to TypeScript `SimpleGitBase` interface ([e77ef1b](https://www.github.com/steveukx/git-js/commit/e77ef1b1adf89722571fca3f3547b5d8dfbc9d84)) | ||
* refactor `git push` to TypeScript `SimpleGitBase` interface ([0691e85](https://www.github.com/steveukx/git-js/commit/0691e855124e2dc5fdb3403ada30afcd157047c4)) | ||
## [2.33.0](https://www.github.com/steveukx/git-js/compare/v2.32.0...v2.33.0) (2021-02-06) | ||
### Features | ||
* automate release/changelog with release-please ([3848494](https://www.github.com/steveukx/git-js/commit/384849488ada32f18c84eea22aad7b9ceb2000b5)) | ||
* split the `git.add` into the ts `SimpleGitApi` ([14432f9](https://www.github.com/steveukx/git-js/commit/14432f9879744cafa043c0fbeee00b37db726f81)) | ||
## 2.32.0 Per-command Configuration | ||
- Supports passing configuration arguments to the `git` binary (via its `-c` argument as a prefix to any other | ||
arguments). Eg: to supply some custom http proxy to a `git pull` command, use | ||
`simpleGit('/some/path', { config: ['http.proxy=someproxy'] }).pull()` | ||
- Add deprecation notice to `git.silent` | ||
- Internal Updates: | ||
- switch from `run` to `runTask` in `git` core | ||
- finish converting all mocks to TypeScript | ||
## 2.31.0 Handle 'root' commit syntax | ||
- Adds a `root: boolean` property to the `CommitResult` interface representing whether the commit was a 'root' commit | ||
(which is a commit that has no parent, most commonly the first commit in a repo). | ||
## 2.30.0 Restore compatibility with Node.js v10 | ||
- Reinstates native support for node.js v10 by removing use of ES6 constructs | ||
## 2.29.0 Update TypeScript response type for `git.mergeFromTo` | ||
- Update type definition for `git.mergeFromTo` to be the `MergeResult` returned | ||
when using the more generic `git.merge` method. | ||
Thanks to [@ofirelias](https://github.com/ofirelias) for the pull request. | ||
## 2.28.0 Add support for `git apply` & TypeScript Integration Tests | ||
- Adds support for `git.applyPatch` to apply patches generated in a `git diff` to the working index, | ||
TypeScript consumers can make use of the `ApplyOptions` type definition to make use of strong types | ||
for the supported options. Thanks to [@andreterron](https://github.com/andreterron) for the pull request. | ||
- Integration tests converted to TypeScript to ensure type safety across all tests. | ||
## 2.27.0 Included staged delete/modify in StatusResult staged array | ||
- Update the `git.status` parser to account for staged deleted/modified files and staged files with subsequent | ||
modifications meaning a status of: | ||
- `RM old -> new` will now appear in `renamed` and `new` will also appear in `modified` | ||
- `D file` will now appear in both `deleted` and `staged` where ` D file` would only appear in `deleted` | ||
## 2.26.0 Fix error when using `git.log` with callback | ||
- Resolves an issue whereby using `git.log` with a callback (or awaiting the promise created from the now deprecated | ||
`simple-git/promise` import) would fail to return the response to the caller. | ||
## 2.25.0 TypeScript Types & Unit Tests, Commit Parsing | ||
- See [Legacy Node Versions](./docs/LEGACY_NODE_VERSIONS.md) for details of how to use `simple-git` with `node.js` | ||
versions 11 and below. | ||
- To help keep the TypeScript definitions in line with functionality, unit tests are now written in TypeScript. | ||
- When using `git.commit`, the first argument must be a string or array of strings. Passing another data type has long | ||
been considered an error, but now a deprecation warning will be shown in the log and will be switched to an error | ||
in version 3. | ||
- Fixes an issue in `git.commit` whereby a commit that included only deleted lines would be parsed as though the | ||
deletions were inclusions. | ||
## 2.24.0 Types updated | ||
- `pull`, `push` and `pushTags` parameter types updated to match new functionality and tests switched to TypeScript to ensure they are kept in sync | ||
## 2.23.0 update `debug` dependency & `master` -> `main` | ||
- Upgrade `debug` dependency and remove use of now deprecated `debug().destroy()` | ||
- Renames the default source branch from `master` to `main` | ||
## 2.22.0 add `git.hashObject` interface | ||
- Adds support for `git hash-object FILE` and `git hash-object -w FILE` | ||
with new interface `git.hashObject(...)`, with thanks to [@MiOnim](https://github.com/MiOnim) | ||
## 2.21.0 add `string[]` to `LogOptions` type | ||
- Adds `string[]` to the set of types supported as options for `git.log` | ||
- Fix readme typos | ||
## 2.20.1 Bug-fix: `LogOptions` type definition | ||
- `LogOptions` should be intersection rather than union types | ||
## 2.19.0 - Upgrade task option filters | ||
- move the command/task option processing function to TypeScript | ||
## 2.18.0 - Upgrade Clone / Mirror tasks | ||
- `git.clone` and `git.mirror` rewritten to fit the TypeScript tasks style. | ||
- resolves issue whereby `git.clone` didn't accept an object of options despite being documented as supporting. | ||
## 2.17.0 - Add remote message parsing to `git pull` | ||
- `git pull` (and by extension `git merge`) adds remote message parsing to the `PullResult` type | ||
- Remote message parsing adds property `remoteMessages.objects` of type `RemoteMessagesObjectEnumeration` to capture the objects transferred in fetch and push. | ||
## 2.16.0 - Upgrade Move task | ||
- `git.mv` rewritten to fit the TypeScript tasks style. | ||
- set up github actions for CI | ||
## 2.15.0 - Task parsers automatically have access to `stdErr` as well as `stdOut` | ||
- adds the `TaskParser` type to describe a task's parser function and creates the `LineParser` utility to simplify line-by-line parsing of string responses. | ||
- renames some interfaces for consistency of naming, the original name remains as a type alias marked as `@deprecated` until version 3.x: | ||
- BranchDeletionSummary > BranchSingleDeleteResult | ||
- BranchDeletionBatchSummary > BranchMultiDeleteResult | ||
- MergeSummary > MergeResult | ||
## 2.14.0 - Bug fix: `git.checkoutBranch` fails to pass commands to git child process | ||
- resolves an issue whereby the `git.checkoutBranch` method would not pass the branch detail through to the underlying child process. | ||
## 2.13.2 - PushResult to expose all non-empty remote messages | ||
- Further to `2.13.0` includes all (non-empty) `remote:` lines in the `PushResult`, | ||
including `remote:` lines used for other parser results (ie: `pullRequestUrl` etc). | ||
## 2.13.1 - Add support for parsing GitLab Pull Request Url Message | ||
- Further to `2.13.0` adding support for parsing the reponse to `git.push`, adds support for the pull request message | ||
used by gitlab. | ||
## 2.13.0 - Upgraded Pull & Merge and parser for Push | ||
- `.push` and `.pushTags` rewritten as v2 style tasks. The git response is now parsed and returned as a | ||
[PushResult](./typings/response.d.ts) | ||
- Pull and merge rewritten to fit the TypeScript tasks style. | ||
- Integration tests updated to run through jest directly without compiling from nodeunit | ||
## 2.12.0 - Bug fix: chaining onto / async awaiting `git.tags` failed | ||
- resolves an issue whereby the `git.tags` method could not be chained or used as an async/promise. | ||
## 2.11.0 - Parallel / concurrent tasks, fresh repo status parser & bug-fix in `checkoutLocalBranch` | ||
- until now, `simple-git` reject all pending tasks in the queue when a task has failed. From `2.11.0`, only | ||
tasks chained from the failing one will be rejected, other tasks can continue to be processed as normal, | ||
giving the developer more control over which tasks should be treated as atomic chains, and which can be | ||
[run in parallel](./readme.md#concurrent--parallel-requests). | ||
To support this, and to prevent the issues seen when `git` is run concurrently in too many child processes, | ||
`simple-git` will limit the number of tasks running in parallel at any one time to be at most 1 from each | ||
chain (ie: chained tasks are still run in series) and at most 5 tasks across all chains ( | ||
[configurable](./readme.md#configuration) by passing `{maxConcurrentProcesses: x}` in the `simpleGit` constructor). | ||
- add support to `git.status()` for parsing the response of a repo that has no commits yet, previously | ||
it wouldn't determine the branch name correctly. | ||
- resolved a flaw introduced in `2.9.0` whereby `checkoutLocalBranch` would silently fail and not check out the branch | ||
## 2.10.0 - trailing options in checkout, init, status, reset & bug-fix awaiting a non-task | ||
- `git.checkout` now supports both object and array forms of supplying trailing options. | ||
```typescript | ||
import simpleGit from 'simple-git'; | ||
await simpleGit().checkout('branch-name', ['--track', 'remote/branch']); | ||
await simpleGit().checkout(['branch-name', '--track', 'remote/branch']); | ||
await simpleGit().checkout({'branch-name': null}); | ||
``` | ||
- `git.init` now supports both object and array forms of supplying trailing options and now | ||
parses the response to return an [InitResult](./typings/response.d.ts); | ||
```typescript | ||
import simpleGit, { InitResult } from 'simple-git'; | ||
const notSharedInit: InitResult = await simpleGit().init(false, ['--shared=false']); | ||
const notSharedBareInit: InitResult = await simpleGit().init(['--bare', '--shared=false']); | ||
const sharedInit: InitResult = await simpleGit().init(false, {'--shared': 'true'}); | ||
const sharedBareInit: InitResult = await simpleGit().init({'--bare': null, '--shared': 'false'}); | ||
``` | ||
- `git.status` now supports both object and array forms of supplying trailing options. | ||
```typescript | ||
import simpleGit, { StatusResult } from 'simple-git'; | ||
const repoStatus: StatusResult = await simpleGit().status(); | ||
const subDirStatus: StatusResult = await simpleGit().status(['--', 'sub-dir']); | ||
``` | ||
- `git.reset` upgraded to the new task style and exports an enum `ResetMode` with all supported | ||
merge modes and now supports both object and array forms of supplying trailing options. | ||
```typescript | ||
import simpleGit, { ResetMode } from 'simple-git'; | ||
// git reset --hard | ||
await simpleGit().reset(ResetMode.HARD); | ||
// git reset --soft -- sub-dir | ||
await simpleGit().reset(ResetMode.SOFT, ['--', 'sub-dir']); | ||
``` | ||
- bug-fix: it should not be possible to await the `simpleGit()` task runner, only the tasks it returns. | ||
```typescript | ||
expect(simpleGit().then).toBeUndefined(); | ||
expect(simpleGit().init().then).toBe(expect.any(Function)); | ||
``` | ||
## 2.9.0 - checkIsRepo, rev-parse | ||
- `.checkIsRepo()` updated to allow choosing the type of check to run, either by using the exported `CheckRepoActions` enum | ||
or the text equivalents ('bare', 'root' or 'tree'): | ||
- `checkIsRepo(CheckRepoActions.BARE): Promise<boolean>` determines whether the working directory represents a bare repo. | ||
- `checkIsRepo(CheckRepoActions.IS_REPO_ROOT): Promise<boolean>` determines whether the working directory is at the root of a repo. | ||
- `checkIsRepo(CheckRepoActions.IN_TREE): Promise<boolean>` determines whether the working directory is a descendent of a git root. | ||
- `.revparse()` converted to a new style task | ||
## 2.8.0 - Support for `default` import in TS without use of `esModuleInterop` | ||
- Enables support for using the default export of `simple-git` as an es module, in TypeScript it is no | ||
longer necessary to enable the `esModuleInterop` flag in the `tsconfig.json` to consume the default | ||
export. | ||
### 2.7.2 - Bug Fix: Remove `promise.ts` source from `simple-git` published artifact | ||
- Closes #471, whereby the source for the promise wrapped runner would be included in the published artifact | ||
due to sharing the same name as the explicitly included `promise.js` in the project root. | ||
### 2.7.1 - Bug Fix: `await git.log` having imported from root `simple-git` | ||
- Fixes #464, whereby using `await` on `git.log` without having supplied a callback would ignore the leading options | ||
object or options array. | ||
## 2.7.0 - Output Handler and logging | ||
- Updated to the `outputHandler` type to add a trailing argument for the arguments passed into the child process. | ||
- All logging now uses the [debug](https://www.npmjs.com/package/debug) library. Enable logging by adding `simple-git` | ||
to the `DEBUG` environment variable. `git.silent(false)` can still be used to explicitly enable logging and is | ||
equivalent to calling `require('debug').enable('simple-git')`. | ||
## 2.6.0 - Native Promises, Typed Errors, TypeScript Importing, Git.clean and Git.raw | ||
### Native Promises | ||
- _TL;DR - `.then` and `.catch` can now be called on the standard `simpleGit` chain to handle the promise | ||
returned by the most recently added task... essentially, promises now just work the way you would expect | ||
them to._ | ||
- The main export from `simple-git` no longer shows the deprecation notice for using the | ||
`.then` function, it now exposes the promise chain generated from the most recently run | ||
task, allowing the combination of chain building and ad-hoc splitting off to a new promise chain. | ||
- See the [unit](./test/unit/promises.spec.js) and [integration](./test/integration/promise-from-root.spec.js) tests. | ||
- See the [typescript consumer](./test/consumer/ts-default-from-root.spec.ts) test. | ||
### TypeScript Importing | ||
- Promise / async interface and TypeScript types all available from the `simple-git` import rather than needing | ||
`simple-git/promise`, see examples in the [ReadMe](./readme.md) or in the [consumer tests](./test/consumer). | ||
### Typed Errors | ||
- Tasks that previously validated their usage and rejected with a `TypeError` will now reject with a | ||
[`TaskConfigurationError`](./src/lib/errors/task-configuration-error.ts). | ||
- Tasks that previously rejected with a custom object (currently only `git.merge` when the auto-merge fails) | ||
will now reject with a [`GitResponseError`](./src/lib/errors/git-response-error.ts) where previously it | ||
was a modified `Error`. | ||
### Git Clean | ||
- `git.clean(...)` will now return a `CleanSummary` instead of the raw string data | ||
### Git Raw | ||
- `git.raw(...)` now accepts any number of leading string arguments as an alternative to the | ||
single array of strings. | ||
## 2.5.0 - Git.remote | ||
- all `git.remote` related functions converted to TypeScript | ||
## 2.4.0 - Git.subModule | ||
- all `git.subModule` related functions converted to TypeScript | ||
## 2.3.0 - Git.config | ||
- add new `git.listConfig` to get current configuration | ||
- `git.addConfig` supports a new `append` flag to append the value into the config rather than overwrite existing | ||
## 2.2.0 - Git.branch | ||
- all `git.branch` related functions converted to TypeScript | ||
- add new `git.deleteLocalBranches` to delete multiple branches in one call | ||
- `git.deleteLocalBranches` and `git.deleteLocalBranch` now support an optional `forceDelete` flag | ||
## 2.1.0 - Git.tag | ||
- `.tags`, `.addTag` and `.addAnnotatedTag` converted to TypeScript, no backward compatibility changes | ||
## 2.0.0 - Incremental switch to TypeScript and rewritten task execution | ||
- If your application depended on any functions with a name starting with an `_`, the upgrade may not be seamless, | ||
please only use the documented public API. | ||
- `git.log` date format is now strict ISO by default (ie: uses the placeholder `%aI`) instead of the 1.x default of | ||
`%ai` for an "ISO-like" date format. To restore the old behaviour, add `strictDate = false` to the options passed to | ||
`git.log`. | ||
## v1 and below | ||
Please see the [historical changelog](./docs/CHANGELOG-HISTORICAL.md); | ||
* typo in readme.md ([659fc9b](https://www.github.com/steveukx/git-js/commit/659fc9b8ddd6b1edf791cbefa3cf29ab9ef9edf7)) | ||
* Upgrade `debug` dependency to latest `4.3.3` ([8b53104](https://www.github.com/steveukx/git-js/commit/8b5310491b3f0c9020bea86031a9f818fe24a9c8)) | ||
* Upgrade `jest` dependency to latest `27.0.3` ([89a8739](https://www.github.com/steveukx/git-js/commit/89a8739240ae4ad2f3aa104b252cb6beedfe14be)) |
{ | ||
"name": "simple-git", | ||
"description": "Simple GIT interface for node.js", | ||
"version": "2.48.0", | ||
"private": false, | ||
"version": "3.0.1", | ||
"author": "Steve King <steve@mydev.co>", | ||
@@ -19,15 +20,13 @@ "contributors": [ | ||
"@kwsites/promise-deferred": "^1.1.1", | ||
"debug": "^4.3.2" | ||
"debug": "^4.3.3" | ||
}, | ||
"devDependencies": { | ||
"@babel/core": "^7.12.9", | ||
"@babel/preset-env": "^7.12.7", | ||
"@babel/preset-typescript": "^7.12.7", | ||
"@simple-git/babel-config": "^1.0.0", | ||
"@kwsites/promise-result": "^1.1.0", | ||
"@types/debug": "^4.1.5", | ||
"@types/jest": "^26.0.15", | ||
"@types/jest": "^27.0.3", | ||
"@types/node": "^14.14.10", | ||
"babel-jest": "^26.6.3", | ||
"babel-plugin-module-resolver": "^4.0.0", | ||
"jest": "^26.6.3", | ||
"esbuild": "^0.14.10", | ||
"esbuild-node-externals": "^1.4.1", | ||
"jest": "^27.4.5", | ||
"ts-node": "^9.0.0", | ||
@@ -43,24 +42,14 @@ "typescript": "^4.1.2" | ||
"repository": "git://github.com/steveukx/git-js.git", | ||
"main": "./src/index.js", | ||
"main": "cjs/index.js", | ||
"module": "esm/index.js", | ||
"exports": { | ||
".": { | ||
"import": "./esm/index.js", | ||
"require": "./cjs/index.js" | ||
} | ||
}, | ||
"types": "./typings/index.d.ts", | ||
"files": [ | ||
"promise.js", | ||
"promise.d.ts", | ||
"src/**/*.d.ts", | ||
"src/**/*.js", | ||
"src/**/*.js.map", | ||
"typings/" | ||
], | ||
"scripts": { | ||
"clean": "git clean -fxd -e .idea -e node_modules", | ||
"tsc": "tsc", | ||
"build": "tsc --build", | ||
"build:clean": "yarn clean && yarn build", | ||
"build:release": "tsc -p tsconfig.release.json", | ||
"test:consumer": "tsc -p test/consumer/tsconfig-standard.json && tsc -p test/consumer/tsconfig-promise.json", | ||
"test:jest": "jest --coverage", | ||
"test": "yarn test:consumer && yarn test:jest", | ||
"preversion": "yarn clean && yarn test && yarn build:release", | ||
"postversion": "npm publish && git push && git push --tags" | ||
"publishConfig": { | ||
"tag": "canary" | ||
} | ||
} | ||
} |
@@ -6,2 +6,11 @@ import * as errors from './typings/errors'; | ||
/** | ||
* @deprecated | ||
* | ||
* simple-git has supported promises / async await since version 2.6.0. | ||
* Importing from 'simple-git/promise' has been deprecated and will be | ||
* removed by July 2022. | ||
* | ||
* To upgrade, change all 'simple-git/promise' imports to just 'simple-git' | ||
*/ | ||
declare const simplegit: simplegit.SimpleGitExport; | ||
@@ -15,2 +24,11 @@ | ||
/** | ||
* @deprecated | ||
* | ||
* simple-git has supported promises / async await since version 2.6.0. | ||
* Importing from 'simple-git/promise' has been deprecated and will be | ||
* removed by July 2022. | ||
* | ||
* To upgrade, change all 'simple-git/promise' imports to just 'simple-git' | ||
*/ | ||
type SimpleGit = simpleGit.SimpleGit; | ||
@@ -48,2 +66,11 @@ | ||
/** | ||
* @deprecated | ||
* | ||
* simple-git has supported promises / async await since version 2.6.0. | ||
* Importing from 'simple-git/promise' has been deprecated and will be | ||
* removed by July 2022. | ||
* | ||
* To upgrade, change all 'simple-git/promise' imports to just 'simple-git' | ||
*/ | ||
export = simplegit; |
@@ -0,7 +1,16 @@ | ||
// TODO: deprecation warning | ||
console.warn(`============================================= | ||
simple-git has supported promises / async await since version 2.6.0. | ||
Importing from 'simple-git/promise' has been deprecated and will be | ||
removed by July 2022. | ||
const {esModuleFactory, gitExportFactory} = require('./src/lib/git-factory'); | ||
const {gitP} = require('./src/lib/runners/promise-wrapped'); | ||
To upgrade, change all 'simple-git/promise' imports to just 'simple-git' | ||
=============================================`); | ||
module.exports = esModuleFactory( | ||
gitExportFactory(gitP) | ||
const simpleGit = require('.'); | ||
module.exports = Object.assign( | ||
function () { return simpleGit.gitP.apply(null, arguments) }, | ||
simpleGit, | ||
{ default: simpleGit.gitP }, | ||
); |
100
readme.md
@@ -19,21 +19,26 @@ # Simple Git | ||
Include into your JavaScript app using: | ||
Include into your JavaScript app using commons js: | ||
```js | ||
```javascript | ||
// require the library, main export is a function | ||
const simpleGit = require('simple-git'); | ||
const git = simpleGit(); | ||
simpleGit().clean(simpleGit.CleanOptions.FORCE); | ||
// or use named properties | ||
const {default: simpleGit, CleanOptions} = require('simple-git'); | ||
simpleGit().clean(CleanOptions.FORCE); | ||
``` | ||
Include into your JavaScript app as an ES Module: | ||
```javascript | ||
import simpleGit, {CleanOptions} from 'simple-git'; | ||
simpleGit().clean(CleanOptions.FORCE); | ||
``` | ||
Include in a TypeScript app using: | ||
```typescript | ||
// Import `SimpleGit` types and the default function exported from `simple-git` | ||
import simpleGit, {SimpleGit} from 'simple-git'; | ||
const git: SimpleGit = simpleGit(); | ||
// prior to v2.6.0 required importing from `simple-git/promise` | ||
// this import is still available but is now deprecated | ||
import gitP, {SimpleGit} from 'simple-git/promise'; | ||
const git: SimpleGit = gitP(); | ||
import simpleGit, {SimpleGit, CleanOptions} from 'simple-git'; | ||
const git: SimpleGit = simpleGit().clean(CleanOptions.FORCE); | ||
``` | ||
@@ -82,15 +87,15 @@ | ||
- [Completion Detection](./docs/PLUGIN-COMPLETION-DETECTION.md) | ||
- [Completion Detection](https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-COMPLETION-DETECTION.md) | ||
Customise how `simple-git` detects the end of a `git` process. | ||
- [Error Detection](./docs/PLUGIN-ERRORS.md) | ||
- [Error Detection](https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-ERRORS.md) | ||
Customise the detection of errors from the underlying `git` process. | ||
- [Progress Events](./docs/PLUGIN-PROGRESS-EVENTS.md) | ||
- [Progress Events](https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-PROGRESS-EVENTS.md) | ||
Receive progress events as `git` works through long-running processes. | ||
- [Spawned Process Ownership](./docs/PLUGIN-SPAWN-OPTIONS.md) | ||
- [Spawned Process Ownership](https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-SPAWN-OPTIONS.md) | ||
Configure the system `uid` / `gid` to use for spawned `git` processes. | ||
- [Timeout](./docs/PLUGIN-TIMEOUT.md) | ||
- [Timeout](https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-TIMEOUT.md) | ||
Automatically kill the wrapped `git` process after a rolling timeout. | ||
@@ -105,3 +110,3 @@ | ||
```javascript | ||
const simpleGit = require('simple-git'); | ||
import simpleGit from 'simple-git'; | ||
const git = simpleGit(); | ||
@@ -146,3 +151,4 @@ | ||
In addition to returning promise method can be called with a trailing callback argument to handle the result of the task | ||
In addition to returning a promise, each method can also be called with a trailing callback argument | ||
to handle the result of the task. | ||
@@ -166,3 +172,3 @@ ```javascript | ||
For type details of the response for each of the tasks, please see the [TypeScript definitions](./typings/simple-git.d.ts). | ||
For type details of the response for each of the tasks, please see the [TypeScript definitions](https://github.com/steveukx/git-js/blob/main/simple-git/typings/simple-git.d.ts). | ||
@@ -185,4 +191,4 @@ | ||
| `.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/lib/responses/DiffSummary.js) | | ||
| `.diffSummary(options, handlerFn)` | includes options in the call to `diff --stat options` and returns a [DiffSummary](src/lib/responses/DiffSummary.js) | | ||
| `.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](https://github.com/steveukx/git-js/blob/main/simple-git/src/lib/responses/DiffSummary.js) | | ||
| `.diffSummary(options, handlerFn)` | includes options in the call to `diff --stat options` and returns a [DiffSummary](https://github.com/steveukx/git-js/blob/main/simple-git/src/lib/responses/DiffSummary.js) | | ||
| `.env(name, value)` | Set environment variables to be passed to the spawned child processes, [see usage in detail below](#environment-variables). | | ||
@@ -194,3 +200,3 @@ | `.exec(handlerFn)` | calls a simple function in the current step | | ||
| `.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 commmand will be treated as an error, otherwise treated as a success. | | ||
| `.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). | | ||
@@ -213,4 +219,4 @@ | `.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). | | ||
- `.branch([options])` uses the supplied [options](#how-to-specify-options) to run any arguments supported by the [branch](https://git-scm.com/docs/git-branch) command. Either returns a [BranchSummaryResult](src/lib/responses/BranchSummary.ts) instance when listing branches, or a [BranchSingleDeleteResult](typings/response.d.ts) type object when the options included `-d`, `-D` or `--delete` which cause it to delete a named branch rather than list existing branches. | ||
- `.branchLocal()` gets a list of local branches as a [BranchSummaryResult](src/lib/responses/BranchSummary.ts) instance | ||
- `.branch([options])` uses the supplied [options](#how-to-specify-options) to run any arguments supported by the [branch](https://git-scm.com/docs/git-branch) command. Either returns a [BranchSummaryResult](https://github.com/steveukx/git-js/blob/main/simple-git/src/lib/responses/BranchSummary.ts) instance when listing branches, or a [BranchSingleDeleteResult](https://github.com/steveukx/git-js/blob/main/simple-git/typings/response.d.ts) type object when the options included `-d`, `-D` or `--delete` which cause it to delete a named branch rather than list existing branches. | ||
- `.branchLocal()` gets a list of local branches as a [BranchSummaryResult](https://github.com/steveukx/git-js/blob/main/simple-git/src/lib/responses/BranchSummary.ts) instance | ||
- `.deleteLocalBranch(branchName)` deletes a local branch - treats a failed attempt as an error | ||
@@ -253,11 +259,11 @@ - `.deleteLocalBranch(branchName, forceDelete)` deletes a local branch, optionally explicitly setting forceDelete to true - treats a failed attempt as an error | ||
- `.getConfig(key)` get the value(s) for a named key as a [ConfigGetResult](typings/response.d.ts) | ||
- `.getConfig(key, scope)` get the value(s) for a named key as a [ConfigGetResult](typings/response.d.ts) but limit the | ||
- `.getConfig(key)` get the value(s) for a named key as a [ConfigGetResult](https://github.com/steveukx/git-js/blob/main/simple-git/typings/response.d.ts) | ||
- `.getConfig(key, scope)` get the value(s) for a named key as a [ConfigGetResult](https://github.com/steveukx/git-js/blob/main/simple-git/typings/response.d.ts) but limit the | ||
scope of the properties searched to a single specified scope (use the exported `GitConfigScope` enum, or equivalent | ||
string values - `worktree | local | global | system`) | ||
- `.listConfig()` reads the current configuration and returns a [ConfigListSummary](./src/lib/responses/ConfigList.ts) | ||
- `.listConfig()` reads the current configuration and returns a [ConfigListSummary](https://github.com/steveukx/git-js/blob/main/simple-git/src/lib/responses/ConfigList.ts) | ||
- `.listConfig(scope: GitConfigScope)` as with `listConfig` but returns only those items in a specified scope (note that configuration values are overlaid on top of each other to build the config `git` will actually use - to resolve the configuration you are using use `(await listConfig()).all` without the scope argument) | ||
## git grep [examples](./examples/git-grep.md) | ||
## git grep [examples](https://github.com/steveukx/git-js/blob/main/examples/git-grep.md) | ||
@@ -303,4 +309,4 @@ - `.grep(searchTerm)` searches for a single search term across all files in the working tree, optionally passing a standard [options](#how-to-specify-options) object of additional arguments | ||
Conflicts during the merge result in an error response, the response is an instance of | ||
[MergeSummary](src/lib/responses/MergeSummary.ts) whether it was an error or success. | ||
When successful, the MergeSummary has all detail from a the [PullSummary](src/lib/responses/PullSummary.ts) | ||
[MergeSummary](https://github.com/steveukx/git-js/blob/main/simple-git/src/lib/responses/MergeSummary.ts) whether it was an error or success. | ||
When successful, the MergeSummary has all detail from a the [PullSummary](https://github.com/steveukx/git-js/blob/main/simple-git/src/lib/responses/PullSummary.ts) | ||
along with summary detail for the merge. | ||
@@ -367,3 +373,3 @@ When the merge failed, the MergeSummary contains summary detail for why the merge failed and which files | ||
- `.status([options])` gets the status of the current repo, resulting in a [StatusResult](typings/response.d.ts). Additional arguments | ||
- `.status([options])` gets the status of the current repo, resulting in a [StatusResult](https://github.com/steveukx/git-js/blob/main/simple-git/typings/response.d.ts). Additional arguments | ||
supported by [git status](https://git-scm.com/docs/git-status) can be supplied as an [options](#how-to-specify-options) object/array. | ||
@@ -378,3 +384,3 @@ | ||
## changing the working directory [examples](examples/git-change-working-directory.md) | ||
## changing the working directory [examples](https://github.com/steveukx/git-js/blob/main/examples/git-change-working-directory.md) | ||
@@ -420,7 +426,7 @@ - `.cwd(workingDirectory)` Sets the working directory for all future commands - note, this will change the working for the root instance, any chain created from the root will also be changed. | ||
For a per-release overview of changes, see the [changelog](./CHANGELOG.md). | ||
For a per-release overview of changes, see the [changelog](https://github.com/steveukx/git-js/blob/main/simple-git/CHANGELOG.md). | ||
## 2.x Upgrade Notes | ||
When upgrading to release 2.x from 1.x, see the [changelog](./CHANGELOG.md) for the release 2.0.0 | ||
When upgrading to release 2.x from 1.x, see the [changelog](https://github.com/steveukx/git-js/blob/main/simple-git/CHANGELOG.md) for the release 2.0.0 | ||
@@ -430,6 +436,6 @@ # Recently Deprecated / Altered APIs | ||
- ~~2.25.0 depends on Node.js version 12 or above, for use in lower versions of node.js ensure you are also | ||
importing the necessary polyfills from `core-js`, see [Legacy Node Versions](./docs/LEGACY_NODE_VERSIONS.md)~~ | ||
importing the necessary polyfills from `core-js`, see [Legacy Node Versions](https://github.com/steveukx/git-js/blob/main/docs/LEGACY_NODE_VERSIONS.md)~~ | ||
_this change has been reverted in 2.30.0 and will be postponed until version 3.x_. | ||
- 2.13.0 `.push` now returns a [PushResult](./typings/response.d.ts) parsed representation of the response. | ||
- 2.13.0 `.push` now returns a [PushResult](https://github.com/steveukx/git-js/blob/main/simple-git/typings/response.d.ts) parsed representation of the response. | ||
@@ -442,3 +448,3 @@ - 2.11.0 treats tasks chained together as atomic, where any failure in the chain prevents later tasks from | ||
- 2.7.0 deprecates use of `.silent()` in favour of using the `debug` library - see the | ||
[debug logging guide](docs/DEBUG-LOGGING-GUIDE.md) for further details. | ||
[debug logging guide](https://github.com/steveukx/git-js/blob/main/docs/DEBUG-LOGGING-GUIDE.md) for further details. | ||
@@ -448,3 +454,3 @@ - 2.6.0 introduced `.then` and `.catch` as a way to chain a promise onto the current step of the chain. | ||
For the full history see the [changelog](./CHANGELOG.md); | ||
For the full history see the [changelog](https://github.com/steveukx/git-js/blob/main/simple-git/CHANGELOG.md); | ||
@@ -493,3 +499,3 @@ # Concurrent / Parallel Requests | ||
```js | ||
```javascript | ||
const git = require('simple-git'); | ||
@@ -515,3 +521,3 @@ const path = '/path/to/repo'; | ||
```js | ||
```javascript | ||
const USER = 'something'; | ||
@@ -538,3 +544,3 @@ const PASS = 'somewhere'; | ||
```js | ||
```javascript | ||
const GIT_SSH_COMMAND = "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"; | ||
@@ -579,3 +585,3 @@ | ||
```js | ||
```javascript | ||
const simpleGit = require('simple-git'); | ||
@@ -661,3 +667,3 @@ const git = simpleGit(); | ||
See the [debug logging guide](docs/DEBUG-LOGGING-GUIDE.md) for logging examples and how to | ||
See the [debug logging guide](https://github.com/steveukx/git-js/blob/main/docs/DEBUG-LOGGING-GUIDE.md) for logging examples and how to | ||
make use of the [debug](https://www.npmjs.com/package/debug) library's programmatic interface | ||
@@ -668,3 +674,3 @@ in your application. | ||
See the [debug logging guide](docs/DEBUG-LOGGING-GUIDE.md#verbose-logging-options) for | ||
See the [debug logging guide](https://github.com/steveukx/git-js/blob/main/docs/DEBUG-LOGGING-GUIDE.md#verbose-logging-options) for | ||
the full list of verbose logging options to use with the | ||
@@ -722,3 +728,3 @@ [debug](https://www.npmjs.com/package/debug) library. | ||
To resolve these issues, either upgrade to a newer version of node.js or ensure you are using the necessary | ||
polyfills from `core-js` - see [Legacy Node Versions](./docs/LEGACY_NODE_VERSIONS.md). | ||
polyfills from `core-js` - see [Legacy Node Versions](https://github.com/steveukx/git-js/blob/main/docs/LEGACY_NODE_VERSIONS.md). | ||
@@ -806,3 +812,3 @@ # Examples | ||
```js | ||
```javascript | ||
require('simple-git')() | ||
@@ -817,3 +823,3 @@ .add('./*') | ||
```js | ||
```javascript | ||
require('simple-git')() | ||
@@ -820,0 +826,0 @@ .outputHandler((bin, stdout, stderr, args) => { |
@@ -11,14 +11,2 @@ import { GitConstructError } from './errors/git-construct-error'; | ||
import { ResetMode } from './tasks/reset'; | ||
declare const api: { | ||
CheckRepoActions: typeof CheckRepoActions; | ||
CleanOptions: typeof CleanOptions; | ||
GitConfigScope: typeof GitConfigScope; | ||
GitConstructError: typeof GitConstructError; | ||
GitError: typeof GitError; | ||
GitPluginError: typeof GitPluginError; | ||
GitResponseError: typeof GitResponseError; | ||
ResetMode: typeof ResetMode; | ||
TaskConfigurationError: typeof TaskConfigurationError; | ||
grepQueryBuilder: typeof grepQueryBuilder; | ||
}; | ||
export default api; | ||
export { CheckRepoActions, CleanOptions, GitConfigScope, GitConstructError, GitError, GitPluginError, GitResponseError, ResetMode, TaskConfigurationError, grepQueryBuilder, }; |
import { SimpleGitFactory } from '../../typings'; | ||
import * as api from './api'; | ||
import { SimpleGitOptions } from './types'; | ||
@@ -13,14 +14,3 @@ /** | ||
}; | ||
export declare function gitExportFactory<T = {}>(factory: SimpleGitFactory, extra: T): ((options: Partial<SimpleGitOptions>) => import("../../typings").SimpleGit) & { | ||
CheckRepoActions: typeof import("./tasks/check-is-repo").CheckRepoActions; | ||
CleanOptions: typeof import("./tasks/clean").CleanOptions; | ||
GitConfigScope: typeof import("./tasks/config").GitConfigScope; | ||
GitConstructError: typeof import("./errors/git-construct-error").GitConstructError; | ||
GitError: typeof import("./errors/git-error").GitError; | ||
GitPluginError: typeof import("./errors/git-plugin-error").GitPluginError; | ||
GitResponseError: typeof import("./errors/git-response-error").GitResponseError; | ||
ResetMode: typeof import("./tasks/reset").ResetMode; | ||
TaskConfigurationError: typeof import("./errors/task-configuration-error").TaskConfigurationError; | ||
grepQueryBuilder: typeof import("./tasks/grep").grepQueryBuilder; | ||
}; | ||
export declare function gitExportFactory<T = {}>(factory: SimpleGitFactory, extra: T): ((options: Partial<SimpleGitOptions>) => import("../../typings").SimpleGit) & typeof api; | ||
export declare function gitInstanceFactory(baseDir?: string | Partial<SimpleGitOptions>, options?: Partial<SimpleGitOptions>): any; |
Sorry, the diff of this file is not supported yet
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
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
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
793334
10
9464
866
103
3
3
Updateddebug@^4.3.3