simple-git - npm Package Compare versions

Comparing version 3.13.0 to 3.14.0

dist/src/lib/plugins/index.d.ts

@@ -0,1 +1,2 @@
+export * from './abort-plugin';
 export * from './command-config-prefixing-plugin';
@@ -2,0 +3,0 @@ export * from './completion-detection.plugin';

dist/src/lib/plugins/progress-monitor-plugin.d.ts

 import { SimpleGitOptions } from '../types';
 import { SimpleGitPlugin } from './simple-git-plugin';
-export declare function progressMonitorPlugin(progress: Exclude<SimpleGitOptions['progress'], void>): (SimpleGitPlugin<"spawn.args"> | SimpleGitPlugin<"spawn.after">)[];
+export declare function progressMonitorPlugin(progress: Exclude<SimpleGitOptions['progress'], void>): (SimpleGitPlugin<"spawn.after"> | SimpleGitPlugin<"spawn.args">)[];

dist/src/lib/plugins/simple-git-plugin.d.ts

@@ -17,2 +17,8 @@ /// <reference types="node" />
     };
+    'spawn.before': {
+        data: void;
+        context: SimpleGitTaskPluginContext & {
+            kill(reason: Error): void;
+        };
+    };
     'spawn.after': {
@@ -19,0 +25,0 @@ data: void;

dist/src/lib/runners/git-executor-chain.d.ts

@@ -25,2 +25,3 @@ import { PluginStore } from '../plugins';
     private gitResponse;
+    private _beforeSpawn;
 }

dist/src/lib/tasks/config.d.ts

@@ -1,2 +0,2 @@
-import { SimpleGit } from '../../../typings';
+import type { SimpleGit } from '../../../typings';
 export declare enum GitConfigScope {
@@ -3,0 +3,0 @@ system = "system",

dist/src/lib/types/index.d.ts

 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import type { SpawnOptions } from 'child_process';
@@ -53,2 +54,3 @@ import type { SimpleGitTask } from './tasks';
 export interface SimpleGitPluginConfig {
+    abort: AbortSignal;
     /**
@@ -55,0 +57,0 @@ * Configures the events that should be used to determine when the unederlying child process has

dist/src/lib/utils/exit-codes.d.ts

@@ -8,3 +8,4 @@ /**
     ERROR = 1,
+    NOT_FOUND = -2,
     UNCLEAN = 128
 }

dist/typings/simple-git.d.ts

@@ -998,2 +998,9 @@ import * as resp from './response';
    updateServerInfo(callback?: types.SimpleGitTaskCallback<string>): Response<string>;
+
+   /**
+    * Retrieves `git` version information, including whether `git` is installed on the `PATH`
+    */
+   version(
+      callback?: types.SimpleGitTaskCallback<types.VersionResult>
+   ): Response<types.VersionResult>;
 }

dist/typings/types.d.ts

@@ -1,5 +0,5 @@
-export { RemoteWithoutRefs, RemoteWithRefs } from '../src/lib/responses/GetRemoteSummary';
-export { LogOptions, DefaultLogFields } from '../src/lib/tasks/log';
+export type { RemoteWithoutRefs, RemoteWithRefs } from '../src/lib/responses/GetRemoteSummary';
+export type { LogOptions, DefaultLogFields } from '../src/lib/tasks/log';
 
-export {
+export type {
    outputHandler,
@@ -13,8 +13,9 @@ Options,
 
-export { ApplyOptions } from '../src/lib/tasks/apply-patch';
+export type { ApplyOptions } from '../src/lib/tasks/apply-patch';
 export { CheckRepoActions } from '../src/lib/tasks/check-is-repo';
 export { CleanOptions, CleanMode } from '../src/lib/tasks/clean';
-export { CloneOptions } from '../src/lib/tasks/clone';
+export type { CloneOptions } from '../src/lib/tasks/clone';
 export { GitConfigScope } from '../src/lib/tasks/config';
 export { GitGrepQuery, grepQueryBuilder } from '../src/lib/tasks/grep';
 export { ResetOptions, ResetMode } from '../src/lib/tasks/reset';
+export type { VersionResult } from '../src/lib/tasks/version';

package.json

 {
   "name": "simple-git",
   "description": "Simple GIT interface for node.js",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "author": "Steve King <[e-mail]>",
@@ -24,6 +24,6 @@ "contributors": [
     "@simple-git/babel-config": "^1.0.0",
-    "@simple-git/test-utils": "^1.0.0",
+    "@simple-git/test-utils": "^2.0.0",
     "@types/debug": "^4.1.5",
     "@types/jest": "^27.0.3",
-    "@types/node": "^14.14.10",
+    "@types/node": "^16",
     "esbuild": "^0.14.10",
@@ -30,0 +30,0 @@ "esbuild-node-externals": "^1.4.1",

readme.md

@@ -96,15 +96,18 @@ # Simple Git
 
--  [Completion Detection](https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-COMPLETION-DETECTION.md)
+- [AbortController](https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-ABORT-CONTROLLER.md)
+   Terminate pending and future tasks in a `simple-git` instance (requires node >= 16).
+
+- [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](https://github.com/steveukx/git-js/blob/main/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](https://github.com/steveukx/git-js/blob/main/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](https://github.com/steveukx/git-js/blob/main/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](https://github.com/steveukx/git-js/blob/main/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.
@@ -388,6 +391,10 @@
 
--  `.stash([ options ])` Stash the working directory, optional first argument can be an array of string arguments or [options](#how-to-specify-options) object to pass to the [git stash](https://git-scm.com/docs/git-stash) command.
+- `.stash([ options ])` Stash the working directory, optional first argument can be an array of string arguments or [options](#how-to-specify-options) object to pass to the [git stash](https://git-scm.com/docs/git-stash) command.
 
--  `.stashList([ options ])` Retrieves the stash list, optional first argument can be an object in the same format as used in [git log](#git-log).
+- `.stashList([ options ])` Retrieves the stash list, optional first argument can be an object in the same format as used in [git log](#git-log).
 
+## git version [examples](https://github.com/steveukx/git-js/blob/main/examples/git-version.md)
+
+- `.version()` retrieve the major, minor and patch for the currently installed `git`. Use the `.installed` property of the result to determine whether `git` is accessible on the path.
+
 ## changing the working directory [examples](https://github.com/steveukx/git-js/blob/main/examples/git-change-working-directory.md)
@@ -394,0 +401,0 @@

No alert changes

Improved metrics

Total package byte prevSize

850254

2.29%

Number of package files

103

1.98%

Lines of code

10356

2.37%

Number of lines in readme file

822

0.86%

No dependency changes