refactor: rid project of fs-extra

Author: peternhale

package.json

@@ -11,7 +11,6 @@
     "@salesforce/sf-plugins-core": "^2.2.9",
     "@salesforce/ts-types": "^1.7.1",
     "chalk": "^3.0.0",
-    "fs-extra": "^10.0.1",
     "handlebars": "^4.7.7",
     "lodash.uniqby": "^4.7.0",
     "mkdirp": "^1.0.4",

src/commands/commandreference/generate.ts

@@ -5,22 +5,29 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
+import * as fs from 'fs/promises';
 import * as os from 'os';
 import * as path from 'path';
-import { pathExists, readJSON } from 'fs-extra';
 import { SfCommand } from '@salesforce/sf-plugins-core';
 import { Command, Flags, Interfaces } from '@oclif/core';
 import { Messages, SfError } from '@salesforce/core';
-import { AnyJson, Dictionary, ensure, ensureString, JsonMap } from '@salesforce/ts-types';
+import { AnyJson, ensure, ensureString, JsonMap } from '@salesforce/ts-types';
 import chalk = require('chalk');
+import { parseJsonMap } from '@salesforce/kit';
 import { Ditamap } from '../../ditamap/ditamap';
 import { Docs } from '../../docs';
-import { CommandClass, events, mergeDeep } from '../../utils';
+import { CommandClass, events } from '../../utils';
 
 // Initialize Messages with the current plugin directory
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-command-reference', 'main');
 
+const fileExists = async (filePath: string): Promise<boolean> =>
+  fs
+    .stat(filePath)
+    .then(() => true)
+    .catch(() => false);
+
 export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
   public static description = messages.getMessage('commandDescription');
 
@@ -58,8 +65,8 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
     let pluginNames: string[];
     if (!flags.plugins && !flags.all) {
       const pJsonPath = path.join(process.cwd(), 'package.json');
-      if (await pathExists(pJsonPath)) {
-        const packageJson = (await readJSON(pJsonPath)) as JsonMap;
+      if (await fileExists(pJsonPath)) {
+        const packageJson = parseJsonMap(await fs.readFile(pJsonPath, 'utf-8'));
         pluginNames = [ensureString(packageJson.name)];
       } else {
         throw new SfError(
@@ -177,7 +184,7 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
         const commandClass = await this.loadCommand(cmd);
 
         if (commandClass.plugin?.pjson.oclif.topics) {
-          mergeDeep(topicsMeta, commandClass.plugin.pjson.oclif.topics as Dictionary);
+          Object.assign(topicsMeta, commandClass.plugin.pjson.oclif.topics);
           plugins[commandClass.plugin.name] = true;
         }
       }
@@ -203,10 +210,10 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
 
         return obj as unknown as CommandClass;
       } catch (error) {
-        return Object.assign({}, cmd) as unknown as CommandClass;
+        return cmd as unknown as CommandClass;
       }
     });
-    const commands = (await Promise.all(promises)) as CommandClass[];
+    const commands = await Promise.all(promises);
     return Array.from(
       commands
         .reduce((acc: Map<string, CommandClass>, cmd: CommandClass) => {

src/utils.ts

@@ -7,24 +7,12 @@
 
 import { EventEmitter } from 'events';
 import { EOL } from 'os';
-import { Dictionary, isObject } from '@salesforce/ts-types';
 import { Command } from '@oclif/core';
 
 export type CommandClass = Command.Class & { topic: string; subtopic: string } & Record<string, unknown>;
 
 export const events = new EventEmitter();
 
-export function mergeDeep(target: Dictionary, source: Dictionary): Dictionary {
-  Object.keys(source).forEach((key) => {
-    if (isObject(target[key]) && isObject(source[key])) {
-      mergeDeep(target[key] as Dictionary, source[key] as Dictionary);
-    } else {
-      target[key] = source[key];
-    }
-  });
-  return target;
-}
-
 export function punctuate(description?: string): string | undefined {
   if (!description) return description;
 

test/unit/utils.test.ts

@@ -7,37 +7,7 @@
 
 import { EOL } from 'os';
 import { expect } from 'chai';
-import { punctuate, mergeDeep } from '../../src/utils';
-
-it('merge two shallow objects', () => {
-  expect(mergeDeep({ a: 1 }, { b: 2 })).to.deep.equal({ a: 1, b: 2 });
-});
-
-it('merge two deeply nested objects', () => {
-  expect(
-    mergeDeep(
-      {
-        a: {
-          b: 1,
-          c: { d: 3 },
-        },
-      },
-      {
-        a: {
-          c: { e: 4 },
-        },
-      }
-    )
-  ).to.deep.equal({
-    a: {
-      b: 1,
-      c: {
-        d: 3,
-        e: 4,
-      },
-    },
-  });
-});
+import { punctuate } from '../../src/utils';
 
 describe('punctuate', () => {
   it('description to longDescription', () => {