Replaced fs-extra with native fs/promises (#726) (#767)

closes #726 

- Replaced all `require('fs-extra')` with `require('fs/promises')` and removed the dependency.
- Unfortunately it's still in the lockfile for now because it's a transient dep in `@tryghost/logging`, but that will be cleaned up a bit better when the web app is decoupled from the lib

Author: troyciesco

app/index.js

@@ -11,7 +11,7 @@ const server = require('@tryghost/server');
 const config = require('@tryghost/config');
 const errors = require('@tryghost/errors');
 const gscan = require('../lib');
-const fs = require('fs-extra');
+const fs = require('fs/promises');
 const path = require('path');
 const logRequest = require('./middlewares/log-request');
 const uploadValidation = require('./middlewares/upload-validation');
@@ -103,7 +103,7 @@ app.post('/',
                 checkError = error;
             }).finally(function () {
                 debug('attempting to remove: ' + req.file.path);
-                fs.remove(req.file.path)
+                fs.rm(req.file.path, {recursive: true, force: true})
                     .catch(function (removeError) {
                         debug('failed to remove uploaded file', removeError);
                     })

lib/checker.js

@@ -121,8 +121,8 @@ const checkZip = async function checkZip(path, options) {
         throw error;
     } finally {
         if (!options.keepExtractedDir && zip.origPath) {
-            const fs = require('fs-extra');
-            await fs.remove(zip.origPath);
+            const fs = require('fs/promises');
+            await fs.rm(zip.origPath, {recursive: true, force: true});
         }
     }
 };

lib/read-theme.js

@@ -1,4 +1,4 @@
-const fs = require('fs-extra');
+const fs = require('fs/promises');
 const _ = require('lodash');
 const os = require('os');
 const path = require('path');
@@ -59,7 +59,7 @@ const readThemeStructure = function readThemeFiles(themePath, subPath, arr) {
                  */
                 if (ignore.indexOf(file) > -1) {
                     return inTmp
-                        ? fs.remove(newPath)
+                        ? fs.rm(newPath, {recursive: true, force: true})
                             .then(function () {
                                 return result;
                             })

package.json

@@ -55,7 +55,6 @@
     "chalk": "5.6.2",
     "express": "5.2.1",
     "express-handlebars": "7.1.3",
-    "fs-extra": "11.3.4",
     "glob": "13.0.6",
     "lodash": "4.18.1",
     "multer": "2.1.1",

test/general.test.js

@@ -1,5 +1,5 @@
 const path = require('path');
-const fs = require('fs-extra');
+const fs = require('fs/promises');
 const errors = require('@tryghost/errors');
 const {check, checkZip} = require('../lib');
 const utils = require('./utils');
@@ -79,14 +79,13 @@ describe('Check zip', function () {
             expect(theme.files.length).toEqual(1);
             expect(theme.files[0].file).toMatch(/default\.hbs/);
 
-            const extractedThemePathExists = await fs.pathExists(theme.path);
-            expect(extractedThemePathExists).toEqual(false);
+            await expect(fs.access(theme.path)).rejects.toThrow();
         });
 
         it('removes extracted directory when checks fail', async function () {
             const readThemePath = require.resolve('../lib/read-theme');
             const originalReadTheme = require(readThemePath);
-            const removeSpy = vi.spyOn(fs, 'remove');
+            const removeSpy = vi.spyOn(fs, 'rm');
             let removedPath;
 
             require.cache[readThemePath].exports = async function () {
@@ -109,17 +108,15 @@ describe('Check zip', function () {
                 removeSpy.mockRestore();
             }
 
-            const extractedThemePathExists = await fs.pathExists(removedPath);
-            expect(extractedThemePathExists).toEqual(false);
+            await expect(fs.access(removedPath)).rejects.toThrow();
         });
 
         it('removes entire temp directory for nested zips', async function () {
             const theme = await checkZip(themePath('example.zip'), {checkVersion: 'v1'});
 
             expect(theme.files.length).toBeGreaterThan(0);
 
-            const extractedParentPathExists = await fs.pathExists(path.dirname(theme.path));
-            expect(extractedParentPathExists).toEqual(false);
+            await expect(fs.access(path.dirname(theme.path))).rejects.toThrow();
         });
 
         it('keeps extracted directory when keepExtractedDir is true', async function () {
@@ -128,10 +125,9 @@ describe('Check zip', function () {
             expect(theme.files.length).toEqual(1);
             expect(theme.files[0].file).toMatch(/default\.hbs/);
 
-            const extractedThemePathExists = await fs.pathExists(theme.path);
-            expect(extractedThemePathExists).toEqual(true);
+            await expect(fs.access(theme.path)).resolves.not.toThrow();
 
-            await fs.remove(theme.path);
+            await fs.rm(theme.path, {recursive: true, force: true});
         });
 
         it('accepts an object zip input', async function () {
@@ -143,7 +139,7 @@ describe('Check zip', function () {
             expect(theme.files.length).toEqual(1);
             expect(theme.files[0].file).toMatch(/default\.hbs/);
 
-            await fs.remove(theme.path);
+            await fs.rm(theme.path, {recursive: true, force: true});
         });
     });
 });

test/read-theme.test.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const fs = require('fs-extra');
+const fs = require('fs/promises');
 const utils = require('./utils');
 const readTheme = require('../lib/read-theme');
 const themePath = utils.themePath;

test/read-zip.test.js

@@ -1,4 +1,4 @@
-const fs = require('fs-extra');
+const fs = require('fs/promises');
 const utils = require('./utils');
 const readZip = require('../lib/read-zip');
 const themePath = utils.themePath;
@@ -19,7 +19,7 @@ describe('Zip file handler can read zip files', function () {
     const tempDirs = [];
 
     afterAll(async function () {
-        await Promise.all(tempDirs.map(dir => fs.remove(dir)));
+        await Promise.all(tempDirs.map(dir => fs.rm(dir, {recursive: true, force: true})));
     });
 
     it('Flat example: zip without folder should unzip and callback with a path', function () {

yarn.lock

@@ -4488,9 +4488,9 @@ vary@^1.1.2:
   integrity sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==
 
 "vite@^6.0.0 || ^7.0.0 || ^8.0.0":
-  version "8.0.3"
-  resolved "https://registry.yarnpkg.com/vite/-/vite-8.0.3.tgz#036d9e3b077ff57b128660b3e3a5d2d12bac9b42"
-  integrity sha512-B9ifbFudT1TFhfltfaIPgjo9Z3mDynBTJSUYxTjOQruf/zHH+ezCQKcoqO+h7a9Pw9Nm/OtlXAiGT1axBgwqrQ==
+  version "8.0.5"
+  resolved "https://registry.yarnpkg.com/vite/-/vite-8.0.5.tgz#5f8648997359e18dbc1a9e151ce55434ce5d8a2f"
+  integrity sha512-nmu43Qvq9UopTRfMx2jOYW5l16pb3iDC1JH6yMuPkpVbzK0k+L7dfsEDH4jRgYFmsg0sTAqkojoZgzLMlwHsCQ==
   dependencies:
     lightningcss "^1.32.0"
     picomatch "^4.0.4"