@npmcli/git - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

package.json

 {
   "name": "@npmcli/git",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "main": "lib/index.js",
@@ -5,0 +5,0 @@ "files": [

README.md

@@ -113,3 +113,3 @@ # @npmcli/git
 
-### `git.is(path)` -> `Promise<Boolean>`
+### `git.is(opts)` -> `Promise<Boolean>`
 
@@ -123,3 +123,3 @@ Resolve to `true` if the path argument refers to the root of a git
 
-### `git.find(path)` -> `Promise<String | null>`
+### `git.find(opts)` -> `Promise<String | null>`
 
@@ -133,3 +133,3 @@ Given a path, walk up the file system tree until a git repo working
 
-### `git.isClean(path, opts = {})` -> `Promise<Boolean>`
+### `git.isClean(opts = {})` -> `Promise<Boolean>`
 
@@ -155,4 +155,7 @@ Return true if in a git dir, and that git dir is free of changes.  This
   for testing `win32` behavior on Unix, and vice versa.)
+- `cwd` The current working dir for the git command.  Particularly for
+  `find` and `is` and `isClean`, it's good to know that this defaults to
+  `process.cwd()`, as one might expect.
 - Any other options that can be passed to
   [`@npmcli/promise-spawn`](http://npm.im/@npmcli/promise-spawn), or
   `child_process.spawn()`.

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

20188

increased by0.89%

Number of lines in readme file

158

increased by1.94%

No dependency changes