Accept URL as cwd (#19)

sindresorhus · Feb 8, 2022 · 840607e · 840607e
1 parent 85144a6
commit 840607e
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 5 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -7,7 +7,7 @@ export type Options = {
 
 	@default process.cwd()
 	*/
-	cwd?: string;
+	cwd?: URL | string;
 } & Except<ReadPackageOptions, 'cwd'>;
 
 export type NormalizeOptions = {
@@ -16,7 +16,7 @@ export type NormalizeOptions = {
 
 	@default process.cwd()
 	*/
-	cwd?: string;
+	cwd?: URL | string;
 } & Except<ReadPackageNormalizeOptions, 'cwd'>;
 
 export interface ReadResult {

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -5,12 +5,18 @@ expectType<Promise<NormalizedReadResult | undefined>>(readPackageUp());
 expectType<Promise<NormalizedReadResult | undefined>>(
 	readPackageUp({cwd: '.'}),
 );
+expectType<Promise<NormalizedReadResult | undefined>>(
+	readPackageUp({cwd: new URL('file:///path/to/cwd/')}),
+);
 expectType<Promise<NormalizedReadResult | undefined>>(
 	readPackageUp({normalize: true}),
 );
 expectType<Promise<NormalizedReadResult | undefined>>(
 	readPackageUp({cwd: '.', normalize: true}),
 );
+expectType<Promise<NormalizedReadResult | undefined>>(
+	readPackageUp({cwd: new URL('file:///path/to/cwd/'), normalize: true}),
+);
 expectType<Promise<ReadResult | undefined>>(
 	readPackageUp({normalize: false}),
 );
@@ -22,12 +28,18 @@ expectType<NormalizedReadResult | undefined>(readPackageUpSync());
 expectType<NormalizedReadResult | undefined>(
 	readPackageUpSync({cwd: '.'}),
 );
+expectType<NormalizedReadResult | undefined>(
+	readPackageUpSync({cwd: new URL('file:///path/to/cwd/')}),
+);
 expectType<NormalizedReadResult | undefined>(
 	readPackageUpSync({normalize: true}),
 );
 expectType<NormalizedReadResult | undefined>(
 	readPackageUpSync({cwd: '.', normalize: true}),
 );
+expectType<NormalizedReadResult | undefined>(
+	readPackageUpSync({cwd: new URL('file:///path/to/cwd/'), normalize: true}),
+);
 expectType<ReadResult | undefined>(
 	readPackageUpSync({normalize: false}),
 );

diff --git a/package.json b/package.json
@@ -49,8 +49,8 @@
 		"path"
 	],
 	"dependencies": {
-		"find-up": "^6.2.0",
-		"read-pkg": "^7.0.0",
+		"find-up": "^6.3.0",
+		"read-pkg": "^7.1.0",
 		"type-fest": "^2.5.0"
 	},
 	"devDependencies": {

diff --git a/readme.md b/readme.md
@@ -48,7 +48,7 @@ Type: `object`
 
 ##### cwd
 
-Type: `string`\
+Type: `URL | string`\
 Default: `process.cwd()`
 
 The directory to start looking for a package.json file.

diff --git a/test.js b/test.js
@@ -9,6 +9,10 @@ test('async', async t => {
 	const result = await readPackageUp({cwd});
 	t.is(result.packageJson.name, 'read-pkg-up');
 	t.is(result.path, packagePath);
+	t.deepEqual(
+		await readPackageUp({cwd: new URL(cwd, import.meta.url)}),
+		result,
+	);
 
 	t.is(await readPackageUp({cwd: '/'}), undefined);
 });
@@ -17,6 +21,10 @@ test('sync', t => {
 	const result = readPackageUpSync({cwd});
 	t.is(result.packageJson.name, 'read-pkg-up');
 	t.is(result.path, packagePath);
+	t.deepEqual(
+		readPackageUpSync({cwd: new URL(cwd, import.meta.url)}),
+		result,
+	);
 
 	t.is(readPackageUpSync({cwd: '/'}), undefined);
 });