read-pkg-up - npm Package Compare versions

Comparing version 5.0.0 to 6.0.0

index.js

@@ -10,7 +10,7 @@ 'use strict';
 	if (!filePath) {
-		return {};
+		return;
 	}
 
 	return {
-		pkg: await readPkg({...options, cwd: path.dirname(filePath)}),
+		package: await readPkg({...options, cwd: path.dirname(filePath)}),
 		path: filePath
@@ -24,9 +24,9 @@ };
 	if (!filePath) {
-		return {};
+		return;
 	}
 
 	return {
-		pkg: readPkg.sync({...options, cwd: path.dirname(filePath)}),
+		package: readPkg.sync({...options, cwd: path.dirname(filePath)}),
 		path: filePath
 	};
 };

package.json

 {
 	"name": "read-pkg-up",
-	"version": "5.0.0",
+	"version": "6.0.0",
 	"description": "Read the closest package.json file",
@@ -16,6 +16,7 @@ "license": "MIT",
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
@@ -30,3 +31,2 @@ "keywords": [
 		"load",
-		"pkg",
 		"package",
@@ -46,3 +46,2 @@ "find",
 		"directory",
-		"dir",
 		"walk",
@@ -53,9 +52,11 @@ "walking",
 	"dependencies": {
-		"find-up": "^3.0.0",
-		"read-pkg": "^5.0.0"
+		"find-up": "^4.0.0",
+		"read-pkg": "^5.1.1",
+		"type-fest": "^0.5.0"
 	},
 	"devDependencies": {
-		"ava": "^1.3.1",
+		"ava": "^1.4.1",
+		"tsd": "^0.7.3",
 		"xo": "^0.24.0"
 	}
 }

readme.md

@@ -31,3 +31,3 @@ # read-pkg-up [![Build Status](https://travis-ci.org/sindresorhus/read-pkg-up.svg?branch=master)](https://travis-ci.org/sindresorhus/read-pkg-up)
 	{
-		pkg: {
+		package: {
 			name: 'awesome-package',
@@ -48,11 +48,11 @@ version: '1.0.0',
 
-Returns a `Promise` for the result object.
+Returns a `Promise<object>` or `Promise<undefined>` if no `package.json` was found.
 
 ### readPkgUp.sync([options])
 
-Returns the result object.
+Returns the result object or `undefined` if no `package.json` was found.
 
 #### options
 
-Type: `Object`
+Type: `object`
 
@@ -59,0 +59,0 @@ ##### cwd

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

6225

increased by44.1%

Number of package files

5

increased by25%

Lines of code

97

increased by304.17%

Worsened metrics

Dependency count

3

increased by50%

Dev dependency count

3

increased by50%

Dependency changes

• + Addedtype-fest@^0.5.0

• + Addedfind-up@4.1.0(transitive)

• + Addedlocate-path@5.0.0(transitive)

• + Addedp-locate@4.1.0(transitive)

• + Addedpath-exists@4.0.0(transitive)

• + Addedtype-fest@0.5.2(transitive)

• - Removedfind-up@3.0.0(transitive)

• - Removedlocate-path@3.0.0(transitive)

• - Removedp-locate@3.0.0(transitive)

• - Removedpath-exists@3.0.0(transitive)

• Updatedfind-up@^4.0.0

• Updatedread-pkg@^5.1.1