simple-git - npm Package Compare versions

Comparing version 3.9.0 to 3.10.0

dist/src/lib/args/log-format.d.ts

@@ -8,3 +8,3 @@ export declare enum LogFormat {
 }
-export declare function logFormatFromCommand(customArgs: string[]): LogFormat.NONE | LogFormat;
+export declare function logFormatFromCommand(customArgs: string[]): LogFormat;
 export declare function isLogFormat(customArg: string | unknown): boolean;

dist/src/lib/errors/git-error.d.ts

@@ -0,1 +1,2 @@
+import type { SimpleGitTask } from '../types';
 /**
@@ -27,4 +28,4 @@ * The `GitError` is thrown when the underlying `git` process throws a
 export declare class GitError extends Error {
-    task?: import("../tasks/task").EmptyTask | import("../types").StringTask<any> | import("../types").BufferTask<any> | undefined;
-    constructor(task?: import("../tasks/task").EmptyTask | import("../types").StringTask<any> | import("../types").BufferTask<any> | undefined, message?: string);
+    task?: SimpleGitTask<any> | undefined;
+    constructor(task?: SimpleGitTask<any> | undefined, message?: string);
 }

dist/src/lib/errors/git-plugin-error.d.ts

@@ -0,6 +1,7 @@
+import { SimpleGitOptions, SimpleGitTask } from '../types';
 import { GitError } from './git-error';
 export declare class GitPluginError extends GitError {
-    task?: import("../tasks/task").EmptyTask | import("../types").StringTask<any> | import("../types").BufferTask<any> | undefined;
-    readonly plugin?: "progress" | "timeout" | "completion" | "errors" | "spawnOptions" | "baseDir" | "binary" | "maxConcurrentProcesses" | "config" | undefined;
-    constructor(task?: import("../tasks/task").EmptyTask | import("../types").StringTask<any> | import("../types").BufferTask<any> | undefined, plugin?: "progress" | "timeout" | "completion" | "errors" | "spawnOptions" | "baseDir" | "binary" | "maxConcurrentProcesses" | "config" | undefined, message?: string);
+    task?: SimpleGitTask<any> | undefined;
+    readonly plugin?: keyof SimpleGitOptions | undefined;
+    constructor(task?: SimpleGitTask<any> | undefined, plugin?: keyof SimpleGitOptions | undefined, message?: string);
 }

dist/src/lib/git-factory.d.ts

@@ -14,3 +14,3 @@ import { SimpleGitFactory } from '../../typings';
 };
-export declare function gitExportFactory<T = {}>(factory: SimpleGitFactory, extra: T): ((options: Partial<SimpleGitOptions>) => import("../../typings").SimpleGit) & typeof api;
+export declare function gitExportFactory(factory: SimpleGitFactory): SimpleGitFactory & typeof api;
 export declare function gitInstanceFactory(baseDir?: string | Partial<SimpleGitOptions>, options?: Partial<SimpleGitOptions>): any;

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

 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
 import type { SpawnOptions } from 'child_process';
@@ -3,0 +5,0 @@ import type { SimpleGitTask } from './tasks';

dist/typings/index.d.ts

@@ -10,3 +10,4 @@ import { SimpleGitFactory } from './simple-git';
 
-declare const simpleGit: SimpleGitFactory;
+export declare const simpleGit: SimpleGitFactory;
+
 export default simpleGit;

package.json

 {
   "name": "simple-git",
   "description": "Simple GIT interface for node.js",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "author": "Steve King <[e-mail]>",
@@ -14,3 +14,3 @@ "contributors": [
     "type": "github",
-    "url": "https://github.com/sponsors/steveukx/"
+    "url": "https://github.com/steveukx/git-js?sponsor=1"
   },
@@ -17,0 +17,0 @@ "dependencies": {

readme.md

@@ -33,3 +33,3 @@ # Simple Git
 // or use named properties
-const {default: simpleGit, CleanOptions} = require('simple-git');
+const {simpleGit, CleanOptions} = require('simple-git');
 simpleGit().clean(CleanOptions.FORCE);
@@ -41,3 +41,3 @@ ```
 ```javascript
-import simpleGit, { CleanOptions } from 'simple-git';
+import { simpleGit, CleanOptions } from 'simple-git';
 
@@ -50,3 +50,3 @@ simpleGit().clean(CleanOptions.FORCE);
 ```typescript
-import simpleGit, { SimpleGit, CleanOptions } from 'simple-git';
+import { simpleGit, SimpleGit, CleanOptions } from 'simple-git';
 
@@ -61,3 +61,3 @@ const git: SimpleGit = simpleGit().clean(CleanOptions.FORCE);
 ```typescript
-import simpleGit, { SimpleGit, SimpleGitOptions } from 'simple-git';
+import { simpleGit, SimpleGit, SimpleGitOptions } from 'simple-git';
 
@@ -587,3 +587,3 @@ const options: Partial<SimpleGitOptions> = {
 ```typescript
-import simpleGit, { MergeSummary, GitResponseError } from 'simple-git';
+import { simpleGit, MergeSummary, GitResponseError } from 'simple-git';
 try {
@@ -590,0 +590,0 @@ const mergeSummary = await simpleGit().merge();

No alert changes

Improved metrics

Lines of code

9739

0.04%

Published versions last months

1

Infinity%

Worsened metrics

Total package byte prevSize

814163

-0.14%

No dependency changes