[get-uri] Remove fs-extra dependency (#341)

alexparish · web-flow · commit 7dc268174d90 · 2024-10-22T14:45:07.000-07:00
diff --git a/.changeset/dirty-eagles-jog.md b/.changeset/dirty-eagles-jog.md
@@ -0,0 +1,5 @@
+---
+'get-uri': patch
+---
+
+Removed `fs-extra` dependency and implemented its features using native Node.js functionality.
diff --git a/packages/get-uri/package.json b/packages/get-uri/package.json
@@ -36,7 +36,6 @@
   "license": "MIT",
   "devDependencies": {
     "@types/debug": "^4.1.7",
-    "@types/fs-extra": "^8.1.2",
     "@types/ftpd": "^0.2.35",
     "@types/jest": "^29.5.1",
     "@types/node": "^14.18.45",
@@ -51,8 +50,7 @@
   "dependencies": {
     "basic-ftp": "^5.0.2",
     "data-uri-to-buffer": "^6.0.2",
-    "debug": "^4.3.4",
-    "fs-extra": "^11.2.0"
+    "debug": "^4.3.4"
   },
   "engines": {
     "node": ">= 14"
diff --git a/packages/get-uri/src/file.ts b/packages/get-uri/src/file.ts
@@ -1,7 +1,6 @@
 import { Readable } from 'stream';
 import createDebug from 'debug';
-import { Stats, createReadStream } from 'fs';
-import { fstat, open } from 'fs-extra';
+import { Stats, createReadStream, promises as fsPromises } from 'fs';
 import { GetUriProtocol } from './';
 import NotFoundError from './notfound';
 import NotModifiedError from './notmodified';
@@ -42,11 +41,12 @@ export const file: GetUriProtocol<FileOptions> = async (
 
 		// `open()` first to get a file descriptor and ensure that the file
 		// exists.
-		const fd = await open(filepath, flags, mode);
+		const fdHandle = await fsPromises.open(filepath, flags, mode);
+		// extract the numeric file descriptor
+		const fd = fdHandle.fd;
 
-		// Now `fstat()` to check the `mtime` and store the stat object for
-		// the cache.
-		const stat = await fstat(fd);
+		// store the stat object for the cache.
+		const stat = await fdHandle.stat();
 
 		// if a `cache` was provided, check if the file has not been modified
 		if (cache && cache.stat && stat && isNotModified(cache.stat, stat)) {
@@ -55,8 +55,7 @@ export const file: GetUriProtocol<FileOptions> = async (
 
 		// `fs.ReadStream` takes care of calling `fs.close()` on the
 		// fd after it's done reading
-		// @ts-expect-error `@types/node` doesn't allow `null` as file path :/
-		const rs = createReadStream(null, {
+		const rs = createReadStream(filepath, {
 			autoClose: true,
 			...opts,
 			fd,
diff --git a/packages/get-uri/test/file.test.ts b/packages/get-uri/test/file.test.ts
@@ -1,6 +1,6 @@
 import { join } from 'path';
 import { pathToFileURL } from 'url';
-import { readFile } from 'fs-extra';
+import { readFile } from 'fs/promises';
 import { getUri } from '../src';
 import { toBuffer } from './util';
 
diff --git a/packages/get-uri/test/ftp.test.ts b/packages/get-uri/test/ftp.test.ts
@@ -1,7 +1,7 @@
 import { basename, join } from 'path';
 import { FtpServer } from 'ftpd';
 import { getUri } from '../src';
-import { readFile } from 'fs-extra';
+import { readFile } from 'fs/promises';
 import { toBuffer } from './util';
 
 describe('get-uri', () => {
diff --git a/packages/get-uri/test/http.test.ts b/packages/get-uri/test/http.test.ts
@@ -3,7 +3,7 @@ import st from 'st';
 import path from 'path';
 import http from 'http';
 import { listen } from 'async-listen';
-import { readFile } from 'fs-extra';
+import { readFile } from 'fs/promises';
 import { getUri } from '../src';
 import { toBuffer } from './util';
 
diff --git a/packages/get-uri/test/https.test.ts b/packages/get-uri/test/https.test.ts
@@ -1,4 +1,5 @@
-import { readFile, readFileSync } from 'fs-extra';
+import { readFile } from 'fs/promises';
+import { readFileSync } from 'fs';
 // @ts-expect-error no `@types/st`
 import st from 'st';
 import path from 'path';
diff --git a/packages/get-uri/test/redirect.test.ts b/packages/get-uri/test/redirect.test.ts
@@ -4,7 +4,8 @@ import path from 'path';
 import http from 'http';
 import https from 'https';
 import { listen } from 'async-listen';
-import { readFile, readFileSync } from 'fs-extra';
+import { readFile } from 'fs/promises';
+import { readFileSync } from 'fs';
 import { getUri } from '../src';
 import { toBuffer } from './util';
 
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
