fix: add support all properties for a command class in manifest

@W-9791511@

Author: peternhale

src/config/config.ts

@@ -586,7 +586,7 @@ export async function toCached(c: Command.Class, plugin?: IPlugin): Promise<Comm
 
   const args = await Promise.all(argsPromise)
 
-  return {
+  const stdProperties = {
     id: c.id,
     summary: c.summary,
     description: c.description,
@@ -602,4 +602,15 @@ export async function toCached(c: Command.Class, plugin?: IPlugin): Promise<Comm
     flags,
     args,
   }
+
+  // do not include these properties in manifest
+  const ignoreCommandProperties = ['plugin', '_flags']
+  const stdKeys = Object.keys(stdProperties)
+  const keysToAdd = Object.keys(c).filter(property => ![...stdKeys, ...ignoreCommandProperties].includes(property))
+  const additionalProperties: any = {}
+  keysToAdd.forEach(key => {
+    additionalProperties[key] = (c as any)[key]
+  })
+
+  return {...stdProperties, ...additionalProperties}
 }

src/help/command.ts

@@ -4,7 +4,7 @@ import stripAnsi = require('strip-ansi')
 import {castArray, compact, sortBy} from '../util'
 import * as Interfaces from '../interfaces'
 import {Example} from '../interfaces/command'
-import {HelpFormatter} from './formatter'
+import {HelpFormatter, HelpSection, HelpSectionRenderer} from './formatter'
 import {DocOpts} from './docopts'
 
 // Don't use os.EOL because we need to ensure that a string
@@ -22,10 +22,6 @@ let {
 if (process.env.ConEmuANSI === 'ON') {
   dim = Chalk.gray
 }
-
-export type HelpSection = {header: string; body: string | [string, string | undefined][] | undefined} | undefined;
-export type HelpSectionRenderer = (data: {cmd: Interfaces.Command; flags: Interfaces.Command.Flag[]; args: Interfaces.Command.Arg[]}, header: string) => HelpSection[] | string | undefined;
-
 export class CommandHelp extends HelpFormatter {
   constructor(
     public command: Interfaces.Command,
@@ -57,7 +53,7 @@ export class CommandHelp extends HelpFormatter {
 
   protected groupFlags(flags: Interfaces.Command.Flag[]) {
     const mainFlags: Interfaces.Command.Flag[] = []
-    const flagGroups: {[index: string]: Interfaces.Command.Flag[]} = {}
+    const flagGroups: { [index: string]: Interfaces.Command.Flag[] } = {}
 
     for (const flag of flags) {
       const group = flag.helpGroup
@@ -72,7 +68,7 @@ export class CommandHelp extends HelpFormatter {
     return {mainFlags, flagGroups}
   }
 
-  protected sections(): Array<{header: string; generate: HelpSectionRenderer}> {
+  protected sections(): Array<{ header: string; generate: HelpSectionRenderer }> {
     return [
       {
         header: this.opts.usageHeader || 'USAGE',
@@ -131,7 +127,7 @@ export class CommandHelp extends HelpFormatter {
       if (line.length > allowedSpacing) {
         const splitIndex = line.substring(0, allowedSpacing).lastIndexOf(' ')
         return line.substring(0, splitIndex) + '\n' +
-          this.indent(this.wrap(line.substring(splitIndex), this.indentSpacing * 2))
+            this.indent(this.wrap(line.substring(splitIndex), this.indentSpacing * 2))
       }
       return this.wrap(line)
     })

src/help/formatter.ts

@@ -14,6 +14,10 @@ const {
   bold,
 } = Chalk
 
+export type HelpSectionKeyValueTable = {name: string; description: string}[]
+export type HelpSection = {header: string; body: string | HelpSectionKeyValueTable | [string, string | undefined][] | undefined} | undefined;
+export type HelpSectionRenderer = (data: {cmd: Interfaces.Command; flags: Interfaces.Command.Flag[]; args: Interfaces.Command.Arg[]}, header: string) => HelpSection | HelpSection[] | string | undefined;
+
 export class HelpFormatter {
   indentSpacing = 2
 
@@ -163,13 +167,31 @@ export class HelpFormatter {
     return output.trim()
   }
 
-  public section(header: string, body: string | [string, string | undefined][]) {
+  public section(header: string, body: string | HelpSection | HelpSectionKeyValueTable | [string, string | undefined][]): string {
     // Always render template strings with the provided render function before wrapping and indenting
-    body = Array.isArray(body) ? body.map(([left, right]) => ([this.render(left), right && this.render(right)])) : this.render(body)
+    let newBody: any
+    if (typeof body! === 'string') {
+      newBody = this.render(body!)
+    } else if (Array.isArray(body)) {
+      newBody = (body! as [string, string | undefined | HelpSectionKeyValueTable][]).map(entry => {
+        if ('name' in entry) {
+          const tableEntry = entry as unknown as {name: string; description: string}
+          return ([this.render(tableEntry.name), this.render(tableEntry.description)])
+        }
+        const [left, right] = entry
+        return ([this.render(left), right && this.render(right as string)])
+      })
+    } else if ('header' in body!) {
+      return this.section(body!.header, body!.body)
+    } else {
+      newBody = (body! as unknown as HelpSectionKeyValueTable)
+      .map((entry: { name: string; description: string }) => ([entry.name, entry.description]))
+      .map(([left, right]) => ([this.render(left), right && this.render(right)]))
+    }
 
     const output = [
       bold(header),
-      this.indent(Array.isArray(body) ? this.renderList(body, {stripAnsi: this.opts.stripAnsi, indentation: 2}) : body),
+      this.indent(Array.isArray(newBody) ? this.renderList(newBody, {stripAnsi: this.opts.stripAnsi, indentation: 2}) : newBody),
     ].join('\n')
     return this.opts.stripAnsi ? stripAnsi(output) : output
   }

src/index.ts

@@ -7,22 +7,27 @@ import {Config, Plugin, tsPath, toCached} from './config'
 import * as Interfaces from './interfaces'
 import * as Errors from './errors'
 import * as Flags from './flags'
-import {HelpBase, Help, loadHelpClass} from './help'
+import {CommandHelp, HelpBase, Help, loadHelpClass} from './help'
 import {toStandardizedId, toConfiguredId} from './help/util'
 import * as Parser from './parser'
 import {Hook} from './interfaces/hooks'
 import {settings, Settings} from './settings'
+import {HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable} from './help/formatter'
 
 const flush = require('../flush')
 
 export {
   Command,
+  CommandHelp,
   Config,
   Errors,
   Flags,
   loadHelpClass,
   Help,
   HelpBase,
+  HelpSection,
+  HelpSectionRenderer,
+  HelpSectionKeyValueTable,
   Hook,
   Interfaces,
   Parser,

src/interfaces/command.ts

@@ -52,6 +52,7 @@ export interface CommandProps {
    * ```
    */
   examples?: Example[];
+
 }
 
 export interface Command extends CommandProps {

test/help/format-commands.test.ts

@@ -34,12 +34,16 @@ describe('formatCommand', () => {
   .it('outputs an empty string when no commands are given', (ctx: any) => expect(ctx.output).to.equal(''))
 
   test
+  // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+  // @ts-ignore
   .formatCommands([AppsDestroy, AppsCreate])
   .it('shows a list of the provided commands', (ctx: any) => expect(ctx.output).to.equal(`COMMANDS
   apps:destroy  Destroy an app
   apps:create   Create an app`))
 
   test
+  // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+  // @ts-ignore
   .formatCommands([class extends Command {
     static id = 'hello:world'