fix: add back tests and allow for external topics

Author: amphro

package.json

@@ -22,6 +22,7 @@
     "@semantic-release/changelog": "^5.0.0",
     "@semantic-release/git": "^9.0.0",
     "husky": "^4.2.3",
+    "salesforcedx": "^48.4.1",
     "semantic-release": "^17.0.4"
   },
   "engines": {
@@ -49,7 +50,8 @@
       }
     },
     "devPlugins": [
-      "@oclif/plugin-help"
+      "@oclif/plugin-help",
+      "salesforcedx"
     ]
   },
   "repository": "forcedotcom/plugin-command-reference",
@@ -62,6 +64,7 @@
     "format": "yarn sfdx-format",
     "lint": "yarn sfdx-lint",
     "postpack": "rm -f oclif.manifest.json",
+    "pretest": "./bin/run commandreference:generate --plugins salesforcedx --outputdir test/tmp",
     "posttest": "tslint -p test -t stylish",
     "prepack": "yarn sfdx-build",
     "test": "yarn sfdx-test",

src/ditamap/command.ts

@@ -26,9 +26,9 @@ export class Command extends Ditamap {
         if (!flag.longDescription) {
           events.emit(
             'warning',
-            `No flag longDescription for command ${chalk.bold(
-              command.id
-            )} on flag ${flagName}. That command owner must add the longDescription to the flag definition.`
+            `No flag longDescription for command "${chalk.bold(command.id)}" on flag "${chalk.bold(
+              flagName
+            )}". That command owner must add the longDescription to the flag definition.`
           );
         }
         return Object.assign(flag, {

src/ditamap/main-topic-intro.ts

@@ -23,7 +23,7 @@ export class MainTopicIntro extends Ditamap {
       trailblazerCommunityName = community.name;
     }
 
-    if (!subTopicMeta.longDescription) {
+    if (!subTopicMeta.longDescription && !subTopicMeta.external) {
       events.emit(
         'warning',
         `No long description for topic ${chalk.bold(

src/docs.ts

@@ -48,7 +48,7 @@ export class Docs {
   public async populateTopic(topic: string, subtopics: Dictionary<Dictionary | Dictionary[]>) {
     const topicMeta = ensureJsonMap(this.topicMeta[topic]);
     let description = asString(topicMeta.longDescription);
-    if (!description) {
+    if (!description && !topicMeta.external) {
       description = asString(topicMeta.description);
       if (!description) {
         events.emit(

test/endtoend.test.ts

@@ -25,15 +25,13 @@ function loadTestDitamapFile(path: string) {
   return readFileSync(join(testFilesPath, path), 'utf8');
 }
 
-describe.skip('salesforcedx', () => {
+describe('salesforcedx', () => {
   before(async () => {
-    await require('@oclif/command').run([
-      'commandreference:generate',
-      '--plugins',
-      'salesforcedx',
-      '--outputdir',
-      testFilesPath
-    ]);
+    try {
+      await fs.access(testFilesPath);
+    } catch (e) {
+      throw new Error('Could not read generated test docs. Ensure the "pretest" has run or run it manually.');
+    }
   });
   after(async () => {
     await fs.remove(testFilesPath);