129.md (22750B)
1 # PR #129 fix(deps): update dependency simple-git to v2 2 3 - **Status:** open 4 - **Author:** @renovate[bot] 5 - **Created:** 2020-05-01T11:59:12Z 6 - **Branch:** renovate/simple-git-2.x → master 7 - **Diff:** [129.diff](./129.diff) 8 9 --- 10 11 [](https://renovatebot.com) 12 13 This PR contains the following updates: 14 15 | Package | Change | Age | Adoption | Passing | Confidence | 16 |---|---|---|---|---|---| 17 | [simple-git](https://togithub.com/steveukx/git-js) | [`^1.75.0` -> `^2.0.0`](https://renovatebot.com/diffs/npm/simple-git/1.132.0/2.31.0) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | 18 19 --- 20 21 ### Release Notes 22 23 <details> 24 <summary>steveukx/git-js</summary> 25 26 ### [`v2.31.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2310-Handle-root-commit-syntax) 27 28 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.30.0...v2.31.0) 29 30 - Adds a `root: boolean` property to the `CommitResult` interface representing whether the commit was a 'root' commit 31 (which is a commit that has no parent, most commonly the first commit in a repo). 32 33 ### [`v2.30.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2300-Restore-compatibility-with-Nodejs-v10) 34 35 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.29.0...v2.30.0) 36 37 - Reinstates native support for node.js v10 by removing use of ES6 constructs 38 39 ### [`v2.29.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2290-Update-TypeScript-response-type-for-gitmergeFromTo) 40 41 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.28.0...v2.29.0) 42 43 - Update type definition for `git.mergeFromTo` to be the `MergeResult` returned 44 when using the more generic `git.merge` method. 45 Thanks to [@​ofirelias](https://togithub.com/ofirelias) for the pull request. 46 47 ### [`v2.28.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2280-Add-support-for-git-apply--TypeScript-Integration-Tests) 48 49 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.27.0...v2.28.0) 50 51 - Adds support for `git.applyPatch` to apply patches generated in a `git diff` to the working index, 52 TypeScript consumers can make use of the `ApplyOptions` type definition to make use of strong types 53 for the supported options. Thanks to [@​andreterron](https://togithub.com/andreterron) for the pull request. 54 55 - Integration tests converted to TypeScript to ensure type safety across all tests. 56 57 ### [`v2.27.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2270-Included-staged-deletemodify-in-StatusResult-staged-array) 58 59 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.26.0...v2.27.0) 60 61 - Update the `git.status` parser to account for staged deleted/modified files and staged files with subsequent 62 modifications meaning a status of: 63 - `RM old -> new` will now appear in `renamed` and `new` will also appear in `modified` 64 - `D file` will now appear in both `deleted` and `staged` where `D file` would only appear in `deleted` 65 66 ### [`v2.26.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2260-Fix-error-when-using-gitlog-with-callback) 67 68 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.25.0...v2.26.0) 69 70 - Resolves an issue whereby using `git.log` with a callback (or awaiting the promise created from the now deprecated 71 `simple-git/promise` import) would fail to return the response to the caller. 72 73 ### [`v2.25.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2250-TypeScript-Types--Unit-Tests-Commit-Parsing) 74 75 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.24.0...v2.25.0) 76 77 - See [Legacy Node Versions](./docs/LEGACY_NODE_VERSIONS.md) for details of how to use `simple-git` with `node.js` 78 versions 11 and below. 79 - To help keep the TypeScript definitions in line with functionality, unit tests are now written in TypeScript. 80 - When using `git.commit`, the first argument must be a string or array of strings. Passing another data type has long 81 been considered an error, but now a deprecation warning will be shown in the log and will be switched to an error 82 in version 3. 83 - Fixes an issue in `git.commit` whereby a commit that included only deleted lines would be parsed as though the 84 deletions were inclusions. 85 86 ### [`v2.24.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2240-Types-updated) 87 88 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.23.0...v2.24.0) 89 90 - `pull`, `push` and `pushTags` parameter types updated to match new functionality and tests switched to TypeScript to ensure they are kept in sync 91 92 ### [`v2.23.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2230-update-debug-dependency--master---main) 93 94 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.22.0...v2.23.0) 95 96 - Upgrade `debug` dependency and remove use of now deprecated `debug().destroy()` 97 - Renames the default source branch from `master` to `main` 98 99 ### [`v2.22.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2220-add-githashObject-interface) 100 101 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.21.0...v2.22.0) 102 103 - Adds support for `git hash-object FILE` and `git hash-object -w FILE` 104 with new interface `git.hashObject(...)`, with thanks to [@​MiOnim](https://togithub.com/MiOnim) 105 106 ### [`v2.21.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2210-add-string--to-LogOptions-type) 107 108 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.20.1...v2.21.0) 109 110 - Adds `string[]` to the set of types supported as options for `git.log` 111 - Fix readme typos 112 113 ### [`v2.20.1`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2201-Bug-fix-LogOptions-type-definition) 114 115 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.20.0...v2.20.1) 116 117 - `LogOptions` should be intersection rather than union types 118 119 ### [`v2.20.0`](https://togithub.com/steveukx/git-js/compare/v2.19.0...v2.20.0) 120 121 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.19.0...v2.20.0) 122 123 ### [`v2.19.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2190---Upgrade-task-option-filters) 124 125 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.18.0...v2.19.0) 126 127 - move the command/task option processing function to TypeScript 128 129 ### [`v2.18.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2180---Upgrade-Clone--Mirror-tasks) 130 131 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.17.0...v2.18.0) 132 133 - `git.clone` and `git.mirror` rewritten to fit the TypeScript tasks style. 134 - resolves issue whereby `git.clone` didn't accept an object of options despite being documented as supporting. 135 136 ### [`v2.17.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2170---Add-remote-message-parsing-to-git-pull) 137 138 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.16.0...v2.17.0) 139 140 - `git pull` (and by extension `git merge`) adds remote message parsing to the `PullResult` type 141 - Remote message parsing adds property `remoteMessages.objects` of type `RemoteMessagesObjectEnumeration` to capture the objects transferred in fetch and push. 142 143 ### [`v2.16.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2160---Upgrade-Move-task) 144 145 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.15.0...v2.16.0) 146 147 - `git.mv` rewritten to fit the TypeScript tasks style. 148 - set up github actions for CI 149 150 ### [`v2.15.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2150---Task-parsers-automatically-have-access-to-stdErr-as-well-as-stdOut) 151 152 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.14.0...v2.15.0) 153 154 - 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. 155 - renames some interfaces for consistency of naming, the original name remains as a type alias marked as `@deprecated` until version 3.x: 156 - BranchDeletionSummary > BranchSingleDeleteResult 157 - BranchDeletionBatchSummary > BranchMultiDeleteResult 158 - MergeSummary > MergeResult 159 160 ### [`v2.14.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2140---Bug-fix-gitcheckoutBranch-fails-to-pass-commands-to-git-child-process) 161 162 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.13.2...v2.14.0) 163 164 - resolves an issue whereby the `git.checkoutBranch` method would not pass the branch detail through to the underlying child process. 165 166 ### [`v2.13.2`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2132---PushResult-to-expose-all-non-empty-remote-messages) 167 168 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.13.1...v2.13.2) 169 170 - Further to `2.13.0` includes all (non-empty) `remote:` lines in the `PushResult`, 171 including `remote:` lines used for other parser results (ie: `pullRequestUrl` etc). 172 173 ### [`v2.13.1`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2131---Add-support-for-parsing-GitLab-Pull-Request-Url-Message) 174 175 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.13.0...v2.13.1) 176 177 - Further to `2.13.0` adding support for parsing the reponse to `git.push`, adds support for the pull request message 178 used by gitlab. 179 180 ### [`v2.13.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2130---Upgraded-Pull--Merge-and-parser-for-Push) 181 182 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.12.0...v2.13.0) 183 184 - `.push` and `.pushTags` rewritten as v2 style tasks. The git response is now parsed and returned as a 185 [PushResult](./typings/response.d.ts) 186 187 - Pull and merge rewritten to fit the TypeScript tasks style. 188 189 - Integration tests updated to run through jest directly without compiling from nodeunit 190 191 ### [`v2.12.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2120---Bug-fix-chaining-onto--async-awaiting-gittags-failed) 192 193 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.11.0...v2.12.0) 194 195 - resolves an issue whereby the `git.tags` method could not be chained or used as an async/promise. 196 197 ### [`v2.11.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2110---Parallel--concurrent-tasks-fresh-repo-status-parser--bug-fix-in-checkoutLocalBranch) 198 199 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.10.0...v2.11.0) 200 201 - until now, `simple-git` reject all pending tasks in the queue when a task has failed. From `2.11.0`, only 202 tasks chained from the failing one will be rejected, other tasks can continue to be processed as normal, 203 giving the developer more control over which tasks should be treated as atomic chains, and which can be 204 [run in parallel](./readme.md#concurrent--parallel-requests). 205 206 To support this, and to prevent the issues seen when `git` is run concurrently in too many child processes, 207 `simple-git` will limit the number of tasks running in parallel at any one time to be at most 1 from each 208 chain (ie: chained tasks are still run in series) and at most 5 tasks across all chains ( 209 [configurable](./readme.md#configuration) by passing `{maxConcurrentProcesses: x}` in the `simpleGit` constructor). 210 211 - add support to `git.status()` for parsing the response of a repo that has no commits yet, previously 212 it wouldn't determine the branch name correctly. 213 214 - resolved a flaw introduced in `2.9.0` whereby `checkoutLocalBranch` would silently fail and not check out the branch 215 216 ### [`v2.10.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​2100---trailing-options-in-checkout-init-status-reset--bug-fix-awaiting-a-non-task) 217 218 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.9.0...v2.10.0) 219 220 - `git.checkout` now supports both object and array forms of supplying trailing options. 221 222 ```typescript 223 import simpleGit from 'simple-git'; 224 await simpleGit().checkout('branch-name', ['--track', 'remote/branch']); 225 await simpleGit().checkout(['branch-name', '--track', 'remote/branch']); 226 await simpleGit().checkout({'branch-name': null}); 227 ``` 228 229 - `git.init` now supports both object and array forms of supplying trailing options and now 230 parses the response to return an [InitResult](./typings/response.d.ts); 231 232 ```typescript 233 import simpleGit, { InitResult } from 'simple-git'; 234 const notSharedInit: InitResult = await simpleGit().init(false, ['--shared=false']); 235 const notSharedBareInit: InitResult = await simpleGit().init(['--bare', '--shared=false']); 236 const sharedInit: InitResult = await simpleGit().init(false, {'--shared': 'true'}); 237 const sharedBareInit: InitResult = await simpleGit().init({'--bare': null, '--shared': 'false'}); 238 ``` 239 240 - `git.status` now supports both object and array forms of supplying trailing options. 241 242 ```typescript 243 import simpleGit, { StatusResult } from 'simple-git'; 244 const repoStatus: StatusResult = await simpleGit().status(); 245 const subDirStatus: StatusResult = await simpleGit().status(['--', 'sub-dir']); 246 ``` 247 248 - `git.reset` upgraded to the new task style and exports an enum `ResetMode` with all supported 249 merge modes and now supports both object and array forms of supplying trailing options. 250 251 ```typescript 252 import simpleGit, { ResetMode } from 'simple-git'; 253 254 // git reset --hard 255 await simpleGit().reset(ResetMode.HARD); 256 257 // git reset --soft -- sub-dir 258 await simpleGit().reset(ResetMode.SOFT, ['--', 'sub-dir']); 259 ``` 260 261 - bug-fix: it should not be possible to await the `simpleGit()` task runner, only the tasks it returns. 262 263 ```typescript 264 expect(simpleGit().then).toBeUndefined(); 265 expect(simpleGit().init().then).toBe(expect.any(Function)); 266 ``` 267 268 ### [`v2.9.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​290---checkIsRepo-rev-parse) 269 270 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.8.0...v2.9.0) 271 272 - `.checkIsRepo()` updated to allow choosing the type of check to run, either by using the exported `CheckRepoActions` enum 273 or the text equivalents ('bare', 'root' or 'tree'): 274 275 - `checkIsRepo(CheckRepoActions.BARE): Promise<boolean>` determines whether the working directory represents a bare repo. 276 - `checkIsRepo(CheckRepoActions.IS_REPO_ROOT): Promise<boolean>` determines whether the working directory is at the root of a repo. 277 - `checkIsRepo(CheckRepoActions.IN_TREE): Promise<boolean>` determines whether the working directory is a descendent of a git root. 278 279 - `.revparse()` converted to a new style task 280 281 ### [`v2.8.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​280---Support-for-default-import-in-TS-without-use-of-esModuleInterop) 282 283 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.7.2...v2.8.0) 284 285 - Enables support for using the default export of `simple-git` as an es module, in TypeScript it is no 286 longer necessary to enable the `esModuleInterop` flag in the `tsconfig.json` to consume the default 287 export. 288 289 ##### 2.7.2 - Bug Fix: Remove `promise.ts` source from `simple-git` published artifact 290 291 - Closes [#​471](https://togithub.com/steveukx/git-js/issues/471), whereby the source for the promise wrapped runner would be included in the published artifact 292 due to sharing the same name as the explicitly included `promise.js` in the project root. 293 294 ##### 2.7.1 - Bug Fix: `await git.log` having imported from root `simple-git` 295 296 - Fixes [#​464](https://togithub.com/steveukx/git-js/issues/464), whereby using `await` on `git.log` without having supplied a callback would ignore the leading options 297 object or options array. 298 299 ### [`v2.7.2`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​272---Bug-Fix-Remove-promisets-source-from-simple-git-published-artifact) 300 301 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.7.1...v2.7.2) 302 303 - Closes [#​471](https://togithub.com/steveukx/git-js/issues/471), whereby the source for the promise wrapped runner would be included in the published artifact 304 due to sharing the same name as the explicitly included `promise.js` in the project root. 305 306 ### [`v2.7.1`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​271---Bug-Fix-await-gitlog-having-imported-from-root-simple-git) 307 308 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.7.0...v2.7.1) 309 310 - Fixes [#​464](https://togithub.com/steveukx/git-js/issues/464), whereby using `await` on `git.log` without having supplied a callback would ignore the leading options 311 object or options array. 312 313 ### [`v2.7.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​270---Output-Handler-and-logging) 314 315 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.6.0...v2.7.0) 316 317 - Updated to the `outputHandler` type to add a trailing argument for the arguments passed into the child process. 318 - All logging now uses the [debug](https://www.npmjs.com/package/debug) library. Enable logging by adding `simple-git` 319 to the `DEBUG` environment variable. `git.silent(false)` can still be used to explicitly enable logging and is 320 equivalent to calling `require('debug').enable('simple-git')`. 321 322 ### [`v2.6.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​260---Native-Promises-Typed-Errors-TypeScript-Importing-Gitclean-and-Gitraw) 323 324 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.5.0...v2.6.0) 325 326 ##### Native Promises 327 328 - _TL;DR - `.then` and `.catch` can now be called on the standard `simpleGit` chain to handle the promise 329 returned by the most recently added task... essentially, promises now just work the way you would expect 330 them to._ 331 - The main export from `simple-git` no longer shows the deprecation notice for using the 332 `.then` function, it now exposes the promise chain generated from the most recently run 333 task, allowing the combination of chain building and ad-hoc splitting off to a new promise chain. 334 - See the [unit](./test/unit/promises.spec.js) and [integration](./test/integration/promise-from-root.spec.js) tests. 335 - See the [typescript consumer](./test/consumer/ts-default-from-root.spec.ts) test. 336 337 ##### TypeScript Importing 338 339 - Promise / async interface and TypeScript types all available from the `simple-git` import rather than needing 340 `simple-git/promise`, see examples in the [ReadMe](./readme.md) or in the [consumer tests](./test/consumer). 341 342 ##### Typed Errors 343 344 - Tasks that previously validated their usage and rejected with a `TypeError` will now reject with a 345 [`TaskConfigurationError`](./src/lib/errors/task-configuration-error.ts). 346 347 - Tasks that previously rejected with a custom object (currently only `git.merge` when the auto-merge fails) 348 will now reject with a [`GitResponseError`](./src/lib/errors/git-response-error.ts) where previously it 349 was a modified `Error`. 350 351 ##### Git Clean 352 353 - `git.clean(...)` will now return a `CleanSummary` instead of the raw string data 354 355 ##### Git Raw 356 357 - `git.raw(...)` now accepts any number of leading string arguments as an alternative to the 358 single array of strings. 359 360 ### [`v2.5.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​250---Gitremote) 361 362 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.4.0...v2.5.0) 363 364 - all `git.remote` related functions converted to TypeScript 365 366 ### [`v2.4.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​240---GitsubModule) 367 368 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.3.0...v2.4.0) 369 370 - all `git.subModule` related functions converted to TypeScript 371 372 ### [`v2.3.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​230---Gitconfig) 373 374 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.2.0...v2.3.0) 375 376 - add new `git.listConfig` to get current configuration 377 - `git.addConfig` supports a new `append` flag to append the value into the config rather than overwrite existing 378 379 ### [`v2.2.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​220---Gitbranch) 380 381 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.1.0...v2.2.0) 382 383 - all `git.branch` related functions converted to TypeScript 384 - add new `git.deleteLocalBranches` to delete multiple branches in one call 385 - `git.deleteLocalBranches` and `git.deleteLocalBranch` now support an optional `forceDelete` flag 386 387 ### [`v2.1.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​210---Gittag) 388 389 [Compare Source](https://togithub.com/steveukx/git-js/compare/v2.0.0...v2.1.0) 390 391 - `.tags`, `.addTag` and `.addAnnotatedTag` converted to TypeScript, no backward compatibility changes 392 393 ### [`v2.0.0`](https://togithub.com/steveukx/git-js/blob/master/CHANGELOG.md#​200---Incremental-switch-to-TypeScript-and-rewritten-task-execution) 394 395 [Compare Source](https://togithub.com/steveukx/git-js/compare/v1.132.0...v2.0.0) 396 397 - If your application depended on any functions with a name starting with an `_`, the upgrade may not be seamless, 398 please only use the documented public API. 399 400 - `git.log` date format is now strict ISO by default (ie: uses the placeholder `%aI`) instead of the 1.x default of 401 `%ai` for an "ISO-like" date format. To restore the old behaviour, add `strictDate = false` to the options passed to 402 `git.log`. 403 404 </details> 405 406 --- 407 408 ### Renovate configuration 409 410 :date: **Schedule**: At any time (no schedule defined). 411 412 :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. 413 414 :recycle: **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 415 416 :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. 417 418 --- 419 420 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box 421 422 --- 423 424 This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/MTRNord/freifunk-bot). 425