chore: apply review suggestions

Author: peternhale

.eslintrc.js

@@ -7,17 +7,7 @@
 module.exports = {
   extends: ['eslint-config-salesforce-typescript', 'eslint-config-salesforce-license'],
   rules: {
-    // '@typescript-eslint/restrict-template-expressions': 'off',
-    // '@typescript-eslint/explicit-function-return-type': 'off',
-    // '@typescript-eslint/no-unsafe-assignment': 'off',
-    // '@typescript-eslint/no-unsafe-member-access': 'off',
-    // '@typescript-eslint/no-unsafe-call': 'off',
-    // '@typescript-eslint/no-unsafe-return': 'off',
-    // '@typescript-eslint/member-ordering': 'off',
     'no-underscore-dangle': 'off',
-    // '@typescript-eslint/explicit-module-boundary-types': 'off',
-    // 'no-empty': 'off',
-    // '@typescript-eslint/no-explicit-any': 'off',
     'jsdoc/newline-after-description': 'off',
   },
 };

.gitignore

@@ -10,7 +10,6 @@ package-lock.json
 npm-error.log
 yarn-error.log
 lerna-debug.log
-*.tsbuildinfo
 
 # compile source
 lib
@@ -26,6 +25,7 @@ coverage
 docs
 
 # -- CLEAN ALL
+*.tsbuildinfo
 .eslintcache
 .wireit
 node_modules

src/commands/commandreference/generate.ts

@@ -6,6 +6,7 @@
  */
 
 import * as fs from 'fs/promises';
+import { existsSync } from 'fs';
 import * as os from 'os';
 import * as path from 'path';
 import { SfCommand } from '@salesforce/sf-plugins-core';
@@ -22,12 +23,6 @@ import { CommandClass, events } from '../../utils';
 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');
 
@@ -65,7 +60,7 @@ 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 fileExists(pJsonPath)) {
+      if (existsSync(pJsonPath)) {
         const packageJson = parseJsonMap(await fs.readFile(pJsonPath, 'utf-8'));
         pluginNames = [ensureString(packageJson.name)];
       } else {
@@ -125,8 +120,7 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
       this.loadCliMeta()
     );
 
-    events.on('topic', ({ topic }) => {
-      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+    events.on('topic', ({ topic }: { topic: string }) => {
       this.log(chalk.green(`Generating topic '${topic}'`));
     });
 
@@ -148,8 +142,8 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
     return { warnings };
   }
 
-  private pluginMap(plugins: string[]): JsonMap {
-    const pluginToParentPlugin: JsonMap = {};
+  private pluginMap(plugins: string[]): Record<string, unknown> {
+    const pluginToParentPlugin: Record<string, unknown> = {};
 
     const resolveChildPlugins = (parentPlugin: Interfaces.Plugin): void => {
       for (const childPlugin of parentPlugin.pjson.oclif.plugins ?? []) {

src/ditamap/command.ts

@@ -40,7 +40,12 @@ const getDefault = async (flag?: CommandHelpInfo): Promise<string> => {
 export class Command extends Ditamap {
   private flags: Dictionary<CommandHelpInfo>;
 
-  public constructor(topic: string, subtopic: string | null, command: CommandClass, commandMeta: JsonMap = {}) {
+  public constructor(
+    topic: string,
+    subtopic: string | null,
+    command: CommandClass,
+    commandMeta: Record<string, unknown> = {}
+  ) {
     const commandWithUnderscores = ensureString(command.id).replace(/:/g, '_');
     const filename = Ditamap.file(`cli_reference_${commandWithUnderscores}`, 'xml');
 
@@ -69,8 +74,8 @@ export class Command extends Ditamap {
     const commandName = command.id.replace(/:/g, asString(commandMeta.topicSeparator, ':'));
 
     const examples = (command.examples ?? []).map((example) => {
-      let desc: string | null = null;
-      let commands: string[] = [];
+      let desc: string | null;
+      let commands: string[];
       if (typeof example === 'string') {
         const parts = example.split('\n');
         desc = parts.length > 1 ? parts[0] : null;

src/ditamap/ditamap.ts

@@ -46,7 +46,7 @@ export abstract class Ditamap {
 
   public static cliVersion: string;
 
-  public static plugins: JsonMap;
+  public static plugins: Record<string, unknown>;
 
   public static pluginVersions: Array<{
     name: string;

src/docs.ts

@@ -13,6 +13,7 @@ import {
   ensure,
   ensureArray,
   ensureJsonMap,
+  ensureObject,
   ensureString,
   isArray,
   JsonMap,
@@ -38,10 +39,10 @@ function emitNoTopicMetadataWarning(topic: string): void {
 export class Docs {
   public constructor(
     private outputDir: string,
-    private plugins: JsonMap,
+    private plugins: Record<string, unknown>,
     private hidden: boolean,
-    private topicMeta: JsonMap,
-    private cliMeta: JsonMap
+    private topicMeta: Record<string, unknown>,
+    private cliMeta: Record<string, unknown>
   ) {}
 
   public async build(commands: CommandClass[]): Promise<void> {
@@ -164,8 +165,8 @@ export class Docs {
           const subtopic = commandParts[1];
 
           try {
-            const topicMeta = ensureJsonMap(this.topicMeta[topLevelTopic]);
-            const subTopicsMeta = ensureJsonMap(topicMeta.subtopics);
+            const topicMeta = ensureObject<Record<string, unknown>>(this.topicMeta[topLevelTopic]);
+            const subTopicsMeta = ensureObject<Record<string, unknown>>(topicMeta.subtopics);
             if (subTopicsMeta.hidden && !this.hidden) {
               continue;
             }
@@ -210,19 +211,23 @@ export class Docs {
     }
   }
 
-  private resolveCommandMeta(commandId: string, command: CommandClass, commandsInTopic: number): JsonMap {
+  private resolveCommandMeta(
+    commandId: string,
+    command: CommandClass,
+    commandsInTopic: number
+  ): Record<string, unknown> {
     const commandMeta = Object.assign({}, this.cliMeta);
     // Remove top level topic, since the topic meta is already for that topic
     const commandParts = commandId.split(':');
     let part;
     try {
-      let currentMeta: JsonMap | undefined;
+      let currentMeta: Record<string, unknown> | undefined;
       for (part of commandParts) {
         if (currentMeta) {
-          const subtopics = ensureJsonMap(currentMeta.subtopics);
-          currentMeta = ensureJsonMap(subtopics[part]);
+          const subtopics = ensureObject<Record<string, unknown>>(currentMeta.subtopics);
+          currentMeta = ensureObject<Record<string, unknown>>(subtopics[part]);
         } else {
-          currentMeta = ensureJsonMap(this.topicMeta[part]);
+          currentMeta = ensureObject<Record<string, unknown>>(this.topicMeta[part]);
         }
 
         // Collect all tiers of the meta, so the command will also pick up the topic state (isPilot, etc) if applicable
@@ -249,7 +254,7 @@ export class Docs {
     topic: string,
     subtopic: string | null,
     command: CommandClass,
-    commandMeta: JsonMap
+    commandMeta: Record<string, unknown>
   ): Promise<string> {
     // If it is a hidden command - abort
     if (command.hidden && !this.hidden) {