Require Node.js 12 and move to ESM (#14)

Author: jimmywarting

.github/workflows/main.yml

@@ -10,9 +10,9 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
+          - 16
           - 14
           - 12
-          - 10
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1

index.d.ts

@@ -1,41 +1,37 @@
-declare const pkgDir: {
-	/**
-	Synchronously find the root directory of a Node.js project or npm package.
-
-	@param cwd - Directory to start from. Default: `process.cwd()`.
-	@returns The project root path or `undefined` if it couldn't be found.
-	*/
-	sync: (cwd?: string) => string | undefined;
-
-	/**
-	Find the root directory of a Node.js project or npm package.
-
-	@param cwd - Directory to start from. Default: `process.cwd()`.
-	@returns The project root path or `undefined` if it couldn't be found.
-
-	@example
-	```
-	// /
-	// └── Users
-	//     └── sindresorhus
-	//         └── foo
-	//             ├── package.json
-	//             └── bar
-	//                 ├── baz
-	//                 └── example.js
-
-	// example.js
-	import pkgDir = require('pkg-dir');
-
-	(async () => {
-		const rootDir = await pkgDir(__dirname);
-
-		console.log(rootDir);
-		//=> '/Users/sindresorhus/foo'
-	})();
-	```
-	*/
-	(cwd?: string): Promise<string | undefined>;
-};
-
-export = pkgDir;
+/**
+Find the root directory of a Node.js project or npm package.
+
+@param cwd - Directory to start from. Default: `process.cwd()`.
+@returns The project root path or `undefined` if it couldn't be found.
+
+@example
+```
+// /
+// └── Users
+//     └── sindresorhus
+//         └── foo
+//             ├── package.json
+//             └── bar
+//                 ├── baz
+//                 └── example.js
+
+// example.js
+import pkgDir = require('pkg-dir');
+
+(async () => {
+	const rootDir = await pkgDir(__dirname);
+
+	console.log(rootDir);
+	//=> '/Users/sindresorhus/foo'
+})();
+```
+*/
+export function pkgDir(cwd: any): Promise<string>;
+
+/**
+Synchronously find the root directory of a Node.js project or npm package.
+
+@param cwd - Directory to start from. Default: `process.cwd()`.
+@returns The project root path or `undefined` if it couldn't be found.
+*/
+export function pkgDirSync(cwd: any): string;

index.js

@@ -1,15 +1,12 @@
-'use strict';
-const path = require('path');
-const findUp = require('find-up');
+import {dirname} from 'node:path';
+import {findUp, findUpSync} from 'find-up';
 
-const pkgDir = async cwd => {
+export async function pkgDir(cwd) {
 	const filePath = await findUp('package.json', {cwd});
-	return filePath && path.dirname(filePath);
-};
+	return filePath && dirname(filePath);
+}
 
-module.exports = pkgDir;
-
-module.exports.sync = cwd => {
-	const filePath = findUp.sync('package.json', {cwd});
-	return filePath && path.dirname(filePath);
-};
+export function pkgDirSync(cwd) {
+	const filePath = findUpSync('package.json', {cwd});
+	return filePath && dirname(filePath);
+}

index.test-d.ts

@@ -1,5 +1,5 @@
 import {expectType} from 'tsd';
-import pkgDir = require('.');
+import {pkgDir, pkgDirSync} from './index.js';
 
-expectType<Promise<string | undefined>>(pkgDir('/Users/project/pkg-dir'));
-expectType<string | undefined>(pkgDir.sync('/Users/project/pkg-dir'));
+expectType<Promise<string>>(pkgDir('/Users/project/pkg-dir'));
+expectType<string>(pkgDirSync('/Users/project/pkg-dir'));

package.json

@@ -9,8 +9,9 @@
 		"email": "sindresorhus@gmail.com",
 		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
 	"engines": {
-		"node": ">=10"
+		"node": ">=12"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -45,12 +46,12 @@
 		"path"
 	],
 	"dependencies": {
-		"find-up": "^5.0.0"
+		"find-up": "^6.1.0"
 	},
 	"devDependencies": {
-		"ava": "^2.4.0",
-		"tempy": "^1.0.0",
-		"tsd": "^0.13.1",
-		"xo": "^0.33.1"
+		"ava": "^3.15.0",
+		"tempy": "^2.0.0",
+		"tsd": "^0.17.0",
+		"xo": "^0.44.0"
 	}
 }

readme.md

@@ -23,7 +23,7 @@ $ npm install pkg-dir
 
 ```js
 // example.js
-const pkgDir = require('pkg-dir');
+import {pkgDir, pkgDirSync} from 'pkg-dir';
 
 (async () => {
 	const rootDir = await pkgDir(__dirname);
@@ -39,7 +39,7 @@ const pkgDir = require('pkg-dir');
 
 Returns a `Promise` for either the project root path or `undefined` if it couldn't be found.
 
-### pkgDir.sync(cwd?)
+### pkgDirSync(cwd?)
 
 Returns the project root path or `undefined` if it couldn't be found.
 

test.js

@@ -1,8 +1,11 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
 import test from 'ava';
 import tempy from 'tempy';
-import pkgDir from '.';
+import {pkgDir, pkgDirSync} from './index.js';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 // Create a disjoint directory, used for the not-found tests
 test.beforeEach(t => {
@@ -19,6 +22,6 @@ test('async', async t => {
 });
 
 test('sync', t => {
-	t.is(pkgDir.sync(path.join(__dirname, 'fixture')), __dirname);
-	t.is(pkgDir.sync(t.context.disjoint), undefined);
+	t.is(pkgDirSync(path.join(__dirname, 'fixture')), __dirname);
+	t.is(pkgDirSync(t.context.disjoint), undefined);
 });