simple-git - npm Package Compare versions

Comparing version 3.19.1 to 3.20.0

dist/typings/response.d.ts

@@ -308,3 +308,5 @@ import { DefaultLogFields } from '../src/lib/tasks/log';
    /** Second digit of the status code of the file. Represents status of the working directory
-    if no merge conflicts, otherwise represents status of other side of a merge. */
+    if no merge conflicts, otherwise represents status of other side of a merge.
+    See https://git-scm.com/docs/git-status#_short_format for full documentation of possible
+    values and their meanings. */
    working_dir: string;
@@ -311,0 +313,0 @@ }

dist/typings/simple-git.d.ts

@@ -533,3 +533,3 @@ import * as resp from './response';
     * Calls the supplied `handle` function at the next step in the chain, used to run arbitrary functions synchronously
-    * before the next task in the git api.
+    * before the next task in the git API.
     */
@@ -536,0 +536,0 @@ exec(handle: () => void): Response<void>;

package.json

 {
   "name": "simple-git",
   "description": "Simple GIT interface for node.js",
-  "version": "3.19.1",
+  "version": "3.20.0",
   "author": "Steve King <[e-mail]>",
@@ -6,0 +6,0 @@ "contributors": [

readme.md

@@ -7,8 +7,2 @@ # Simple Git
 
-# Version 3 - Out Now
-
-From v3 of `simple-git` you can now import as an ES module, Common JS module or as TypeScript with bundled type
-definitions. Upgrading from v2 will be seamless for any application not relying on APIs that were marked as deprecated
-in v2 (deprecation notices were logged to `stdout` as `console.warn` in v2).
-
 # Installation
@@ -187,2 +181,8 @@
 
+# Upgrading from Version 2
+
+From v3 of `simple-git` you can now import as an ES module, Common JS module or as TypeScript with bundled type
+definitions. Upgrading from v2 will be seamless for any application not relying on APIs that were marked as deprecated
+in v2 (deprecation notices were logged to `stdout` as `console.warn` in v2).
+
 # API
@@ -383,3 +383,3 @@
 - `.show(options)` show various types of objects for example the file content at a certain commit. `options` is the single value string or any [options](#how-to-specify-options) supported by the [git show](https://git-scm.com/docs/git-show) command.
-- `.showBuffer(options)` same as the `.show` api, but returns the Buffer content directly to allow for showing binary file content.
+- `.showBuffer(options)` same as the `.show` API, but returns the Buffer content directly to allow for showing binary file content.
 
@@ -640,3 +640,3 @@ ## git status
 -  `git` isn't available as a binary for the user running the main `node` process, custom paths to the binary can be used
-   with the `.customBinary(...)` api option.
+   with the `.customBinary(...)` API option.
 
@@ -691,3 +691,3 @@ -  the working directory passed in to the main `simple-git` function isn't accessible, check it is read/write accessible
 
-If the `simple-git` api doesn't explicitly limit the scope of the task being run (ie: `git.add()` requires the files to
+If the `simple-git` API doesn't explicitly limit the scope of the task being run (ie: `git.add()` requires the files to
 be added, but `git.status()` will run against the entire repo), add a `pathspec` to the command using trailing options:
@@ -694,0 +694,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

878220

increased by0.06%

Lines of code

10696

increased by0.04%

No dependency changes