Rename pkg property to package, return undefined instead of empty object, add TypeScript definition (#10)

Author: BendingBender

index.d.ts

@@ -0,0 +1,87 @@
+import {Omit} from 'type-fest';
+import readPkg = require('read-pkg');
+
+declare namespace readPkgUp {
+	type Options = {
+		/**
+		Directory to start looking for a package.json file.
+
+		@default process.cwd()
+		*/
+		cwd?: string;
+	} & Omit<readPkg.Options, 'cwd'>;
+
+	type NormalizeOptions = {
+		/**
+		Directory to start looking for a package.json file.
+
+		@default process.cwd()
+		*/
+		cwd?: string;
+	} & Omit<readPkg.NormalizeOptions, 'cwd'>;
+
+	type PackageJson = readPkg.PackageJson;
+	type NormalizedPackageJson = readPkg.NormalizedPackageJson;
+
+	interface ReadResult {
+		package: PackageJson;
+		path: string;
+	}
+
+	interface NormalizedReadResult {
+		package: NormalizedPackageJson;
+		path: string;
+	}
+}
+
+declare const readPkgUp: {
+	/**
+	Read the closest `package.json` file.
+
+	@example
+	```
+	import readPkgUp = require('read-pkg-up');
+
+	(async () => {
+		console.log(await readPkgUp());
+		// {
+		// 	package: {
+		// 		name: 'awesome-package',
+		// 		version: '1.0.0',
+		// 		…
+		// 	},
+		// 	path: '/Users/sindresorhus/dev/awesome-package/package.json'
+		// }
+	})();
+	```
+	*/
+	(options?: readPkgUp.NormalizeOptions): Promise<
+		readPkgUp.NormalizedReadResult | undefined
+	>;
+	(options: readPkgUp.Options): Promise<readPkgUp.ReadResult | undefined>;
+
+	/**
+	Synchronously read the closest `package.json` file.
+
+	@example
+	```
+	import readPkgUp = require('read-pkg-up');
+
+	console.log(readPkgUp.sync());
+	// {
+	// 	package: {
+	// 		name: 'awesome-package',
+	// 		version: '1.0.0',
+	// 		…
+	// 	},
+	// 	path: '/Users/sindresorhus/dev/awesome-package/package.json'
+	// }
+	```
+	*/
+	sync(
+		options?: readPkgUp.NormalizeOptions
+	): readPkgUp.NormalizedReadResult | undefined;
+	sync(options: readPkgUp.Options): readPkgUp.ReadResult | undefined;
+};
+
+export = readPkgUp;

index.js

@@ -7,11 +7,11 @@ module.exports = async options => {
 	const filePath = await findUp('package.json', options);
 
 	if (!filePath) {
-		return {};
+		return;
 	}
 
 	return {
-		pkg: await readPkg({...options, cwd: path.dirname(filePath)}),
+		package: await readPkg({...options, cwd: path.dirname(filePath)}),
 		path: filePath
 	};
 };
@@ -20,11 +20,11 @@ module.exports.sync = options => {
 	const filePath = findUp.sync('package.json', options);
 
 	if (!filePath) {
-		return {};
+		return;
 	}
 
 	return {
-		pkg: readPkg.sync({...options, cwd: path.dirname(filePath)}),
+		package: readPkg.sync({...options, cwd: path.dirname(filePath)}),
 		path: filePath
 	};
 };

index.test-d.ts

@@ -0,0 +1,36 @@
+import {expectType, expectError} from 'tsd';
+import readPkgUp = require('.');
+
+expectType<Promise<readPkgUp.NormalizedReadResult | undefined>>(readPkgUp());
+expectType<Promise<readPkgUp.NormalizedReadResult | undefined>>(
+	readPkgUp({cwd: '.'})
+);
+expectType<Promise<readPkgUp.NormalizedReadResult | undefined>>(
+	readPkgUp({normalize: true})
+);
+expectType<Promise<readPkgUp.NormalizedReadResult | undefined>>(
+	readPkgUp({cwd: '.', normalize: true})
+);
+expectType<Promise<readPkgUp.ReadResult | undefined>>(
+	readPkgUp({normalize: false})
+);
+expectError<Promise<readPkgUp.NormalizedReadResult | undefined>>(
+	readPkgUp({normalize: false})
+);
+
+expectType<readPkgUp.NormalizedReadResult | undefined>(readPkgUp.sync());
+expectType<readPkgUp.NormalizedReadResult | undefined>(
+	readPkgUp.sync({cwd: '.'})
+);
+expectType<readPkgUp.NormalizedReadResult | undefined>(
+	readPkgUp.sync({normalize: true})
+);
+expectType<readPkgUp.NormalizedReadResult | undefined>(
+	readPkgUp.sync({cwd: '.', normalize: true})
+);
+expectType<readPkgUp.ReadResult | undefined>(
+	readPkgUp.sync({normalize: false})
+);
+expectError<readPkgUp.NormalizedReadResult | undefined>(
+	readPkgUp.sync({normalize: false})
+);

package.json

@@ -13,10 +13,11 @@
 		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"json",
@@ -26,7 +27,6 @@
 		"fs",
 		"graceful",
 		"load",
-		"pkg",
 		"package",
 		"find",
 		"up",
@@ -41,17 +41,18 @@
 		"parents",
 		"folder",
 		"directory",
-		"dir",
 		"walk",
 		"walking",
 		"path"
 	],
 	"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

@@ -28,7 +28,7 @@ const readPkgUp = require('read-pkg-up');
 	console.log(await readPkgUp());
 	/*
 	{
-		pkg: {
+		package: {
 			name: 'awesome-package',
 			version: '1.0.0',
 			…
@@ -44,15 +44,15 @@ const readPkgUp = require('read-pkg-up');
 
 ### readPkgUp([options])
 
-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`
 
 ##### cwd
 

test.js

@@ -1,26 +1,22 @@
 import path from 'path';
 import test from 'ava';
-import readPkgUp from '.';
+import readPackageUp from '.';
 
 const cwd = 'fixture';
-const pkgPath = path.resolve('.', 'package.json');
+const packagePath = path.resolve('.', 'package.json');
 
 test('async', async t => {
-	const result = await readPkgUp({cwd});
-	t.is(result.pkg.name, 'read-pkg-up');
-	t.is(result.path, pkgPath);
+	const result = await readPackageUp({cwd});
+	t.is(result.package.name, 'read-pkg-up');
+	t.is(result.path, packagePath);
 
-	const result2 = await readPkgUp({cwd: '/'});
-	t.is(result2.pkg, undefined);
-	t.is(result2.path, undefined);
+	t.is(await readPackageUp({cwd: '/'}), undefined);
 });
 
 test('sync', t => {
-	const result = readPkgUp.sync({cwd});
-	t.is(result.pkg.name, 'read-pkg-up');
-	t.is(result.path, pkgPath);
+	const result = readPackageUp.sync({cwd});
+	t.is(result.package.name, 'read-pkg-up');
+	t.is(result.path, packagePath);
 
-	const result2 = readPkgUp.sync({cwd: '/'});
-	t.is(result2.pkg, undefined);
-	t.is(result2.path, undefined);
+	t.is(readPackageUp.sync({cwd: '/'}), undefined);
 });