simple-git

Features

• move log task to separate task builder (0712f86)
• support scope argument in listConfig to return a specific scope's configuration (0685a8b)

2.41.2 (2021-07-29)

Bug Fixes

• use literal true and false in DiffResultTextFile | DiffResultBinaryFile to aid type assertions. (8059099)

2.41.1 (2021-07-11)

Bug Fixes

• Commit parsing should cater for file names with square brackets (ae81134)

Features

• allow setting the scope of git config add to work on the local, global or system configuration. (c7164e7)
• allow setting the scope of git config add to work on the local, global or system configuration. (00ada06)

Features

• create the spawnOptions plugin to allow setting uid / gid owner for the spawned git child processes. (cc70220)

2.39.1 (2021-06-09)

Bug Fixes

• add types and tests for the documented .exec API (#631) (c9207da)
• add types and tests for the documented .exec API (c9207da)
• updates the documentation for mergeFromTo to more closely represent its functionality (see #50 for the original requirement). (dd2244e)

Features

• git.cwd can now be configured to affect just the chain rather than root instance. (4110662)

2.38.1 (2021-05-09)

Bug Fixes

• Export GitPluginError from the main package. (2aa7e55), closes #616

Features

• Support enabling / disabling debug logs programmatically. (#610) (c901b9c)

Features

• errorDetectionPlugin to handle creating error messages when tasks fail. (c65a419)

2.36.2 (2021-03-11)

Bug Fixes

• Export missing SimpleGitProgressEvent (038870e), closes #601

2.36.1 (2021-03-06)

Bug Fixes

• Documentation update for outputHandler (775d81e)
• Support parsing git.branch where branches have carriage returns in the commit detail. (5b71012)

Features

• Timeout Plugin (59f3d98)

Bug Fixes

• Fix broken link in no-response auto-generated comment (16fe73f)

2.35.2 (2021-02-23)

Bug Fixes

• Progress plugin should request progress events for fetch as well as other common long running tasks. (ea68857)
• upgrade debug from 4.3.1 to 4.3.2 (4b6eda8)
• 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), closes #586

2.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), closes #580

Features

• Progress Handler (5508bd4)

2.34.2 (2021-02-07)

Bug Fixes

• fix npm publish token definition (fb066c3)

2.34.1 (2021-02-07)

Bug Fixes

• auto-release with release-please (0ed2d96)

• 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

• 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).

• Reinstates native support for node.js v10 by removing use of ES6 constructs

• Update type definition for git.mergeFromTo to be the MergeResult returned when using the more generic git.merge method. Thanks to @ofirelias for the pull request.

• 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 for the pull request.

• Integration tests converted to TypeScript to ensure type safety across all tests.

• 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.

• See Legacy Node Versions 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.

• pull, push and pushTags parameter types updated to match new functionality and tests switched to TypeScript to ensure they are kept in sync

• Upgrade debug dependency and remove use of now deprecated debug().destroy()
• Renames the default source branch from master to main

• Adds support for git hash-object FILE and git hash-object -w FILE with new interface git.hashObject(...), with thanks to @MiOnim

• Adds string[] to the set of types supported as options for git.log
• Fix readme typos

• LogOptions should be intersection rather than union types

• move the command/task option processing function to TypeScript

• 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.

• git.mv rewritten to fit the TypeScript tasks style.
• set up github actions for CI

• 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

• resolves an issue whereby the git.checkoutBranch method would not pass the branch detail through to the underlying child process.

• 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).

• Further to 2.13.0 adding support for parsing the reponse to git.push, adds support for the pull request message used by gitlab.

• .push and .pushTags rewritten as v2 style tasks. The git response is now parsed and returned as a PushResult

• Pull and merge rewritten to fit the TypeScript tasks style.

• Integration tests updated to run through jest directly without compiling from nodeunit

• git.checkout now supports both object and array forms of supplying trailing options.

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;

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.

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.

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.

expect(simpleGit().then).toBeUndefined();
expect(simpleGit().init().then).toBe(expect.any(Function));

• .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

• 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.

• Updated to the outputHandler type to add a trailing argument for the arguments passed into the child process.
• All logging now uses the 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').

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 and integration tests.
  • See the typescript consumer 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 or in the consumer tests.

Typed Errors

• Tasks that previously validated their usage and rejected with a TypeError will now reject with a TaskConfigurationError.

• Tasks that previously rejected with a custom object (currently only git.merge when the auto-merge fails) will now reject with a GitResponseError 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.

• all git.remote related functions converted to TypeScript

• all git.subModule related functions converted to TypeScript

• 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

• 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

• .tags, .addTag and .addAnnotatedTag converted to TypeScript, no backward compatibility changes

Major Changes

• 98864c6: Updates ahead of the v4 release for simple-git.

  • Adds support for TypeScript declaration maps

  • Exports the isGitEnvKey helper to detect whether an environment variable can be used to configure a git operation

  • Adds detection for includeIf.<condition>.path, thanks to @NotAFlightRisk for identifying the vulnerability

Patch Changes

• c427fba: Additional argument parser vulnerability checks:

  • Thanks to @mrillicit for identifying include.path, filter.*.process
  • Thanks to @tejas619 for identifying url.*.insteadOf

• 1bb14df: Vulnerability detection expanded to include pager.*, uploadpack.packObjectsHook, difftool.*.cmd and use of the GIT_CONFIG_PARAMETERS environment variable

  Thanks to @threalwinky and @nuc13us for identifying.

• dfeb116: Vulnerability detection expanded to cover configuration delivered through path-taking global options, where
  the dangerous value is a file on disk rather than a token simple-git can inspect:

  • --exec-path names the directory git loads built-in commands and remote helpers from, and is blocked
    under the new allowUnsafeExec category along with the GIT_EXEC_PATH environment variable (previously
    grouped under allowUnsafeConfigPaths)
  • --git-dir, --work-tree and -C cause git to read the configuration of the repository they name, and
    are blocked under allowUnsafeConfigPaths

  These options are only detected when supplied before the git sub-command and with a value - used as getters
  (git.raw('rev-parse', '--git-dir')) or as task options (git.raw('commit', '-C', 'HEAD~1')) they are
  unaffected.

• d762810: Add allowUnsafeExec detection to rebase -x and rebase --exec.

  Thanks to @gdegrange for the vulnerability report.

• d762810: Add allowUnsafeCommandBinaries detection to configuring trailer.<token>.cmd and trailer.<token>.command.

  Thanks to @sec-reex for the vulnerability report.

• Updated dependencies [98864c6]

  • @simple-git/args-pathspec@1.0.4