Remove fs-extra usage (#1107)

Author: ecraig12345

change/beachball-857252f9-29e7-4cee-8792-9287a470db83.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Remove fs-extra usage",
+  "packageName": "beachball",
+  "email": "elcraig@microsoft.com",
+  "dependentChangeType": "patch"
+}

package.json

@@ -51,7 +51,6 @@
   "dependencies": {
     "cosmiconfig": "^9.0.0",
     "execa": "^5.0.0",
-    "fs-extra": "^11.1.1",
     "minimatch": "^3.0.4",
     "p-graph": "^1.1.2",
     "p-limit": "^3.0.2",
@@ -63,7 +62,6 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.0.0",
-    "@types/fs-extra": "^11.0.0",
     "@types/minimatch": "^5.0.0",
     "@types/node": "^14.0.0",
     "@types/prompts": "^2.4.2",
@@ -77,7 +75,6 @@
     "eslint": "^8.0.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-etc": "^2.0.3",
-    "find-free-port": "^2.0.0",
     "get-port": "^5.0.0",
     "husky": "^8.0.0",
     "jest": "^29.0.0",

src/__e2e__/bump.test.ts

@@ -1,5 +1,4 @@
 import { describe, expect, it, afterEach, jest } from '@jest/globals';
-import fs from 'fs-extra';
 import path from 'path';
 import { generateChangeFiles, getChangeFiles } from '../__fixtures__/changeFiles';
 import { readChangelogJson } from '../__fixtures__/changelog';
@@ -12,6 +11,7 @@ import type { Repository } from '../__fixtures__/repository';
 import type { PackageJson } from '../types/PackageInfo';
 import { getParsedOptions } from '../options/getOptions';
 import { defaultRemoteBranchName } from '../__fixtures__/gitDefaults';
+import { readJson } from '../object/readJson';
 
 describe('version bumping', () => {
   let repositoryFactory: RepositoryFactory | undefined;
@@ -746,7 +746,7 @@ describe('version bumping', () => {
           expect(version).toBe('1.1.0');
 
           const jsonPath = path.join(packagePath, 'package.json');
-          expect((fs.readJSONSync(jsonPath) as PackageJson).version).toBe('1.0.0');
+          expect(readJson<PackageJson>(jsonPath).version).toBe('1.0.0');
         }),
       },
     });
@@ -776,7 +776,8 @@ describe('version bumping', () => {
           expect(version).toBe('1.1.0');
 
           const jsonPath = path.join(packagePath, 'package.json');
-          expect(((await fs.readJSON(jsonPath)) as PackageJson).version).toBe('1.0.0');
+          await new Promise(resolve => setTimeout(resolve, 0)); // simulate async work
+          expect(readJson<PackageJson>(jsonPath).version).toBe('1.0.0');
         }),
       },
     });
@@ -830,7 +831,7 @@ describe('version bumping', () => {
           expect(version).toBe('1.1.0');
 
           const jsonPath = path.join(packagePath, 'package.json');
-          expect((fs.readJSONSync(jsonPath) as PackageJson).version).toBe('1.1.0');
+          expect(readJson<PackageJson>(jsonPath).version).toBe('1.1.0');
         }),
       },
     });
@@ -860,7 +861,8 @@ describe('version bumping', () => {
           expect(version).toBe('1.1.0');
 
           const jsonPath = path.join(packagePath, 'package.json');
-          expect(((await fs.readJSON(jsonPath)) as PackageJson).version).toBe('1.1.0');
+          await new Promise(resolve => setTimeout(resolve, 0)); // simulate async work
+          expect(readJson<PackageJson>(jsonPath).version).toBe('1.1.0');
         }),
       },
     });

src/__e2e__/change.test.ts

@@ -1,5 +1,4 @@
 import { describe, expect, it, afterEach, jest, beforeEach } from '@jest/globals';
-import fs from 'fs-extra';
 import type prompts from 'prompts';
 import { getChangeFiles } from '../__fixtures__/changeFiles';
 import { initMockLogs } from '../__fixtures__/mockLogs';
@@ -13,6 +12,7 @@ import type { ChangeFileInfo, ChangeInfoMultiple } from '../types/ChangeInfo';
 import type { Repository } from '../__fixtures__/repository';
 import { getParsedOptions } from '../options/getOptions';
 import { getPackageInfos } from '../monorepo/getPackageInfos';
+import { readJson } from '../object/readJson';
 
 // prompts writes to stdout (not console) in a way that can't really be mocked with spies,
 // so instead we inject a custom mock stdout stream, as well as stdin for entering answers
@@ -128,7 +128,7 @@ describe('change command', () => {
 
     const changeFiles = getChangeFiles(options);
     expect(changeFiles).toHaveLength(1);
-    expect(fs.readJSONSync(changeFiles[0])).toMatchObject({
+    expect(readJson(changeFiles[0])).toMatchObject({
       comment: 'stage me please',
       packageName: 'foo',
       type: 'patch',
@@ -155,7 +155,7 @@ describe('change command', () => {
 
     const changeFiles = getChangeFiles(options);
     expect(changeFiles).toHaveLength(1);
-    expect(fs.readJSONSync(changeFiles[0])).toMatchObject({
+    expect(readJson(changeFiles[0])).toMatchObject({
       comment: 'commit me please',
       packageName: 'foo',
       type: 'patch',
@@ -186,7 +186,7 @@ describe('change command', () => {
 
     const changeFiles = getChangeFiles(options);
     expect(changeFiles).toHaveLength(1);
-    expect(fs.readJSONSync(changeFiles[0])).toMatchObject({
+    expect(readJson(changeFiles[0])).toMatchObject({
       comment: 'commit me please',
       packageName: 'foo',
       type: 'patch',
@@ -247,7 +247,7 @@ describe('change command', () => {
 
     const changeFiles = getChangeFiles(options);
     expect(changeFiles).toHaveLength(2);
-    const changeFileContents = changeFiles.map(changeFile => fs.readJSONSync(changeFile) as ChangeFileInfo);
+    const changeFileContents = changeFiles.map(changeFile => readJson<ChangeFileInfo>(changeFile));
     expect(changeFileContents).toContainEqual(
       expect.objectContaining({ comment: 'custom', packageName: 'pkg-1', type: 'minor' })
     );
@@ -283,7 +283,7 @@ describe('change command', () => {
 
     const changeFiles = getChangeFiles(options);
     expect(changeFiles).toHaveLength(1);
-    const contents = fs.readJSONSync(changeFiles[0]) as ChangeInfoMultiple;
+    const contents = readJson<ChangeInfoMultiple>(changeFiles[0]);
     expect(contents.changes).toEqual([
       expect.objectContaining({ comment: 'custom', packageName: 'pkg-1', type: 'minor' }),
       expect.objectContaining({ comment: 'commit 2', packageName: 'pkg-2', type: 'patch' }),
@@ -330,7 +330,7 @@ describe('change command', () => {
 
     const changeFiles = getChangeFiles(options);
     expect(changeFiles).toHaveLength(1);
-    const contents = fs.readJSONSync(changeFiles[0]) as ChangeInfoMultiple;
+    const contents = readJson<ChangeInfoMultiple>(changeFiles[0]);
     expect(contents.changes).toEqual([
       expect.objectContaining({ packageName: 'pkg-1', type: 'patch', comment: 'commit 2' }),
       expect.objectContaining({ packageName: 'pkg-2', type: 'patch', comment: 'commit 2', custom: 'stuff' }),

src/__e2e__/publishE2E.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it, afterEach, jest } from '@jest/globals';
-import fs from 'fs-extra';
+import fs from 'fs';
 import path from 'path';
 import { addGitObserver, clearGitObservers } from 'workspace-tools';
 import { generateChangeFiles } from '../__fixtures__/changeFiles';
@@ -15,6 +15,7 @@ import type { PackageJson } from '../types/PackageInfo';
 import { getParsedOptions } from '../options/getOptions';
 import { getPackageInfos } from '../monorepo/getPackageInfos';
 import { validate } from '../validation/validate';
+import { readJson } from '../object/readJson';
 
 // Spawning actual npm to run commands against a fake registry is extremely slow, so mock it for
 // this test (packagePublish covers the more complete npm registry scenario).
@@ -172,7 +173,7 @@ describe('publish command (e2e)', () => {
           const anotherRepo = repositoryFactory!.cloneRepository();
           // inject a checkin
           const packageJsonFile = anotherRepo.pathTo('package.json');
-          const contents = fs.readJSONSync(packageJsonFile, 'utf-8') as PackageJson;
+          const contents = readJson<PackageJson>(packageJsonFile);
           delete contents.dependencies?.baz;
           anotherRepo.commitChange('package.json', JSON.stringify(contents, null, 2));
           anotherRepo.push();
@@ -374,7 +375,7 @@ describe('publish command (e2e)', () => {
       hooks: {
         prepublish: (packagePath: string) => {
           const packageJsonPath = path.join(packagePath, 'package.json');
-          const packageJson = fs.readJSONSync(packageJsonPath) as ExtraPackageJson;
+          const packageJson = readJson<ExtraPackageJson>(packageJsonPath);
           if (packageJson.onPublish) {
             Object.assign(packageJson, packageJson.onPublish);
             delete packageJson.onPublish;
@@ -400,7 +401,7 @@ describe('publish command (e2e)', () => {
 
     // All git results should still have previous information
     expect(repo.getCurrentTags()).toEqual(['foo_v1.1.0']);
-    const fooPackageJson = fs.readJSONSync(repo.pathTo('packages/foo/package.json')) as ExtraPackageJson;
+    const fooPackageJson = readJson<ExtraPackageJson>(repo.pathTo('packages/foo/package.json'));
     expect(fooPackageJson.main).toBe('src/index.ts');
     expect(fooPackageJson.onPublish?.main).toBe('lib/index.js');
   });
@@ -416,7 +417,7 @@ describe('publish command (e2e)', () => {
       hooks: {
         postpublish: packagePath => {
           const packageJsonPath = path.join(packagePath, 'package.json');
-          const packageJson = fs.readJSONSync(packageJsonPath) as ExtraPackageJson;
+          const packageJson = readJson<ExtraPackageJson>(packageJsonPath);
           if (packageJson.afterPublish) {
             notified = packageJson.afterPublish.notify;
           }
@@ -429,7 +430,7 @@ describe('publish command (e2e)', () => {
 
     await publish(options, packageInfos);
 
-    const fooPackageJson = fs.readJSONSync(repo.pathTo('packages/foo/package.json')) as ExtraPackageJson;
+    const fooPackageJson = readJson<ExtraPackageJson>(repo.pathTo('packages/foo/package.json'));
     expect(fooPackageJson.main).toBe('src/index.ts');
     expect(notified).toBe(fooPackageJson.afterPublish?.notify);
   });
@@ -671,7 +672,7 @@ describe('publish command (e2e)', () => {
           await simulateWait(100);
           const packageName = path.basename(packagePath);
           const packageJsonPath = path.join(packagePath, 'package.json');
-          const packageJson = fs.readJSONSync(packageJsonPath) as ExtraPackageJsonFixture;
+          const packageJson = readJson<ExtraPackageJsonFixture>(packageJsonPath);
           if (packageJson.afterPublish) {
             afterPublishStrings.push({
               packageName,
@@ -693,7 +694,7 @@ describe('publish command (e2e)', () => {
     expect(maxConcurrency).toBe(concurrency);
 
     for (const pkg of packagesToPublish) {
-      const packageJson = fs.readJSONSync(repo.pathTo(`packages/${pkg}/package.json`)) as ExtraPackageJsonFixture;
+      const packageJson = readJson<ExtraPackageJsonFixture>(repo.pathTo(`packages/${pkg}/package.json`));
       if (packageJson.afterPublish) {
         // Verify that all postpublish hooks were called
         expect(afterPublishStrings).toContainEqual({

src/__e2e__/publishGit.test.ts

@@ -1,5 +1,4 @@
 import { describe, expect, it, beforeEach, afterEach } from '@jest/globals';
-import fs from 'fs-extra';
 import { defaultRemoteBranchName } from '../__fixtures__/gitDefaults';
 import { generateChangeFiles, getChangeFiles } from '../__fixtures__/changeFiles';
 import { initMockLogs } from '../__fixtures__/mockLogs';
@@ -12,6 +11,7 @@ import type { ChangeFileInfo } from '../types/ChangeInfo';
 import { getPackageInfos } from '../monorepo/getPackageInfos';
 import type { PackageJson } from '../types/PackageInfo';
 import { getParsedOptions } from '../options/getOptions';
+import { readJson } from '../object/readJson';
 
 describe('publish command (git)', () => {
   let repositoryFactory: RepositoryFactory;
@@ -58,7 +58,7 @@ describe('publish command (git)', () => {
 
     const newRepo = repositoryFactory.cloneRepository();
 
-    const packageJson = fs.readJSONSync(newRepo.pathTo('package.json')) as PackageJson;
+    const packageJson = readJson<PackageJson>(newRepo.pathTo('package.json'));
 
     expect(packageJson.version).toBe('1.1.0');
   });
@@ -88,7 +88,7 @@ describe('publish command (git)', () => {
     const newRepo = repositoryFactory.cloneRepository();
     const changeFiles = getChangeFiles({ ...options1, path: newRepo.rootPath });
     expect(changeFiles).toHaveLength(1);
-    const changeFileContent = fs.readJSONSync(changeFiles[0]) as ChangeFileInfo;
+    const changeFileContent = readJson<ChangeFileInfo>(changeFiles[0]);
     expect(changeFileContent.packageName).toBe('foo2');
   });
 });

src/__e2e__/syncE2E.test.ts

@@ -1,5 +1,4 @@
 import { describe, expect, it, afterEach, jest } from '@jest/globals';
-import fs from 'fs-extra';
 import { defaultRemoteBranchName } from '../__fixtures__/gitDefaults';
 import { initMockLogs } from '../__fixtures__/mockLogs';
 import type { Repository } from '../__fixtures__/repository';
@@ -10,6 +9,7 @@ import type { packagePublish } from '../packageManager/packagePublish';
 import type { RepoOptions } from '../types/BeachballOptions';
 import { initNpmMock } from '../__fixtures__/mockNpm';
 import { getParsedOptions } from '../options/getOptions';
+import { removeTempDir } from '../__fixtures__/tmpdir';
 
 // Spawning actual npm to run commands against a fake registry is extremely slow, so mock it for
 // this test (packagePublish covers the more complete npm registry scenario).
@@ -59,7 +59,7 @@ describe('sync command (e2e)', () => {
       repositoryFactory.cleanUp();
       repositoryFactory = undefined;
     }
-    tempDirs.forEach(dir => fs.removeSync(dir));
+    tempDirs.forEach(dir => removeTempDir(dir));
     tempDirs.splice(0, tempDirs.length);
   });
 

src/__fixtures__/changelog.ts

@@ -1,7 +1,8 @@
-import fs from 'fs-extra';
+import fs from 'fs';
 import path from 'path';
 import type { ChangelogJson } from '../types/ChangeLog';
 import { markerComment } from '../changelog/renderChangelog';
+import { readJson } from '../object/readJson';
 
 /** Placeholder commit as replaced by cleanChangelogJson */
 export const fakeCommit = '(sha1)';
@@ -38,7 +39,7 @@ export function readChangelogJson(packagePath: string, filename?: string, noClea
     return null;
   }
 
-  const changelog = fs.readJSONSync(changelogJsonFile, { encoding: 'utf-8' }) as ChangelogJson;
+  const changelog = readJson<ChangelogJson>(changelogJsonFile);
   if (noClean) {
     return changelog;
   }

src/__fixtures__/createTestFileStructure.ts

@@ -1,4 +1,4 @@
-import fs from 'fs-extra';
+import fs from 'fs';
 import { tmpdir } from './tmpdir';
 import path from 'path';
 
@@ -12,7 +12,7 @@ export function createTestFileStructure(files: Record<string, string | object>):
 
   for (const [filename, content] of Object.entries(files)) {
     const filePath = path.join(testFolderPath, filename);
-    fs.ensureDirSync(path.dirname(filePath));
+    fs.mkdirSync(path.dirname(filePath), { recursive: true });
     fs.writeFileSync(filePath, typeof content === 'string' ? content : JSON.stringify(content));
   }
 

src/__fixtures__/mockNpm.test.ts

@@ -3,7 +3,7 @@
 // dependency on actual npm CLI calls and a fake registry (which are very slow).
 
 import { afterAll, afterEach, beforeAll, describe, expect, it, jest } from '@jest/globals';
-import fs from 'fs-extra';
+import fs from 'fs';
 import { type NpmResult, npm } from '../packageManager/npm';
 import type { PackageJson } from '../types/PackageInfo';
 import {
@@ -14,8 +14,10 @@ import {
   _mockNpmShow,
   type MockNpmResult,
 } from './mockNpm';
+import * as readJsonModule from '../object/readJson';
 
-jest.mock('fs-extra');
+jest.mock('fs');
+jest.mock('../object/readJson');
 jest.mock('../packageManager/npm');
 
 describe('_makeRegistryData', () => {
@@ -193,10 +195,10 @@ describe('_mockNpmPublish', () => {
   let packageJson: PackageJson | undefined;
 
   beforeAll(() => {
-    (fs.readJsonSync as jest.MockedFunction<typeof fs.readJsonSync>).mockImplementation(() => {
+    (readJsonModule.readJson as jest.MockedFunction<typeof readJsonModule.readJson>).mockImplementation((() => {
       if (!packageJson) throw new Error('packageJson not set');
       return packageJson;
-    });
+    }) as typeof readJsonModule.readJson);
   });
 
   afterEach(() => {
@@ -289,10 +291,10 @@ describe('_mockNpmPack', () => {
   let writtenFiles: (fs.PathLike | number)[] = [];
 
   beforeAll(() => {
-    (fs.readJsonSync as jest.MockedFunction<typeof fs.readJsonSync>).mockImplementation(() => {
+    (readJsonModule.readJson as jest.MockedFunction<typeof readJsonModule.readJson>).mockImplementation((() => {
       if (!packageJson) throw new Error('packageJson not set');
       return packageJson;
-    });
+    }) as typeof readJsonModule.readJson);
     (fs.writeFileSync as jest.MockedFunction<typeof fs.writeFileSync>).mockImplementation(filePath => {
       writtenFiles.push(String(filePath).replace(/\\/g, '/'));
     });
@@ -352,10 +354,10 @@ describe('mockNpm', () => {
   let packageJson: PackageJson | undefined;
 
   beforeAll(() => {
-    (fs.readJsonSync as jest.MockedFunction<typeof fs.readJsonSync>).mockImplementation(() => {
+    (readJsonModule.readJson as jest.MockedFunction<typeof readJsonModule.readJson>).mockImplementation((() => {
       if (!packageJson) throw new Error('packageJson not set');
       return packageJson;
-    });
+    }) as typeof readJsonModule.readJson);
   });
 
   afterEach(() => {