refactor(#release): remove unnecessary dependencies (#229)

### Refactoring
- [#release] Remove the dependencies `fs-extra` and `@types/fs-extra`
because they are not necessary. The native Node.js `fs` module already
fulfills our current needs.

packages/release/package.json

@@ -27,13 +27,11 @@
     "types:check": "tsc --noEmit"
   },
   "dependencies": {
-    "fs-extra": "^11.2.0",
     "yargs": "^17.7.2",
     "zod": "^3.23.8",
     "zx": "^4.3.0"
   },
   "devDependencies": {
-    "@types/fs-extra": "^11.0.4",
     "@types/node": "^20.14.0",
     "@types/yargs": "^17.0.32",
     "@vitest/coverage-istanbul": "1.6.0",

packages/release/src/cli/actions/prepare-release/__tests__/prepare-release.test.ts

@@ -1,4 +1,4 @@
-import filesystem from 'fs-extra';
+import filesystem from 'fs/promises';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { ProcessOutput, ProcessPromise } from 'zx';
 
@@ -44,8 +44,8 @@ describe('Prepare release command', () => {
     ],
   });
 
-  const readJSONSpy = vi.spyOn(filesystem, 'readJSON');
-  const writeJSONSpy = vi.spyOn(filesystem, 'writeJSON');
+  const readFileSpy = vi.spyOn(filesystem, 'readFile');
+  const writeFileSpy = vi.spyOn(filesystem, 'writeFile');
 
   beforeEach(() => {
     metadataFileContent.version = '0.0.0';
@@ -55,18 +55,18 @@ describe('Prepare release command', () => {
     config.metadata[0].partialVersions.appendTo = [];
     config.tagSuffix = undefined;
 
-    readJSONSpy.mockClear();
-    readJSONSpy.mockImplementation((filePath) => {
+    readFileSpy.mockClear();
+    readFileSpy.mockImplementation((filePath) => {
       if (filePath === metadataFilePath) {
-        return Promise.resolve({ ...metadataFileContent });
+        return Promise.resolve(JSON.stringify(metadataFileContent));
       }
       return Promise.reject(new Error(`File ${filePath.toLocaleString()} not found.`));
     });
 
-    writeJSONSpy.mockClear();
-    writeJSONSpy.mockImplementation((filePath, newMetadataFileContent) => {
-      if (filePath === metadataFilePath) {
-        Object.assign(metadataFileContent, newMetadataFileContent);
+    writeFileSpy.mockClear();
+    writeFileSpy.mockImplementation((filePath, newMetadataFileContent) => {
+      if (filePath === metadataFilePath && typeof newMetadataFileContent === 'string') {
+        Object.assign(metadataFileContent, JSON.parse(newMetadataFileContent));
         return Promise.resolve();
       }
       return Promise.reject(new Error(`File ${filePath.toLocaleString()} not found.`));

packages/release/src/cli/actions/upgrade-version/__tests__/upgrade-version.test.ts

@@ -1,4 +1,4 @@
-import filesystem from 'fs-extra';
+import filesystem from 'fs/promises';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
 import { createMetadataFileEntry, createReleaseConfig } from '@tests/factories/release-config';
@@ -34,25 +34,25 @@ describe('Upgrade version command', () => {
     ],
   });
 
-  const readJSONSpy = vi.spyOn(filesystem, 'readJSON');
-  const writeJSONSpy = vi.spyOn(filesystem, 'writeJSON');
+  const readFileSpy = vi.spyOn(filesystem, 'readFile');
+  const writeFileSpy = vi.spyOn(filesystem, 'writeFile');
 
   beforeEach(() => {
     metadataFileContent.version = '0.0.0';
     metadataFileContent.description = 'description';
     config.metadata[0].partialVersions.includeInVersionKey = true;
     config.metadata[0].partialVersions.appendTo = [];
 
-    readJSONSpy.mockClear();
-    readJSONSpy.mockImplementation((filePath) => {
+    readFileSpy.mockClear();
+    readFileSpy.mockImplementation((filePath) => {
       if (filePath === metadataFilePath) {
-        return Promise.resolve({ ...metadataFileContent });
+        return Promise.resolve(JSON.stringify(metadataFileContent));
       }
       return Promise.reject(new Error(`File ${filePath.toLocaleString()} not found.`));
     });
 
-    writeJSONSpy.mockClear();
-    writeJSONSpy.mockImplementation((filePath) => {
+    writeFileSpy.mockClear();
+    writeFileSpy.mockImplementation((filePath) => {
       if (filePath === metadataFilePath) {
         return Promise.resolve();
       }
@@ -63,17 +63,17 @@ describe('Upgrade version command', () => {
   });
 
   function expectUpgradedMetadataFiles(upgradedVersion: string, extraUpgradedFileContent?: MetadataFileContent) {
-    expect(readJSONSpy).toHaveBeenCalledTimes(1);
-    expect(readJSONSpy).toHaveBeenCalledWith(metadataFilePath);
+    expect(readFileSpy).toHaveBeenCalledTimes(1);
+    expect(readFileSpy).toHaveBeenCalledWith(metadataFilePath, 'utf8');
 
-    expect(writeJSONSpy).toHaveBeenCalledTimes(1);
+    expect(writeFileSpy).toHaveBeenCalledTimes(1);
 
     const upgradedMetadataFileContent: MetadataFileContent = {
       ...metadataFileContent,
       ...extraUpgradedFileContent,
       version: upgradedVersion,
     };
-    expect(writeJSONSpy).toHaveBeenCalledWith(metadataFilePath, upgradedMetadataFileContent, { spaces: 2 });
+    expect(writeFileSpy).toHaveBeenCalledWith(metadataFilePath, JSON.stringify(upgradedMetadataFileContent, null, 2));
 
     expect(runCommandSpy).toHaveBeenCalledTimes(1);
     expect(runCommandSpy).toHaveBeenCalledWith(['pnpm style:format ', ''], [metadataFilePath]);
@@ -225,9 +225,9 @@ describe('Upgrade version command', () => {
       const expectedError = new MissingRequiredPartialLabelError();
       await expect(upgradePromise).rejects.toThrowError(expectedError);
 
-      expect(readJSONSpy).toHaveBeenCalledTimes(1);
-      expect(readJSONSpy).toHaveBeenCalledWith(metadataFilePath);
-      expect(writeJSONSpy).not.toHaveBeenCalled();
+      expect(readFileSpy).toHaveBeenCalledTimes(1);
+      expect(readFileSpy).toHaveBeenCalledWith(metadataFilePath, 'utf8');
+      expect(writeFileSpy).not.toHaveBeenCalled();
       expect(runCommandSpy).not.toHaveBeenCalled();
     });
   });
@@ -245,8 +245,8 @@ describe('Upgrade version command', () => {
       expect(upgradeResult.isPartialUpgrade).toBe(true);
       expectUpgradedMetadataFiles(upgradedVersionWithPartialLabel);
 
-      readJSONSpy.mockClear();
-      writeJSONSpy.mockClear();
+      readFileSpy.mockClear();
+      writeFileSpy.mockClear();
       runCommandSpy.mockClear();
 
       metadataFileContent.version = '1.2.1';
@@ -277,8 +277,8 @@ describe('Upgrade version command', () => {
         description: descriptionWithAppendedPartialVersion,
       });
 
-      readJSONSpy.mockClear();
-      writeJSONSpy.mockClear();
+      readFileSpy.mockClear();
+      writeFileSpy.mockClear();
       runCommandSpy.mockClear();
 
       metadataFileContent.version = upgradedVersion;
@@ -305,9 +305,9 @@ describe('Upgrade version command', () => {
       const expectedError = new AppendPartialVersionToNonStringError();
       await expect(upgradePromise).rejects.toThrowError(expectedError);
 
-      expect(readJSONSpy).toHaveBeenCalledTimes(1);
-      expect(readJSONSpy).toHaveBeenCalledWith(metadataFilePath);
-      expect(writeJSONSpy).not.toHaveBeenCalled();
+      expect(readFileSpy).toHaveBeenCalledTimes(1);
+      expect(readFileSpy).toHaveBeenCalledWith(metadataFilePath, 'utf8');
+      expect(writeFileSpy).not.toHaveBeenCalled();
       expect(runCommandSpy).not.toHaveBeenCalled();
     });
   });

packages/release/src/cli/actions/upgrade-version/utils/metadata-files.ts

@@ -1,4 +1,4 @@
-import filesystem from 'fs-extra';
+import filesystem from 'fs/promises';
 import { z } from 'zod';
 
 import { MetadataFileEntry } from '@/config/release-config';
@@ -9,9 +9,12 @@ import { MetadataFileContent, Version } from '../types';
 import { formatVersion, parseVersion } from './version';
 
 async function readMetadataFileContent(file: MetadataFileEntry) {
-  const rawFileContent = (await filesystem.readJSON(file.path)) as unknown;
+  const stringifiedFileContent = await filesystem.readFile(file.path, 'utf8');
+  const rawFileContent = JSON.parse(stringifiedFileContent) as unknown;
+
   const metadataFileSchema = z.object({ [file.versionKey]: z.string() }).passthrough();
   metadataFileSchema.parse(rawFileContent);
+
   return rawFileContent as MetadataFileContent satisfies z.infer<typeof metadataFileSchema>;
 }
 
@@ -27,8 +30,9 @@ export function getPrimaryVersion(metadataFiles: MetadataFileEntry[], metadataFi
   return primaryVersion;
 }
 
-async function writeMetadataFileContent(file: MetadataFileEntry, upgradedFileContent: MetadataFileContent) {
-  await filesystem.writeJSON(file.path, upgradedFileContent, { spaces: 2 });
+async function writeMetadataFileContent(file: MetadataFileEntry, fileContent: MetadataFileContent) {
+  const stringifiedFileContent = JSON.stringify(fileContent, null, 2);
+  await filesystem.writeFile(file.path, stringifiedFileContent);
 }
 
 export async function writeMetadataFileContents(

packages/release/src/config/release-config/release-config.ts

@@ -1,6 +1,7 @@
-import filesystem from 'fs-extra';
 import path from 'path';
 
+import { pathExists } from '@/utils/files';
+
 import { CONFIG_FILENAME, PACKAGE_JSON_FILENAME, importedReleaseConfigSchema } from './constants';
 import { MissingReleaseConfigError, InvalidReleaseConfigError } from './errors';
 
@@ -10,14 +11,14 @@ async function findConfigFilePath() {
   while (true) {
     const configFilePath = path.join(directory, CONFIG_FILENAME);
 
-    const configFileExists = await filesystem.pathExists(configFilePath);
+    const configFileExists = await pathExists(configFilePath);
     if (configFileExists) {
       return configFilePath;
     }
 
     const packageJSONFilePath = path.join(directory, PACKAGE_JSON_FILENAME);
 
-    const packageJSONExists = await filesystem.pathExists(packageJSONFilePath);
+    const packageJSONExists = await pathExists(packageJSONFilePath);
     if (packageJSONExists) {
       throw new MissingReleaseConfigError();
     }

packages/release/src/utils/files.ts

@@ -0,0 +1,10 @@
+import filesystem from 'fs/promises';
+
+export async function pathExists(path: string) {
+  try {
+    await filesystem.access(path);
+    return true;
+  } catch {
+    return false;
+  }
+}