@salesforce/plugin-command-reference 2.4.4 → 2.4.6

package/lib/utils.d.ts

@@ -1,12 +1,86 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
-import { Dictionary, JsonMap } from '@salesforce/ts-types';
-import { Command } from '@oclif/core';
-export type CommandClass = Command.Class & {
+import { Command, Interfaces } from '@oclif/core';
+import { AnyJson } from '@salesforce/ts-types';
+export type CommandClass = Pick<Command.Class, 'id' | 'hidden' | 'description' | 'plugin' | 'state' | 'examples' | 'summary' | 'flags' | 'pluginName'> & {
     topic: string;
     subtopic: string;
-} & JsonMap;
+    longDescription?: string;
+    binary: string;
+    deprecated?: boolean;
+};
 export declare const events: EventEmitter;
-export declare function mergeDeep(target: Dictionary, source: Dictionary): Dictionary;
-export declare function punctuate(description: string): string;
-export declare function helpFromDescription(description: string): string;
+export declare function punctuate(description?: string): string | undefined;
+export declare const replaceConfigVariables: (text: string, bin: string, id: string) => string;
+export type CliMeta = {
+    binary: string;
+    topicSeparator?: string;
+    state?: string;
+    description?: string;
+    longDescription?: string | AnyJson;
+};
+type PluginVersion = {
+    name: string;
+    version: string;
+};
+type BaseDitamapData = {
+    namespaceDitamapFiles: string[];
+};
+type CliRefData = {
+    cliVersion: string;
+    pluginVersions: PluginVersion[];
+};
+type CliRefHelpData = {
+    id: string;
+};
+type ClIRefTopicData = {
+    topic: string;
+    longDescription?: string;
+};
+export type CommandParameterData = {
+    optional?: boolean;
+    char?: string;
+    name: string;
+    hasValue?: boolean;
+    deprecated?: {
+        version: string;
+        to: string;
+    };
+    kind?: string;
+    options?: string[];
+    defaultFlagValue?: string;
+    aliases?: string[];
+};
+export type DitamapData = CliRefHelpData | BaseDitamapData | CliRefData | ClIRefTopicData | CommandData | SfTopic | TopicDitamapData | undefined;
+export type CommandData = {
+    name: string;
+    summary?: string;
+    description?: string;
+    binary: string;
+    commandWithUnderscores: string;
+    isClosedPilotCommand: boolean;
+    isOpenPilotCommand: boolean;
+    isBetaCommand: boolean;
+    deprecated: boolean;
+    trailblazerCommunityUrl?: string;
+    trailblazerCommunityName?: string;
+    help?: string[];
+    examples?: unknown[];
+    parameters?: CommandParameterData[];
+};
+type TopicDitamapData = {
+    topic: string;
+    commands: Array<{
+        command: string;
+    }>;
+};
+export type SfTopic = Interfaces.Topic & {
+    external?: boolean;
+    trailblazerCommunityLink?: {
+        url: string;
+        name: string;
+    };
+    subtopics?: SfTopics;
+};
+export type SfTopics = Map<string, SfTopic>;
+export {};

package/lib/utils.js

@@ -6,37 +6,22 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.helpFromDescription = exports.punctuate = exports.mergeDeep = exports.events = void 0;
+exports.replaceConfigVariables = exports.punctuate = exports.events = void 0;
 const events_1 = require("events");
 const os_1 = require("os");
-const ts_types_1 = require("@salesforce/ts-types");
 exports.events = new events_1.EventEmitter();
-function mergeDeep(target, source) {
-    Object.keys(source).forEach((key) => {
-        if ((0, ts_types_1.isObject)(target[key]) && (0, ts_types_1.isObject)(source[key])) {
-            mergeDeep(target[key], source[key]);
-        }
-        else {
-            target[key] = source[key];
-        }
-    });
-    return target;
-}
-exports.mergeDeep = mergeDeep;
 function punctuate(description) {
     if (!description)
         return description;
     const lines = description.split(os_1.EOL);
     let mainDescription = lines[0];
     mainDescription = mainDescription.charAt(0).toUpperCase() + mainDescription.substring(1);
-    if (mainDescription.charAt(mainDescription.length - 1) !== '.') {
+    if (!mainDescription.endsWith('.')) {
         mainDescription += '.';
     }
     return mainDescription;
 }
 exports.punctuate = punctuate;
-function helpFromDescription(description) {
-    return description ? description.split(os_1.EOL).slice(1).join(os_1.EOL).trim() : '';
-}
-exports.helpFromDescription = helpFromDescription;
+const replaceConfigVariables = (text, bin, id) => text.replace(/<%= config.bin %>/g, bin ?? 'unknown').replace(/<%= command.id %>/g, id);
+exports.replaceConfigVariables = replaceConfigVariables;
 //# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mCAAsC;AACtC,2BAAyB;AACzB,mDAAqE;AAKxD,QAAA,MAAM,GAAG,IAAI,qBAAY,EAAE,CAAC;AAEzC,SAAgB,SAAS,CAAC,MAAkB,EAAE,MAAkB;IAC9D,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAClC,IAAI,IAAA,mBAAQ,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,IAAA,mBAAQ,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;YAClD,SAAS,CAAC,MAAM,CAAC,GAAG,CAAe,EAAE,MAAM,CAAC,GAAG,CAAe,CAAC,CAAC;SACjE;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;SAC3B;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AATD,8BASC;AAED,SAAgB,SAAS,CAAC,WAAmB;IAC3C,IAAI,CAAC,WAAW;QAAE,OAAO,WAAW,CAAC;IAErC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,QAAG,CAAC,CAAC;IACrC,IAAI,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE/B,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEzF,IAAI,eAAe,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;QAC9D,eAAe,IAAI,GAAG,CAAC;KACxB;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAbD,8BAaC;AAED,SAAgB,mBAAmB,CAAC,WAAmB;IACrD,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,QAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAC7E,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mCAAsC;AACtC,2BAAyB;AASZ,QAAA,MAAM,GAAG,IAAI,qBAAY,EAAE,CAAC;AAEzC,SAAgB,SAAS,CAAC,WAAoB;IAC5C,IAAI,CAAC,WAAW;QAAE,OAAO,WAAW,CAAC;IAErC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,QAAG,CAAC,CAAC;IACrC,IAAI,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE/B,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEzF,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAClC,eAAe,IAAI,GAAG,CAAC;KACxB;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAbD,8BAaC;AAEM,MAAM,sBAAsB,GAAG,CAAC,IAAY,EAAE,GAAW,EAAE,EAAU,EAAU,EAAE,CACtF,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,IAAI,SAAS,CAAC,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;AAD5E,QAAA,sBAAsB,0BACsD"}

package/messages/main.md

@@ -0,0 +1,53 @@
+# commandSummary
+
+generate the command reference guide located
+
+# commandDescription
+
+generate the command reference guide located
+
+# pluginFlagSummary
+
+comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory
+
+# allFlagSummary
+
+include all relevant plugins in the generation
+
+# hiddenFlagSummary
+
+show hidden commands
+
+# outputdirFlagSummary
+
+output directory to put generated files
+
+# erroronwarningFlagSummary
+
+fail the command if there are any warnings
+
+# ditamapSuffixFlagSummary
+
+unique suffix to append to generated ditamap
+
+# configPathFlagSummary
+
+A path to the directory containing a plugin or cli
+
+# examples
+
+- Generate the command reference guide
+
+  <%= config.bin %> <%= command.id %>
+
+- Generate the command reference for a set of plugins
+
+  <%= config.bin %> <%= command.id %> --plugins pluginA,pluginB
+
+- Generate the command reference for all plugins
+
+  <%= config.bin %> <%= command.id %> --all --output-dir ./docs
+
+- Generate the command reference for all plugins in a directory
+
+  <%= config.bin %> <%= command.id %> --all --config-path /path/to/plugin --output-dir ./docs

package/oclif.manifest.json

@@ -1,14 +1,21 @@
 {
-  "version": "2.4.4",
+  "version": "2.4.6",
   "commands": {
     "commandreference:generate": {
       "id": "commandreference:generate",
+      "summary": "generate the command reference guide located",
       "description": "generate the command reference guide located",
       "strict": true,
       "pluginName": "@salesforce/plugin-command-reference",
       "pluginAlias": "@salesforce/plugin-command-reference",
       "pluginType": "core",
       "aliases": [],
+      "examples": [
+        "Generate the command reference guide\n<%= config.bin %> <%= command.id %>",
+        "Generate the command reference for a set of plugins\n<%= config.bin %> <%= command.id %> --plugins pluginA,pluginB",
+        "Generate the command reference for all plugins\n<%= config.bin %> <%= command.id %> --all --output-dir ./docs",
+        "Generate the command reference for all plugins in a directory\n<%= config.bin %> <%= command.id %> --all --config-path /path/to/plugin --output-dir ./docs"
+      ],
       "flags": {
         "json": {
           "name": "json",
@@ -17,19 +24,22 @@
           "helpGroup": "GLOBAL",
           "allowNo": false
         },
-        "outputdir": {
-          "name": "outputdir",
+        "output-dir": {
+          "name": "output-dir",
           "type": "option",
           "char": "d",
-          "description": "output directory to put generated files",
+          "summary": "output directory to put generated files",
           "multiple": false,
-          "default": "./tmp/root"
+          "default": "./tmp/root",
+          "aliases": [
+            "outputdir"
+          ]
         },
         "plugins": {
           "name": "plugins",
           "type": "option",
           "char": "p",
-          "description": "comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory",
+          "summary": "comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory",
           "multiple": true,
           "exclusive": [
             "all"
@@ -39,7 +49,7 @@
           "name": "all",
           "type": "boolean",
           "char": "a",
-          "description": "include all relevant plugins in the generation",
+          "summary": "include all relevant plugins in the generation",
           "allowNo": false,
           "exclusive": [
             "plugins"
@@ -49,21 +59,31 @@
           "name": "ditamap-suffix",
           "type": "option",
           "char": "s",
-          "description": "unique suffix to append to generated ditamap",
+          "summary": "unique suffix to append to generated ditamap",
           "multiple": false,
           "default": "unified"
         },
         "hidden": {
           "name": "hidden",
           "type": "boolean",
-          "description": "show hidden commands",
+          "summary": "show hidden commands",
           "allowNo": false
         },
-        "erroronwarnings": {
-          "name": "erroronwarnings",
+        "error-on-warnings": {
+          "name": "error-on-warnings",
           "type": "boolean",
-          "description": "fail the command if there are any warnings",
-          "allowNo": false
+          "summary": "fail the command if there are any warnings",
+          "allowNo": false,
+          "aliases": [
+            "erroronwarnings"
+          ]
+        },
+        "config-path": {
+          "name": "config-path",
+          "type": "option",
+          "char": "c",
+          "summary": "A path to the directory containing a plugin or cli",
+          "multiple": false
         }
       },
       "args": {}

package/package.json

@@ -1,55 +1,53 @@
 {
   "name": "@salesforce/plugin-command-reference",
   "description": "Generate the Salesforce CLI command reference guide",
-  "version": "2.4.4",
+  "version": "2.4.6",
   "author": "Salesforce",
   "bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
   "dependencies": {
-    "@oclif/core": "^2.0.7",
-    "@salesforce/core": "^3.32.12",
-    "@salesforce/kit": "^1.8.2",
-    "@salesforce/sf-plugins-core": "^2.0.1",
-    "@salesforce/ts-types": "^1.7.1",
+    "@oclif/core": "^2.8.5",
+    "@salesforce/core": "^3.36.0",
+    "@salesforce/kit": "^3.0.0",
+    "@salesforce/sf-plugins-core": "^2.4.2",
+    "@salesforce/ts-types": "^2.0.1",
     "chalk": "^3.0.0",
-    "fs-extra": "^10.0.1",
     "handlebars": "^4.7.7",
-    "lodash.uniqby": "^4.7.0",
-    "mkdirp": "^1.0.4",
     "tslib": "^2"
   },
   "devDependencies": {
-    "@oclif/plugin-help": "^5.1.1",
-    "@salesforce/dev-config": "^3.1.0",
-    "@salesforce/dev-scripts": "^2.0.4",
-    "@salesforce/plugin-login": "^1.1.15",
+    "@oclif/plugin-help": "^5.2.9",
+    "@salesforce/dev-config": "^4.0.1",
+    "@salesforce/dev-scripts": "^5.0.1",
+    "@salesforce/plugin-auth": "^2.7.15",
     "@salesforce/prettier-config": "^0.0.2",
-    "@types/fs-extra": "^9.0.13",
-    "@types/lodash.uniqby": "^4.7.6",
-    "@typescript-eslint/eslint-plugin": "^4.2.0",
-    "@typescript-eslint/parser": "^4.2.0",
+    "@types/debug": "^4.1.7",
+    "@types/ejs": "^3.1.2",
+    "@typescript-eslint/eslint-plugin": "^5.59.2",
+    "@typescript-eslint/parser": "^5.59.2",
     "chai": "^4.2.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.8",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-config-salesforce": "^2.0.1",
+    "eslint-config-salesforce-license": "^0.2.0",
+    "eslint-config-salesforce-typescript": "^1.1.1",
     "eslint-plugin-header": "^3.0.0",
-    "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",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsdoc": "^44.0.0",
+    "eslint-plugin-sf-plugin": "^1.15.2",
+    "husky": "^8.0.3",
+    "mocha": "^10.2.0",
     "nyc": "^15.1.0",
-    "oclif": "^3.6.1",
-    "prettier": "^2.0.5",
+    "oclif": "^3.9.0",
+    "prettier": "^2.8.8",
     "pretty-quick": "^3.1.0",
     "shx": "^0.3.3",
     "sinon": "10.0.0",
     "ts-node": "^10.0.0",
-    "typescript": "^4.1.3"
+    "typescript": "^4.9.5",
+    "wireit": "^0.9.5"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=16.0.0"
   },
   "files": [
     "/lib",
@@ -78,30 +76,133 @@
     },
     "devPlugins": [
       "@oclif/plugin-help",
-      "@salesforce/plugin-login"
+      "@salesforce/plugin-auth"
     ]
   },
   "repository": "salesforcecli/plugin-command-reference",
   "scripts": {
-    "build": "sf-build",
+    "build": "wireit",
     "clean": "sf-clean",
     "clean-all": "sf-clean all",
-    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
-    "command-reference": "./bin/dev commandreference:generate --plugins login --outputdir test/tmp",
-    "compile": "sf-compile",
+    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -rf test/tmp && shx rm -f oclif.manifest.json",
+    "compile": "wireit",
     "docs": "sf-docs",
-    "format": "sf-format",
-    "lint": "sf-lint",
+    "format": "wireit",
+    "lint": "wireit",
     "postpack": "shx rm -f oclif.manifest.json",
-    "posttest": "yarn lint",
     "prepack": "sf-prepack",
     "prepare": "sf-install",
-    "pretest": "sf-compile-test && yarn command-reference",
-    "test": "sf-test",
+    "test": "wireit",
+    "test:only": "wireit",
     "version": "oclif readme"
   },
   "publishConfig": {
     "access": "public"
   },
-  "main": "lib/index.js"
+  "main": "lib/index.js",
+  "wireit": {
+    "build": {
+      "dependencies": [
+        "compile",
+        "lint"
+      ]
+    },
+    "compile": {
+      "command": "tsc -p . --pretty --incremental",
+      "files": [
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        "messages/**"
+      ],
+      "output": [
+        "lib/**",
+        "*.tsbuildinfo"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "format": {
+      "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "schemas/**/*.json",
+        "command-snapshot.json",
+        ".prettier*"
+      ],
+      "output": []
+    },
+    "lint": {
+      "command": "eslint src test --color --cache --cache-location .eslintcache",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "messages/**",
+        "**/.eslint*",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test:compile": {
+      "command": "tsc -p \"./test\" --pretty",
+      "files": [
+        "test/**/*.ts",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test": {
+      "dependencies": [
+        "test:compile",
+        "test:only",
+        "lint"
+      ]
+    },
+    "test:only": {
+      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": [
+        "test/**/*.ts",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        ".mocha*",
+        "!*.nut.ts",
+        ".nycrc"
+      ],
+      "output": [],
+      "dependencies": [
+        "test:command-reference"
+      ]
+    },
+    "test:command-reference": {
+      "command": "\"./bin/dev\" commandreference:generate --plugins auth --outputdir test/tmp",
+      "files": [
+        "src/**/*.ts",
+        "messages/**",
+        "package.json"
+      ],
+      "output": [
+        "test/tmp"
+      ]
+    },
+    "test:deprecation-policy": {
+      "command": "\"./bin/dev\" snapshot:compare",
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": [],
+      "dependencies": [
+        "compile"
+      ]
+    },
+    "test:json-schema": {
+      "command": "\"./bin/dev\" schema:compare",
+      "files": [
+        "src/**/*.ts",
+        "schemas"
+      ],
+      "output": []
+    }
+  }
 }

package/lib/ditamap/cli-reference-topic.d.ts

@@ -1,5 +0,0 @@
-import { Ditamap } from './ditamap';
-export declare class CLIReferenceTopic extends Ditamap {
-    constructor(topic: string, longDescription: string);
-    getTemplateFileName(): string;
-}

package/lib/ditamap/cli-reference-topic.js

@@ -1,28 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2018, salesforce.com, inc.
- * All rights reserved.
- * Licensed under the BSD 3-Clause license.
- * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLIReferenceTopic = void 0;
-const path_1 = require("path");
-const ditamap_1 = require("./ditamap");
-class CLIReferenceTopic extends ditamap_1.Ditamap {
-    constructor(topic, longDescription) {
-        const filename = ditamap_1.Ditamap.file(`cli_reference_${topic}`, 'xml');
-        // Set the data of topic and filenames
-        super(filename, {
-            topic,
-            longDescription,
-        });
-        // Override destination to include topic and subtopic
-        this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
-    }
-    getTemplateFileName() {
-        return 'cli_reference_topic.hbs';
-    }
-}
-exports.CLIReferenceTopic = CLIReferenceTopic;
-//# sourceMappingURL=cli-reference-topic.js.map

package/lib/ditamap/cli-reference-topic.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli-reference-topic.js","sourceRoot":"","sources":["../../src/ditamap/cli-reference-topic.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,uCAAoC;AAEpC,MAAa,iBAAkB,SAAQ,iBAAO;IAC5C,YAAmB,KAAa,EAAE,eAAuB;QACvD,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,iBAAiB,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;QAC/D,sCAAsC;QACtC,KAAK,CAAC,QAAQ,EAAE;YACd,KAAK;YACL,eAAe;SAChB,CAAC,CAAC;QAEH,qDAAqD;QACrD,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,mBAAmB;QACxB,OAAO,yBAAyB,CAAC;IACnC,CAAC;CACF;AAhBD,8CAgBC"}

package/lib/ditamap/main-topic-intro.d.ts

@@ -1,6 +0,0 @@
-import { JsonMap } from '@salesforce/ts-types';
-import { Ditamap } from './ditamap';
-export declare class MainTopicIntro extends Ditamap {
-    constructor(topic: string, subtopic: string, subTopicMeta: JsonMap);
-    getTemplateFileName(): string;
-}

package/lib/ditamap/main-topic-intro.js

@@ -1,43 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2018, salesforce.com, inc.
- * All rights reserved.
- * Licensed under the BSD 3-Clause license.
- * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MainTopicIntro = void 0;
-const path_1 = require("path");
-const ts_types_1 = require("@salesforce/ts-types");
-const utils_1 = require("../utils");
-const ditamap_1 = require("./ditamap");
-class MainTopicIntro extends ditamap_1.Ditamap {
-    constructor(topic, subtopic, subTopicMeta) {
-        const filename = ditamap_1.Ditamap.file(`cli_reference_${topic}_${subtopic}`, 'xml');
-        let trailblazerCommunityUrl;
-        let trailblazerCommunityName;
-        if (subTopicMeta.trailblazerCommunityLink) {
-            const community = (0, ts_types_1.ensureJsonMap)(subTopicMeta.trailblazerCommunityLink);
-            trailblazerCommunityUrl = community.url;
-            trailblazerCommunityName = community.name;
-        }
-        if (!subTopicMeta.longDescription && !subTopicMeta.external) {
-            subTopicMeta.longDescription = (0, utils_1.punctuate)((0, ts_types_1.asString)(subTopicMeta.description));
-        }
-        super(filename, {
-            topic: subtopic,
-            longDescription: subTopicMeta.longDescription,
-            isOpenPilotTopic: subTopicMeta.state === 'openPilot',
-            isClosedPilotTopic: subTopicMeta.state === 'closedPilot',
-            isBetaTopic: subTopicMeta.state === 'beta',
-            trailblazerCommunityUrl,
-            trailblazerCommunityName,
-        });
-        this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
-    }
-    getTemplateFileName() {
-        return 'main_topic_intro.hbs';
-    }
-}
-exports.MainTopicIntro = MainTopicIntro;
-//# sourceMappingURL=main-topic-intro.js.map

package/lib/ditamap/main-topic-intro.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"main-topic-intro.js","sourceRoot":"","sources":["../../src/ditamap/main-topic-intro.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,mDAAiF;AACjF,oCAAqC;AACrC,uCAAoC;AAEpC,MAAa,cAAe,SAAQ,iBAAO;IACzC,YAAmB,KAAa,EAAE,QAAgB,EAAE,YAAqB;QACvE,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,iBAAiB,KAAK,IAAI,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;QAE3E,IAAI,uBAAgC,CAAC;QACrC,IAAI,wBAAiC,CAAC;QACtC,IAAI,YAAY,CAAC,wBAAwB,EAAE;YACzC,MAAM,SAAS,GAAG,IAAA,wBAAa,EAAC,YAAY,CAAC,wBAAwB,CAAC,CAAC;YACvE,uBAAuB,GAAG,SAAS,CAAC,GAAG,CAAC;YACxC,wBAAwB,GAAG,SAAS,CAAC,IAAI,CAAC;SAC3C;QAED,IAAI,CAAC,YAAY,CAAC,eAAe,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;YAC3D,YAAY,CAAC,eAAe,GAAG,IAAA,iBAAS,EAAC,IAAA,mBAAQ,EAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;SAC9E;QAED,KAAK,CAAC,QAAQ,EAAE;YACd,KAAK,EAAE,QAAQ;YACf,eAAe,EAAE,YAAY,CAAC,eAAe;YAC7C,gBAAgB,EAAE,YAAY,CAAC,KAAK,KAAK,WAAW;YACpD,kBAAkB,EAAE,YAAY,CAAC,KAAK,KAAK,aAAa;YACxD,WAAW,EAAE,YAAY,CAAC,KAAK,KAAK,MAAM;YAC1C,uBAAuB;YACvB,wBAAwB;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,mBAAmB;QACxB,OAAO,sBAAsB,CAAC;IAChC,CAAC;CACF;AAhCD,wCAgCC"}

package/messages/main.json

@@ -1,9 +0,0 @@
-{
-  "commandDescription": "generate the command reference guide located",
-  "pluginFlagDescription": "comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory",
-  "allFlagDescription": "include all relevant plugins in the generation",
-  "hiddenFlagDescription": "show hidden commands",
-  "outputdirFlagDescription": "output directory to put generated files",
-  "erroronwarningFlagDescription": "fail the command if there are any warnings",
-  "ditamapSuffixFlagDescription": "unique suffix to append to generated ditamap"
-}

package/templates/cli_reference_topic.hbs

@@ -1,25 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
-        "concept.dtd">
-<concept id="{{uniqueId 'cli_reference' topic}}" xml:lang="en-us">
-<!--
-
-NOTE TO WRITERS:
-THIS FILE IS AUTOGENERATED. DON’T MAKE CHANGES TO THIS FILE IN PERFORCE! YOUR CHANGES WILL BE OVERWRITTEN.
-IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR DETAILS.
-
--->
-    <!--This is a static file that should be passed as-is through the autogen process.-->
-    <title><codeph otherprops="nolang">{{topic}}</codeph> Namespace</title>
-    <shortdesc>{{longDescription}}</shortdesc>
-    <prolog>
-        <metadata>
-            <!--In the future we’ll add keywords here.-->
-            <othermeta content="reference" name="topic_type"/>
-            <othermeta content="Developer_Tools" name="app_area"/>
-            <othermeta content="Developer Partner" name="role"/>
-            <othermeta content="EE UE DE PXE" name="edition"/>
-            <othermeta content="aloha mobile sfx" name="ui_platform"/>
-        </metadata>
-    </prolog>
-</concept>