fix: remove async handlebars

Author: mdonnalley

package.json

@@ -13,7 +13,6 @@
     "chalk": "^3.0.0",
     "fs-extra": "^10.0.1",
     "handlebars": "^4.7.7",
-    "handlebars-async-helpers": "^1.0.3",
     "lodash.uniqby": "^4.7.0",
     "mkdirp": "^1.0.4",
     "tslib": "^2"

src/ditamap/command.ts

@@ -25,17 +25,35 @@ export type CommandHelpInfo = {
   required: boolean;
   kind: string;
   type: string;
+  defaultHelpValue?: string;
+  default: string | (() => Promise<string>);
+};
+
+const getDefault = async (flag: CommandHelpInfo): Promise<string> => {
+  if (typeof flag.default !== 'function') {
+    return flag.default;
+  } else if (typeof flag.default === 'function') {
+    try {
+      const help = await flag.default();
+      return help || '';
+    } catch {
+      return '';
+    }
+  } else {
+    return '';
+  }
 };
 
 export class Command extends Ditamap {
+  private flags: Dictionary<CommandHelpInfo>;
+
   public constructor(topic: string, subtopic: string, command: Dictionary, commandMeta: JsonMap = {}) {
     const commandWithUnderscores = ensureString(command.id).replace(/:/g, '_');
     const filename = Ditamap.file(`cli_reference_${commandWithUnderscores}`, 'xml');
 
     super(filename, {});
 
-    const flags = ensureObject(command.flags);
-    const parameters = this.getParametersForTemplate(flags as Dictionary<CommandHelpInfo>);
+    this.flags = ensureObject(command.flags);
 
     const summary = punctuate(asString(command.summary));
 
@@ -86,7 +104,6 @@ export class Command extends Ditamap {
       summary,
       description,
       help,
-      parameters,
       isClosedPilotCommand: state === 'closedPilot',
       isOpenPilotCommand: state === 'openPilot',
       isBetaCommand: state === 'beta',
@@ -97,24 +114,35 @@ export class Command extends Ditamap {
     this.destination = join(Ditamap.outputDir, topic, filename);
   }
 
-  public getParametersForTemplate(flags: Dictionary<CommandHelpInfo>) {
-    return Object.entries(flags)
-      .filter(([, flag]) => !flag.hidden)
-      .map(([flagName, flag]) => {
-        const description = Array.isArray(flag.description) ? flag.description.join('\n') : flag.description || '';
-        const entireDescription = flag.summary ? `${flag.summary}\n${description}` : description;
-
-        return Object.assign(flag, {
-          name: flagName,
-          description: this.formatParagraphs(entireDescription),
-          optional: !flag.required,
-          kind: flag.kind || flag.type,
-          hasValue: flag.type !== 'boolean',
-        });
+  public async getParametersForTemplate(flags: Dictionary<CommandHelpInfo>) {
+    const final = [] as CommandHelpInfo[];
+
+    for (const [flagName, flag] of Object.entries(flags)) {
+      if (flag.hidden) continue;
+      const description = Array.isArray(flag.description) ? flag.description.join('\n') : flag.description || '';
+      const entireDescription = flag.summary ? `${flag.summary}\n${description}` : description;
+      const updated = Object.assign(flag, {
+        name: flagName,
+        description: this.formatParagraphs(entireDescription),
+        optional: !flag.required,
+        kind: flag.kind || flag.type,
+        hasValue: flag.type !== 'boolean',
+        defaultFlagValue: await getDefault(flag),
       });
+      final.push(updated);
+    }
+    return final;
   }
 
   public getTemplateFileName(): string {
     return 'command.hbs';
   }
+
+  protected async transformToDitamap() {
+    // eslint-disable-next-line no-console
+    console.log('transformToDitamap');
+    const parameters = await this.getParametersForTemplate(this.flags);
+    this.data = Object.assign({}, this.data, { parameters });
+    return super.transformToDitamap();
+  }
 }

src/ditamap/ditamap.ts

@@ -10,29 +10,10 @@ import * as fs from 'fs/promises';
 import * as mkdirp from 'mkdirp';
 import { JsonMap } from '@salesforce/ts-types';
 import * as debugCreator from 'debug';
-import * as handlebars from 'handlebars';
-import * as asyncHelpers from 'handlebars-async-helpers';
-
-const hb = asyncHelpers(handlebars);
+import * as hb from 'handlebars';
 
 const debug = debugCreator('commandreference');
 
-const getDefault = async (flag: { default: () => any }): Promise<string> => {
-  if (typeof flag.default !== 'function') {
-    return new hb.SafeString(`<dd>Default value: ${flag.default}</dd>`);
-  } else if (typeof flag.default === 'function') {
-    try {
-      const help = await flag.default();
-      if (!help) return '';
-      return new hb.SafeString(`<dd>Default value: ${help}</dd>`);
-    } catch {
-      return '';
-    }
-  } else {
-    return '';
-  }
-};
-
 hb.registerHelper('toUpperCase', (str) => str.toUpperCase());
 hb.registerHelper('join', (array) => array.join(', '));
 hb.registerHelper('xmlFile', (...strings) => {
@@ -44,20 +25,6 @@ hb.registerHelper('uniqueId', (...strings) => {
   return Ditamap.file(parts.join('_'), 'xml').replace('.xml', '');
 });
 
-hb.registerHelper('getDefault', async function (flag) {
-  return getDefault(flag);
-});
-
-hb.registerHelper('hasDefault', async function (flag) {
-  if (!flag.default) {
-    return false;
-  } else if (Array.isArray(flag.default)) {
-    return flag.default.length > 0;
-  } else {
-    return !!flag.default && !!(await getDefault(flag));
-  }
-});
-
 /*
  * Returns true if the string should be formatted as code block in docs
  */
@@ -137,10 +104,10 @@ export abstract class Ditamap {
    * @param templateName
    * @returns {object}
    */
-  private async transformToDitamap() {
+  protected async transformToDitamap() {
     debug(`Generating ${this.destination} from ${this.getTemplateFileName()}`);
     const src = await fs.readFile(this.source, 'utf8');
-    const template = hb.compile(src);
+    const template = hb.compile(src, { noEscape: false });
     return template(this.data);
   }
 }

templates/command.hbs

@@ -100,8 +100,8 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT [email protected] FOR D
                     {{/if}}<dd>{{#if optional}}Optional{{else}}Required{{/if}}</dd>
                     <dd>{{#each description}}<p>{{[]}}</p>{{/each}}</dd>{{#if kind}}
                     <dd>Type: {{kind}}</dd>{{/if}}{{#if options}}
-                    <dd>Permissible values are: {{join options}}</dd>{{/if}}{{#if (hasDefault this)}}
-                    {{getDefault this}}{{/if}}
+                    <dd>Permissible values are: {{join options}}</dd>{{/if}}{{#if defaultFlagValue}}
+                    <dd>{{defaultFlagValue}}</dd>{{/if}}
                 </dlentry>
                 {{/each}}
             </dl>

yarn.lock

@@ -3920,11 +3920,6 @@ [email protected]:
   resolved "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz#f2735dc2283674fa67478b10181059355c369e5e"
   integrity sha512-qBr4OuELkhPenW6goKVXiv47US3clb3/IbuWF9KNKEijAy9oeHxU9IgzjvJhHkUzhaj7rOUD7+YGWqUjLp5oSA==
 
-handlebars-async-helpers@^1.0.3:
-  version "1.0.3"
-  resolved "https://registry.npmjs.org/handlebars-async-helpers/-/handlebars-async-helpers-1.0.3.tgz#30cfa24b1d32d4b7073909a38dacf6cac88901be"
-  integrity sha512-t2zkA054ZxkXdtDeGbHTDP9rtbabzF8iHYY46+FhzqTNaw22l0WlcNpnb36vKAv1M22MnLA1i/LUIH3A74dl1g==
-
 handlebars@^4.7.7:
   version "4.7.7"
   resolved "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz#9ce33416aad02dbd6c8fafa8240d5d98004945a1"