Rename .package to .packageJson

Since `package` is a reserved keyword, it meant that the result could previously not be easily destructured. Fixes #11
sindresorhus · Sep 27, 2019 · 8140c73 · 8140c73
1 parent 9ecaa3e
commit 8140c73
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -24,12 +24,12 @@ declare namespace readPkgUp {
 	type NormalizedPackageJson = readPkg.NormalizedPackageJson;
 
 	interface ReadResult {
-		package: PackageJson;
+		packageJson: PackageJson;
 		path: string;
 	}
 
 	interface NormalizedReadResult {
-		package: NormalizedPackageJson;
+		packageJson: NormalizedPackageJson;
 		path: string;
 	}
 }
@@ -45,7 +45,7 @@ declare const readPkgUp: {
 	(async () => {
 		console.log(await readPkgUp());
 		// {
-		// 	package: {
+		// 	packageJson: {
 		// 		name: 'awesome-package',
 		// 		version: '1.0.0',
 		// 		…
@@ -69,7 +69,7 @@ declare const readPkgUp: {
 
 	console.log(readPkgUp.sync());
 	// {
-	// 	package: {
+	// 	packageJson: {
 	// 		name: 'awesome-package',
 	// 		version: '1.0.0',
 	// 		…

diff --git a/index.js b/index.js
@@ -11,7 +11,7 @@ module.exports = async options => {
 	}
 
 	return {
-		package: await readPkg({...options, cwd: path.dirname(filePath)}),
+		packageJson: await readPkg({...options, cwd: path.dirname(filePath)}),
 		path: filePath
 	};
 };
@@ -24,7 +24,7 @@ module.exports.sync = options => {
 	}
 
 	return {
-		package: readPkg.sync({...options, cwd: path.dirname(filePath)}),
+		packageJson: readPkg.sync({...options, cwd: path.dirname(filePath)}),
 		path: filePath
 	};
 };
diff --git a/readme.md b/readme.md
@@ -28,7 +28,7 @@ const readPkgUp = require('read-pkg-up');
 	console.log(await readPkgUp());
 	/*
 	{
-		package: {
+		packageJson: {
 			name: 'awesome-package',
 			version: '1.0.0',
 			…

diff --git a/test.js b/test.js
@@ -7,15 +7,15 @@ const packagePath = path.resolve('.', 'package.json');
 
 test('async', async t => {
 	const result = await readPackageUp({cwd});
-	t.is(result.package.name, 'read-pkg-up');
+	t.is(result.packageJson.name, 'read-pkg-up');
 	t.is(result.path, packagePath);
 
 	t.is(await readPackageUp({cwd: '/'}), undefined);
 });
 
 test('sync', t => {
 	const result = readPackageUp.sync({cwd});
-	t.is(result.package.name, 'read-pkg-up');
+	t.is(result.packageJson.name, 'read-pkg-up');
 	t.is(result.path, packagePath);
 
 	t.is(readPackageUp.sync({cwd: '/'}), undefined);