.github/funding.yml

@@ -0,0 +1,4 @@
+github: sindresorhus
+open_collective: sindresorhus
+tidelift: npm/read-pkg-up
+custom: https://sindresorhus.com/donate

.github/security.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.

.github/workflows/main.yml

@@ -0,0 +1,21 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Node.js ${{ matrix.node-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 14
+          - 12
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test

index.d.ts

@@ -0,0 +1,77 @@
+import {Except} from 'type-fest';
+import {readPackageAsync, readPackageSync, Options as ReadPackageOptions, NormalizeOptions as ReadPackageNormalizeOptions, PackageJson, NormalizedPackageJson} from 'read-pkg';
+
+export type Options = {
+	/**
+	Directory to start looking for a package.json file.
+
+	@default process.cwd()
+	*/
+	cwd?: string;
+} & Except<ReadPackageOptions, 'cwd'>;
+
+export type NormalizeOptions = {
+	/**
+	Directory to start looking for a package.json file.
+
+	@default process.cwd()
+	*/
+	cwd?: string;
+} & Except<ReadPackageNormalizeOptions, 'cwd'>;
+
+export interface ReadResult {
+	packageJson: PackageJson;
+	path: string;
+}
+
+export interface NormalizedReadResult {
+	packageJson: NormalizedPackageJson;
+	path: string;
+}
+
+export {
+	PackageJson,
+	NormalizedPackageJson
+};
+
+/**
+Read the closest `package.json` file.
+
+@example
+```
+import {readPackageUpAsync} from 'read-pkg-up';
+
+console.log(await readPackageUpAsync());
+// {
+// 	packageJson: {
+// 		name: 'awesome-package',
+// 		version: '1.0.0',
+// 		…
+// 	},
+// 	path: '/Users/sindresorhus/dev/awesome-package/package.json'
+// }
+```
+*/
+export function readPackageUpAsync(options?: NormalizeOptions): Promise<NormalizedReadResult | undefined>;
+export function readPackageUpAsync(options: Options): Promise<ReadResult | undefined>;
+
+/**
+Synchronously read the closest `package.json` file.
+
+@example
+```
+import {readPackageUpSync} from 'read-pkg-up';
+
+console.log(readPackageUpSync());
+// {
+// 	packageJson: {
+// 		name: 'awesome-package',
+// 		version: '1.0.0',
+// 		…
+// 	},
+// 	path: '/Users/sindresorhus/dev/awesome-package/package.json'
+// }
+```
+*/
+export function readPackageUpSync(options?: NormalizeOptions): NormalizedReadResult | undefined;
+export function readPackageUpSync(options: Options): ReadResult | undefined;

index.js

@@ -1,26 +1,27 @@
-'use strict';
-const findUp = require('find-up');
-const readPkg = require('read-pkg');
+import path from 'path';
+import findUp from 'find-up';
+import {readPackageAsync, readPackageSync} from 'read-pkg';
 
-module.exports = options => {
-	return findUp('package.json', options).then(fp => {
-		if (!fp) {
-			return {};
-		}
-
-		return readPkg(fp, options).then(pkg => ({pkg, path: fp}));
-	});
-};
+export async function readPackageUpAsync(options) {
+	const filePath = await findUp('package.json', options);
+	if (!filePath) {
+		return;
+	}
 
-module.exports.sync = options => {
-	const fp = findUp.sync('package.json', options);
+	return {
+		packageJson: await readPackageAsync({...options, cwd: path.dirname(filePath)}),
+		path: filePath
+	};
+}
 
-	if (!fp) {
-		return {};
+export function readPackageUpSync(options) {
+	const filePath = findUp.sync('package.json', options);
+	if (!filePath) {
+		return;
 	}
 
 	return {
-		pkg: readPkg.sync(fp, options),
-		path: fp
+		packageJson: readPackageSync({...options, cwd: path.dirname(filePath)}),
+		path: filePath
 	};
-};
+}

index.test-d.ts

@@ -0,0 +1,36 @@
+import {expectType, expectError} from 'tsd';
+import {readPackageUpAsync, readPackageUpSync, ReadResult, NormalizedReadResult} from './index.js';
+
+expectType<Promise<NormalizedReadResult | undefined>>(readPackageUpAsync());
+expectType<Promise<NormalizedReadResult | undefined>>(
+	readPackageUpAsync({cwd: '.'})
+);
+expectType<Promise<NormalizedReadResult | undefined>>(
+	readPackageUpAsync({normalize: true})
+);
+expectType<Promise<NormalizedReadResult | undefined>>(
+	readPackageUpAsync({cwd: '.', normalize: true})
+);
+expectType<Promise<ReadResult | undefined>>(
+	readPackageUpAsync({normalize: false})
+);
+expectError<Promise<NormalizedReadResult | undefined>>(
+	readPackageUpAsync({normalize: false})
+);
+
+expectType<NormalizedReadResult | undefined>(readPackageUpSync());
+expectType<NormalizedReadResult | undefined>(
+	readPackageUpSync({cwd: '.'})
+);
+expectType<NormalizedReadResult | undefined>(
+	readPackageUpSync({normalize: true})
+);
+expectType<NormalizedReadResult | undefined>(
+	readPackageUpSync({cwd: '.', normalize: true})
+);
+expectType<ReadResult | undefined>(
+	readPackageUpSync({normalize: false})
+);
+expectError<NormalizedReadResult | undefined>(
+	readPackageUpSync({normalize: false})
+);

license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package.json

@@ -1,22 +1,26 @@
 {
 	"name": "read-pkg-up",
-	"version": "4.0.0",
+	"version": "8.0.0",
 	"description": "Read the closest package.json file",
 	"license": "MIT",
 	"repository": "sindresorhus/read-pkg-up",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
+	"exports": "./index.js",
 	"engines": {
-		"node": ">=6"
+		"node": ">=12"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"json",
@@ -26,7 +30,6 @@
 		"fs",
 		"graceful",
 		"load",
-		"pkg",
 		"package",
 		"find",
 		"up",
@@ -41,17 +44,18 @@
 		"parents",
 		"folder",
 		"directory",
-		"dir",
 		"walk",
 		"walking",
 		"path"
 	],
 	"dependencies": {
-		"find-up": "^3.0.0",
-		"read-pkg": "^3.0.0"
+		"find-up": "^5.0.0",
+		"read-pkg": "^6.0.0",
+		"type-fest": "^1.0.1"
 	},
 	"devDependencies": {
-		"ava": "*",
-		"xo": "*"
+		"ava": "^3.15.0",
+		"tsd": "^0.14.0",
+		"xo": "^0.38.2"
 	}
 }

readme.md

@@ -1,82 +1,74 @@
-# read-pkg-up [![Build Status](https://travis-ci.org/sindresorhus/read-pkg-up.svg?branch=master)](https://travis-ci.org/sindresorhus/read-pkg-up)
+# read-pkg-up
 
 > Read the closest package.json file
 
-
 ## Why
 
 - [Finds the closest package.json](https://github.com/sindresorhus/find-up)
-- [Gracefully handles filesystem issues](https://github.com/isaacs/node-graceful-fs)
-- [Strips UTF-8 BOM](https://github.com/sindresorhus/strip-bom)
 - [Throws more helpful JSON errors](https://github.com/sindresorhus/parse-json)
 - [Normalizes the data](https://github.com/npm/normalize-package-data#what-normalization-currently-entails)
 
-
 ## Install
 
 ```
 $ npm install read-pkg-up
 ```
 
-
 ## Usage
 
 ```js
-const readPkgUp = require('read-pkg-up');
-
-(async () => {
-	console.log(await readPkgUp());
-	/*
-	{
-		pkg: {
-			name: 'awesome-package',
-			version: '1.0.0',
-			…
-		},
-		path: '/Users/sindresorhus/dev/awesome-package/package.json'
-	}
-	*/
-})();
+import {readPackageUpAsync} from 'read-pkg-up';
+
+console.log(await readPackageUpAsync());
+/*
+{
+	packageJson: {
+		name: 'awesome-package',
+		version: '1.0.0',
+		…
+	},
+	path: '/Users/sindresorhus/dev/awesome-package/package.json'
+}
+*/
 ```
 
-
 ## API
 
-### readPkgUp([options])
+### readPackageUpAsync(options?)
 
-Returns a `Promise` for the result object.
+Returns a `Promise<object>` or `Promise<undefined>` if no `package.json` was found.
 
-### readPkgUp.sync([options])
+### readPackageUpSync(options?)
 
-Returns the result object.
+Returns the result object or `undefined` if no `package.json` was found.
 
 #### options
 
-Type: `Object`
+Type: `object`
 
 ##### cwd
 
-Type: `string`<br>
+Type: `string`\
 Default: `process.cwd()`
 
 Directory to start looking for a package.json file.
 
 ##### normalize
 
-Type: `boolean`<br>
+Type: `boolean`\
 Default: `true`
 
 [Normalize](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data.
 
+## read-pkg-up for enterprise
+
+Available as part of the Tidelift Subscription.
+
+The maintainers of read-pkg-up and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-read-pkg-up?utm_source=npm-read-pkg-up&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
 
 ## Related
 
 - [read-pkg](https://github.com/sindresorhus/read-pkg) - Read a package.json file
 - [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
 - [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories
 - [pkg-conf](https://github.com/sindresorhus/pkg-conf) - Get namespaced config from the closest package.json
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)