fix: improve types (#99)

* fix: improve types

* chore: regenerate yarn.lock

Author: mdonnalley

package.json

@@ -28,14 +28,14 @@
     "@typescript-eslint/eslint-plugin": "^4.2.0",
     "@typescript-eslint/parser": "^4.2.0",
     "chai": "^4.2.0",
-    "eslint": "^6.8.0",
+    "eslint": "^7.27.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-config-salesforce": "^0.1.6",
     "eslint-config-salesforce-license": "^0.1.6",
     "eslint-config-salesforce-typescript": "^0.2.7",
     "eslint-plugin-header": "^3.0.0",
-    "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-jsdoc": "^27.0.3",
+    "eslint-plugin-import": "2.24.2",
+    "eslint-plugin-jsdoc": "^35.1.2",
     "eslint-plugin-prettier": "^3.1.3",
     "husky": "^7.0.4",
     "mocha": "^9.1.3",
@@ -49,7 +49,7 @@
     "typescript": "^4.1.3"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "files": [
     "/lib",

src/commands/commandreference/generate.ts

@@ -9,14 +9,13 @@ import * as os from 'os';
 import * as path from 'path';
 import { readJSON, pathExists } from 'fs-extra';
 import { SfCommand } from '@salesforce/sf-plugins-core';
-import { Flags } from '@oclif/core';
-import { Plugin } from '@oclif/core/lib/interfaces/plugin';
+import { Flags, Interfaces } from '@oclif/core';
 import { Messages, SfError } from '@salesforce/core';
 import { AnyJson, Dictionary, ensure, getString, JsonMap } from '@salesforce/ts-types';
 import chalk = require('chalk');
 import { Ditamap } from '../../ditamap/ditamap';
 import { Docs } from '../../docs';
-import { events, mergeDeep } from '../../utils';
+import { events, mergeDeep, CommandClass } from '../../utils';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const uniqBy = require('lodash.uniqby');
@@ -74,6 +73,7 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
       const ignore = [
         /@oclif/,
         /@salesforce\/cli/,
+        /@salesforce\/plugin-dev/,
         /@salesforce\/plugin-telemetry/,
         /@salesforce\/plugin-command-reference/,
       ];
@@ -144,7 +144,7 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
   private pluginMap(plugins: string[]) {
     const pluginToParentPlugin: JsonMap = {};
 
-    const resolveChildPlugins = (parentPlugin: Plugin) => {
+    const resolveChildPlugins = (parentPlugin: Interfaces.Plugin) => {
       for (const childPlugin of parentPlugin.pjson.oclif.plugins || []) {
         pluginToParentPlugin[childPlugin] = parentPlugin.name;
         resolveChildPlugins(ensure(this.getPlugin(childPlugin)));
@@ -184,7 +184,7 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
     return topicsMeta;
   }
 
-  private async loadCommands() {
+  private async loadCommands(): Promise<CommandClass[]> {
     const promises = this.config.commands.map(async (cmd) => {
       try {
         let commandClass = await this.loadCommand(cmd);
@@ -202,14 +202,14 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
 
         return obj;
       } catch (error) {
-        return Object.assign({} as JsonMap, cmd);
+        return Object.assign({}, cmd);
       }
     });
     const commands = await Promise.all(promises);
     return uniqBy(commands, 'id');
   }
 
-  private async loadCommand(command) {
+  private async loadCommand(command: Interfaces.Command.Loadable): Promise<Interfaces.Command.Class> {
     return command.load.constructor.name === 'AsyncFunction' ? await command.load() : command.load();
   }
 

src/ditamap/command.ts

@@ -15,7 +15,7 @@ import {
   ensureString,
   JsonMap,
 } from '@salesforce/ts-types';
-import { events, punctuate } from '../utils';
+import { CommandClass, events, punctuate } from '../utils';
 import { Ditamap } from './ditamap';
 
 export type CommandHelpInfo = {
@@ -47,7 +47,7 @@ const getDefault = async (flag: CommandHelpInfo): Promise<string> => {
 export class Command extends Ditamap {
   private flags: Dictionary<CommandHelpInfo>;
 
-  public constructor(topic: string, subtopic: string, command: Dictionary, commandMeta: JsonMap = {}) {
+  public constructor(topic: string, subtopic: string, command: CommandClass, commandMeta: JsonMap = {}) {
     const commandWithUnderscores = ensureString(command.id).replace(/:/g, '_');
     const filename = Ditamap.file(`cli_reference_${commandWithUnderscores}`, 'xml');
 
@@ -109,7 +109,7 @@ export class Command extends Ditamap {
       isBetaCommand: state === 'beta',
       trailblazerCommunityUrl,
       trailblazerCommunityName,
-    }) as JsonMap;
+    });
 
     this.destination = join(Ditamap.outputDir, topic, filename);
   }

src/ditamap/main-topic-intro.ts

@@ -6,16 +6,16 @@
  */
 
 import { join } from 'path';
-import { asString, ensureJsonMap, JsonMap } from '@salesforce/ts-types';
+import { AnyJson, asString, ensureJsonMap, JsonMap } from '@salesforce/ts-types';
 import { punctuate } from '../utils';
 import { Ditamap } from './ditamap';
 
 export class MainTopicIntro extends Ditamap {
   public constructor(topic: string, subtopic: string, subTopicMeta: JsonMap) {
     const filename = Ditamap.file(`cli_reference_${topic}_${subtopic}`, 'xml');
 
-    let trailblazerCommunityUrl;
-    let trailblazerCommunityName;
+    let trailblazerCommunityUrl: AnyJson;
+    let trailblazerCommunityName: AnyJson;
     if (subTopicMeta.trailblazerCommunityLink) {
       const community = ensureJsonMap(subTopicMeta.trailblazerCommunityLink);
       trailblazerCommunityUrl = community.url;

src/docs.ts

@@ -6,7 +6,6 @@
  */
 
 import * as mkdirp from 'mkdirp';
-import { Plugin } from '@oclif/config';
 import {
   asString,
   Dictionary,
@@ -23,7 +22,7 @@ import { CLIReference } from './ditamap/cli-reference';
 import { Command } from './ditamap/command';
 import { TopicCommands } from './ditamap/topic-commands';
 import { TopicDitamap } from './ditamap/topic-ditamap';
-import { events, punctuate } from './utils';
+import { CommandClass, events, punctuate } from './utils';
 import { HelpReference } from './ditamap/help-reference';
 
 function emitNoTopicMetadataWarning(topic: string): void {
@@ -44,14 +43,14 @@ export class Docs {
     private cliMeta: JsonMap
   ) {}
 
-  public async build(commands: JsonMap[]): Promise<void> {
+  public async build(commands: CommandClass[]): Promise<void> {
     // Create if doesn't exist
     await mkdirp(this.outputDir);
 
     await this.populateTemplate(commands);
   }
 
-  public async populateTopic(topic: string, subtopics: Dictionary<Dictionary | Dictionary[]>): Promise<any[]> {
+  public async populateTopic(topic: string, subtopics: Dictionary<CommandClass | CommandClass[]>): Promise<any[]> {
     const topicMeta = ensureJsonMap(
       this.topicMeta[topic],
       `No topic meta for ${topic} - add this topic to the oclif section of the package.json.`
@@ -127,8 +126,8 @@ export class Docs {
    * @param commands - The entire set of command data.
    * @returns The commands grouped by topics/subtopic/commands.
    */
-  private groupTopicsAndSubtopics(commands: JsonMap[]) {
-    const topLevelTopics: Dictionary<Dictionary<Dictionary | Dictionary[]>> = {};
+  private groupTopicsAndSubtopics(commands: CommandClass[]): Dictionary<Dictionary<CommandClass | CommandClass[]>> {
+    const topLevelTopics: Dictionary<Dictionary<CommandClass | CommandClass[]>> = {};
 
     for (const command of commands) {
       if (command.hidden && !this.hidden) {
@@ -137,7 +136,7 @@ export class Docs {
       const commandParts = ensureString(command.id).split(':');
       const topLevelTopic = commandParts[0];
 
-      const plugin = command.plugin as unknown as Plugin;
+      const plugin = command.plugin;
       if (this.plugins[plugin.name]) {
         // Also include the namespace on the commands so we don't need to do the split at other times in the code.
         command.topic = topLevelTopic;
@@ -179,7 +178,7 @@ export class Docs {
     return topLevelTopics;
   }
 
-  private async populateTemplate(commands: JsonMap[]) {
+  private async populateTemplate(commands: CommandClass[]) {
     const topicsAndSubtopics = this.groupTopicsAndSubtopics(commands);
 
     await new CLIReference().write();
@@ -234,7 +233,7 @@ export class Docs {
     return commandMeta;
   }
 
-  private async populateCommand(topic: string, subtopic: string, command: Dictionary, commandMeta: JsonMap) {
+  private async populateCommand(topic: string, subtopic: string, command: CommandClass, commandMeta: JsonMap) {
     // If it is a hidden command - abort
     if (command.hidden && !this.hidden) {
       return '';

src/utils.ts

@@ -7,7 +7,10 @@
 
 import { EventEmitter } from 'events';
 import { EOL } from 'os';
-import { Dictionary, isObject } from '@salesforce/ts-types';
+import { Dictionary, isObject, JsonMap } from '@salesforce/ts-types';
+import { Interfaces } from '@oclif/core';
+
+export type CommandClass = Interfaces.Command.Class & { topic: string; subtopic: string } & JsonMap;
 
 export const events = new EventEmitter();