@memlab/cli 1.0.24 → 1.0.26

package/dist/BaseCommand.d.ts

@@ -7,7 +7,7 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { CLIOptions, Nullable } from '@memlab/core';
+import type { CLIOptions, CommandOptionExample, Nullable, Optional } from '@memlab/core';
 import { BaseOption } from '@memlab/core';
 export declare enum CommandCategory {
     COMMON = "COMMON",
@@ -24,7 +24,7 @@ declare abstract class Command {
 }
 export default class BaseCommand extends Command {
     getCommandName(): string;
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     getCategory(): CommandCategory;
     getDescription(): string;
     getDocumenation(): string;
@@ -32,7 +32,7 @@ export default class BaseCommand extends Command {
     isInternalCommand(): boolean;
     getOptions(): BaseOption[];
     getExcludedOptions(): BaseOption[];
-    getSubCommands(): BaseCommand[];
+    getSubCommands(): Optional<BaseCommand[]>;
     run(_options: CLIOptions): Promise<void>;
 }
 export {};

package/dist/BaseCommand.js

@@ -85,7 +85,7 @@ class BaseCommand extends Command {
         const className = this.constructor.name;
         throw new Error(`${className}.getCommandName is not implemented`);
     }
-    // get a list of examples
+    // get a list of CLI option examples
     // examples will be displayed in helper text
     getExamples() {
         return [];
@@ -131,6 +131,10 @@ class BaseCommand extends Command {
     // for example command 'A' has two sub-commands 'B' and 'C'
     // CLI supports running in terminal: `memlab A B` or `memlab A C`
     // The parent command will be executed before its subcommands
+    //
+    // If this callback returns null or undefined, it means
+    // the command will handle the dispatcher won't try to match and process
+    // the subcommands (the command will handle sub-commands by itself).
     getSubCommands() {
         return [];
     }

package/dist/Dispatcher.js

@@ -107,6 +107,8 @@ class CommandDispatcher {
             const { configFromOptions } = runCmdOpt;
             // execute command
             yield command.run({ cliArgs: args, configFromOptions });
+            // recommand CLI command and flags
+            core_1.config.setRunInfo('command', process.argv.slice(2).join(' '));
             if (runCmdOpt.isPrerequisite !== true) {
                 // execute subcommands
                 const commandIndex = ((_a = runCmdOpt.commandIndex) !== null && _a !== void 0 ? _a : 0) + 1;
@@ -125,6 +127,10 @@ class CommandDispatcher {
                 return;
             }
             const subCommands = command.getSubCommands();
+            // if the command will handle the sub-commands by itself
+            if (subCommands == null) {
+                return;
+            }
             for (const subCommand of subCommands) {
                 if (subCommand.getCommandName() === args._[subCommandIndex]) {
                     yield this.runCommand(subCommand, args, runCmdOpt);

package/dist/commands/MemLabRunCommand.d.ts

@@ -7,12 +7,12 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { BaseOption, CLIOptions } from '@memlab/core';
+import type { BaseOption, CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../BaseCommand';
 export default class MemLabRunCommand extends BaseCommand {
     getCommandName(): string;
     getDescription(): string;
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     getPrerequisites(): BaseCommand[];
     getOptions(): BaseOption[];
     getExcludedOptions(): BaseOption[];

package/dist/commands/RunMeasureCommand.d.ts

@@ -7,14 +7,14 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { CLIOptions } from '@memlab/core';
+import type { CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand from '../BaseCommand';
 import { BaseOption } from '@memlab/core';
 export default class RunMeasureCommand extends BaseCommand {
     getCommandName(): string;
     getDescription(): string;
     getPrerequisites(): BaseCommand[];
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     getOptions(): BaseOption[];
     run(options: CLIOptions): Promise<void>;
 }

package/dist/commands/RunMeasureCommand.js

@@ -45,6 +45,7 @@ const HeadfulBrowserOption_1 = __importDefault(require("../options/e2e/HeadfulBr
 const DisableWebSecurityOption_1 = __importDefault(require("../options/e2e/DisableWebSecurityOption"));
 const EnableJSRewriteOption_1 = __importDefault(require("../options/e2e/EnableJSRewriteOption"));
 const EnableJSInterceptOption_1 = __importDefault(require("../options/e2e/EnableJSInterceptOption"));
+const SetChromiumBinaryOption_1 = __importDefault(require("../options/e2e/SetChromiumBinaryOption"));
 class RunMeasureCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'measure';
@@ -77,6 +78,7 @@ class RunMeasureCommand extends BaseCommand_1.default {
             new RunningModeOption_1.default(),
             new RemoteBrowserDebugOption_1.default(),
             new ScenarioFileOption_1.default(),
+            new SetChromiumBinaryOption_1.default(),
             new SetDeviceOption_1.default(),
             new SetUserAgentOption_1.default(),
             new DisableXvfbOption_1.default(),

package/dist/commands/WarmupAppCommand.d.ts

@@ -7,14 +7,14 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { CLIOptions } from '@memlab/core';
+import type { CLIOptions, CommandOptionExample } from '@memlab/core';
 import { BaseOption } from '@memlab/core';
 import BaseCommand from '../BaseCommand';
 export default class FBWarmupAppCommand extends BaseCommand {
     getCommandName(): string;
     getDescription(): string;
     getPrerequisites(): BaseCommand[];
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     getOptions(): BaseOption[];
     run(_options: CLIOptions): Promise<void>;
 }

package/dist/commands/WarmupAppCommand.js

@@ -38,6 +38,7 @@ const HeadfulBrowserOption_1 = __importDefault(require("../options/e2e/HeadfulBr
 const DisableWebSecurityOption_1 = __importDefault(require("../options/e2e/DisableWebSecurityOption"));
 const EnableJSRewriteOption_1 = __importDefault(require("../options/e2e/EnableJSRewriteOption"));
 const EnableJSInterceptOption_1 = __importDefault(require("../options/e2e/EnableJSInterceptOption"));
+const SetChromiumBinaryOption_1 = __importDefault(require("../options/e2e/SetChromiumBinaryOption"));
 class FBWarmupAppCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'warmup';
@@ -62,6 +63,7 @@ class FBWarmupAppCommand extends BaseCommand_1.default {
             new RunningModeOption_1.default(),
             new RemoteBrowserDebugOption_1.default(),
             new ScenarioFileOption_1.default(),
+            new SetChromiumBinaryOption_1.default(),
             new SetDeviceOption_1.default(),
             new SetUserAgentOption_1.default(),
             new DisableXvfbOption_1.default(),

package/dist/commands/heap/CheckLeakCommand.d.ts

@@ -8,7 +8,7 @@
  * @oncall web_perf_infra
  */
 import type { ParsedArgs } from 'minimist';
-import type { BaseOption, CLIOptions } from '@memlab/core';
+import type { BaseOption, CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';
 export declare type CheckLeakCommandOptions = {
     isMLClustering?: boolean;
@@ -20,6 +20,7 @@ export default class CheckLeakCommand extends BaseCommand {
     protected restoreDefaultMLClusteringSetting(cliArgs: ParsedArgs): void;
     constructor(options?: CheckLeakCommandOptions);
     getCommandName(): string;
+    getExamples(): CommandOptionExample[];
     getDescription(): string;
     getDocumenation(): string;
     getCategory(): CommandCategory;

package/dist/commands/heap/CheckLeakCommand.js

@@ -54,6 +54,7 @@ const MLClusteringLinkageMaxDistanceOption_1 = __importDefault(require("../../op
 const MLClusteringMaxDFOption_1 = __importDefault(require("../../options/MLClusteringMaxDFOption"));
 const CleanupSnapshotOption_1 = __importDefault(require("../../options/heap/CleanupSnapshotOption"));
 const SetWorkingDirectoryOption_1 = __importDefault(require("../../options/SetWorkingDirectoryOption"));
+const OptionConstant_1 = __importDefault(require("../../options/lib/OptionConstant"));
 class CheckLeakCommand extends BaseCommand_1.default {
     constructor(options = {}) {
         super();
@@ -75,16 +76,54 @@ class CheckLeakCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'find-leaks';
     }
+    getExamples() {
+        const optionNames = OptionConstant_1.default.optionNames;
+        const workDirOption = `--${optionNames.WORK_DIR}`;
+        const snapshotDirOption = `--${optionNames.SNAPSHOT_DIR}`;
+        const baselineOption = `--${optionNames.BASELINE}`;
+        const targetOption = `--${optionNames.TARGET}`;
+        const finalOption = `--${optionNames.FINAL}`;
+        return [
+            {
+                description: 'check memory leaks in the default working directory generated by\n' +
+                    `memlab run (without setting the ${workDirOption} option)`,
+                cliOptionExample: '', // default empty command options
+            },
+            {
+                description: 'specify the baseline, target, and final heap snapshot file path separately',
+                cliOptionExample: `${baselineOption} /tmp/baseline.heapsnapshot ${targetOption} /tmp/target.heapsnapshot ${finalOption} /tmp/final.heapsnapshot`,
+            },
+            {
+                description: 'specifies the directory that holds all three heap snapshot files',
+                cliOptionExample: `${snapshotDirOption} /dir/containing/heapsnapshot/files/`,
+            },
+            {
+                description: 'specifies the output working directory of the `memlab run` or the `memlab snapshot` command',
+                cliOptionExample: `${workDirOption} /memlab/working/dir/generated/by/memlab/`,
+            },
+        ];
+    }
     getDescription() {
         return 'find memory leaks in heap snapshots';
     }
     getDocumenation() {
-        return `There are three ways to specify inputs for the \`memlab find-leaks\` command:
- 1. \`--baseline\`, \`--target\`, \`--final\` specifies each snapshot input individually;
- 2. \`--snapshot-dir\` specifies the directory that holds all three heap snapshot files (MemLab will assign baseline, target, and final based on alphabetic order of the file);
- 3. \`--work-dir\` specifies the output working directory of the \`memlab run\` or the \`memlab snapshot\` command;
+        const optionNames = OptionConstant_1.default.optionNames;
+        const workDirOption = `--${optionNames.WORK_DIR}`;
+        const snapshotDirOption = `--${optionNames.SNAPSHOT_DIR}`;
+        const baselineOption = `--${optionNames.BASELINE}`;
+        const targetOption = `--${optionNames.TARGET}`;
+        const finalOption = `--${optionNames.FINAL}`;
+        return `There are three ways to specify inputs for the \`memlab ${this.getCommandName()}\` command:
+ 1. \`${baselineOption}\`, \`${targetOption}\`, \`${finalOption}\` specifies each heap snapshot input individually;
+ 2. \`${snapshotDirOption}\` specifies the directory that holds all three heap snapshot files (MemLab will assign baseline, target, and final based on alphabetic order of the file);
+ 3. \`${workDirOption}\` specifies the output working directory of the \`memlab run\` or the \`memlab snapshot\` command;
+
+Please only use one of the three ways to specify the input.
 
-Please only use one of the three ways to specify the input.`;
+You can also manually take heap snapshots in Chrome Devtools, save them to disk.
+Then process them using this command with the CLI flags (either option 1
+or option 2 mentioned above).
+`;
     }
     getCategory() {
         return BaseCommand_1.CommandCategory.COMMON;

package/dist/commands/heap/DiffLeakCommand.d.ts

@@ -7,14 +7,26 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { BaseOption, CLIOptions } from '@memlab/core';
+import type { ParsedArgs } from 'minimist';
+import { BaseOption, CLIOptions } from '@memlab/core';
+import type { CheckLeakCommandOptions } from './CheckLeakCommand';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';
+export declare type WorkDirSettings = {
+    controlWorkDirs: Array<string>;
+    treatmentWorkDirs: Array<string>;
+};
 export default class CheckLeakCommand extends BaseCommand {
+    private isMLClustering;
+    private isMLClusteringSettingCache;
+    protected useDefaultMLClusteringSetting(cliArgs: ParsedArgs): void;
+    protected restoreDefaultMLClusteringSetting(cliArgs: ParsedArgs): void;
+    constructor(options?: CheckLeakCommandOptions);
     getCommandName(): string;
     getDescription(): string;
     getCategory(): CommandCategory;
     getPrerequisites(): BaseCommand[];
     getOptions(): BaseOption[];
+    protected getWorkDirs(options: CLIOptions): WorkDirSettings;
     run(options: CLIOptions): Promise<void>;
 }
 //# sourceMappingURL=DiffLeakCommand.d.ts.map

package/dist/commands/heap/DiffLeakCommand.js

@@ -50,7 +50,26 @@ const MLClusteringLinkageMaxDistanceOption_1 = __importDefault(require("../../op
 const MLClusteringMaxDFOption_1 = __importDefault(require("../../options/MLClusteringMaxDFOption"));
 const SetControlWorkDirOption_1 = __importDefault(require("../../options/experiment/SetControlWorkDirOption"));
 const SetTreatmentWorkDirOption_1 = __importDefault(require("../../options/experiment/SetTreatmentWorkDirOption"));
+const SetMaxClusterSampleSizeOption_1 = __importDefault(require("../../options/SetMaxClusterSampleSizeOption"));
+const SetTraceContainsFilterOption_1 = __importDefault(require("../../options/heap/SetTraceContainsFilterOption"));
 class CheckLeakCommand extends BaseCommand_1.default {
+    constructor(options = {}) {
+        super();
+        this.isMLClustering = false;
+        this.isMLClusteringSettingCache = false;
+        this.isMLClustering = !!(options === null || options === void 0 ? void 0 : options.isMLClustering);
+    }
+    useDefaultMLClusteringSetting(cliArgs) {
+        if (!MLClusteringOption_1.default.hasOptionSet(cliArgs)) {
+            core_1.config.isMLClustering = this.isMLClustering;
+            this.isMLClusteringSettingCache = core_1.config.isMLClustering;
+        }
+    }
+    restoreDefaultMLClusteringSetting(cliArgs) {
+        if (!MLClusteringOption_1.default.hasOptionSet(cliArgs)) {
+            core_1.config.isMLClustering = this.isMLClusteringSettingCache;
+        }
+    }
     getCommandName() {
         return 'diff-leaks';
     }
@@ -65,8 +84,8 @@ class CheckLeakCommand extends BaseCommand_1.default {
     }
     getOptions() {
         return [
-            new SetControlWorkDirOption_1.default().required(),
-            new SetTreatmentWorkDirOption_1.default().required(),
+            new SetControlWorkDirOption_1.default(),
+            new SetTreatmentWorkDirOption_1.default(),
             new JSEngineOption_1.default(),
             new LeakFilterFileOption_1.default(),
             new OversizeThresholdOption_1.default(),
@@ -76,28 +95,39 @@ class CheckLeakCommand extends BaseCommand_1.default {
             new MLClusteringOption_1.default(),
             new MLClusteringLinkageMaxDistanceOption_1.default(),
             new MLClusteringMaxDFOption_1.default(),
+            new SetMaxClusterSampleSizeOption_1.default(),
+            new SetTraceContainsFilterOption_1.default(),
         ];
     }
-    run(options) {
+    getWorkDirs(options) {
         var _a, _b;
+        // double check parameters
+        if (!((_a = options.configFromOptions) === null || _a === void 0 ? void 0 : _a.controlWorkDirs) ||
+            !((_b = options.configFromOptions) === null || _b === void 0 ? void 0 : _b.treatmentWorkDirs)) {
+            core_1.info.error('Please specify control and test working directory');
+            throw core_1.utils.haltOrThrow('No control or test working directory specified');
+        }
+        // get parameters
+        const controlWorkDirs = options.configFromOptions['controlWorkDirs'];
+        const treatmentWorkDirs = options.configFromOptions['treatmentWorkDirs'];
+        return {
+            controlWorkDirs,
+            treatmentWorkDirs,
+        };
+    }
+    run(options) {
         return __awaiter(this, void 0, void 0, function* () {
             core_1.config.chaseWeakMapEdge = false;
-            // double check parameters
-            if (!((_a = options.configFromOptions) === null || _a === void 0 ? void 0 : _a.controlWorkDirs) ||
-                !((_b = options.configFromOptions) === null || _b === void 0 ? void 0 : _b.treatmentWorkDir)) {
-                core_1.info.error('Please specify control and test working directory');
-                throw core_1.utils.haltOrThrow('No control or test working directory specified');
-            }
-            // get parameters
-            const controlWorkDirs = options.configFromOptions['controlWorkDirs'];
-            const treatmentWorkDir = options.configFromOptions['treatmentWorkDir'];
+            const { controlWorkDirs, treatmentWorkDirs } = this.getWorkDirs(options);
             const { runMetaInfoManager } = core_1.runInfoUtils;
             runMetaInfoManager.setConfigFromRunMeta({
-                workDir: treatmentWorkDir,
+                workDir: treatmentWorkDirs[0],
                 silentFail: true,
             });
             // diff memory leaks
-            yield core_1.analysis.diffLeakByWorkDir({ controlWorkDirs, treatmentWorkDir });
+            this.useDefaultMLClusteringSetting(options.cliArgs);
+            yield core_1.analysis.diffLeakByWorkDir({ controlWorkDirs, treatmentWorkDirs });
+            this.restoreDefaultMLClusteringSetting(options.cliArgs);
         });
     }
 }

package/dist/commands/heap/GetRetainerTraceCommand.d.ts

@@ -7,14 +7,14 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { CLIOptions } from '@memlab/core';
+import type { CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';
 import { BaseOption } from '@memlab/core';
 export default class GetRetainerTraceCommand extends BaseCommand {
     getCommandName(): string;
     getDescription(): string;
     getCategory(): CommandCategory;
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     getOptions(): BaseOption[];
     run(options: CLIOptions): Promise<void>;
 }

package/dist/commands/heap/HeapAnalysisCommand.d.ts

@@ -7,7 +7,7 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { CLIOptions } from '@memlab/core';
+import type { CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';
 export default class RunHeapAnalysisCommand extends BaseCommand {
     getCommandName(): string;
@@ -15,7 +15,7 @@ export default class RunHeapAnalysisCommand extends BaseCommand {
     getCategory(): CommandCategory;
     getPrerequisites(): BaseCommand[];
     getSubCommands(): BaseCommand[];
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     run(options: CLIOptions): Promise<void>;
 }
 //# sourceMappingURL=HeapAnalysisCommand.d.ts.map

package/dist/commands/heap/interactive/InteractiveHeapCommand.d.ts

@@ -7,14 +7,14 @@
  * @format
  * @oncall web_perf_infra
  */
-import { CLIOptions } from '@memlab/core';
+import { CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../../BaseCommand';
 import { BaseOption } from '@memlab/core';
 export default class InteractiveHeapCommand extends BaseCommand {
     getCommandName(): string;
     getDescription(): string;
     getCategory(): CommandCategory;
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     getOptions(): BaseOption[];
     private exitAttempt;
     private printPromptInfo;

package/dist/commands/heap/interactive/InteractiveHeapExploreCommand.d.ts

@@ -7,13 +7,13 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { BaseOption, CLIOptions } from '@memlab/core';
+import type { BaseOption, CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../../BaseCommand';
 export default class InteractiveHeapViewCommand extends BaseCommand {
     getCommandName(): string;
     getDescription(): string;
     getCategory(): CommandCategory;
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     getOptions(): BaseOption[];
     private getHeap;
     private getNodesToFocus;

package/dist/commands/heap/interactive/ui-components/HeapViewUtils.d.ts

@@ -17,6 +17,8 @@ export declare class ComponentDataItem {
     type?: string;
     details?: Map<string, string>;
     static getTextForDisplay(data: ComponentDataItem): string;
+    private static getHeapObjectTextContent;
+    private static getHeapEdgeTextContent;
     private static getTextContent;
 }
 export declare class ComponentData {

package/dist/commands/heap/interactive/ui-components/HeapViewUtils.js

@@ -66,6 +66,28 @@ class ComponentDataItem {
         }
         return chalk_1.default.grey(content);
     }
+    static getHeapObjectTextContent(node) {
+        const objectType = chalk_1.default.grey(`(${node.type})`);
+        const objectId = chalk_1.default.grey(` @${node.id}`);
+        const size = core_1.utils.getReadableBytes(node.retainedSize);
+        const sizeInfo = chalk_1.default.grey(' [') + chalk_1.default.bold(chalk_1.default.blue(size)) + chalk_1.default.grey(']');
+        const objectTitle = node.isString ? '<string>' : node.name;
+        return (chalk_1.default.green('[') +
+            (isUsefulObjectForDebugging(node)
+                ? chalk_1.default.green(objectTitle)
+                : chalk_1.default.bold(chalk_1.default.grey(objectTitle))) +
+            chalk_1.default.green(']') +
+            objectType +
+            objectId +
+            sizeInfo);
+    }
+    static getHeapEdgeTextContent(edge) {
+        const arrowPrefix = chalk_1.default.grey('--');
+        const arrowSuffix = chalk_1.default.grey('---') + '>';
+        const edgeType = chalk_1.default.grey(`(${edge.type})`);
+        const edgeName = edge.name_or_index;
+        return `${arrowPrefix}${edgeName}${edgeType}${arrowSuffix} `;
+    }
     static getTextContent(data) {
         let ret = '';
         if (data.tag) {
@@ -74,32 +96,14 @@ class ComponentDataItem {
         if (data.stringContent) {
             ret += data.stringContent;
         }
-        const arrowPrefix = chalk_1.default.grey('--');
-        const arrowSuffix = chalk_1.default.grey('---') + '>';
         if (data.referrerEdge) {
-            const edgeType = chalk_1.default.grey(`(${data.referrerEdge.type})`);
-            const edgeName = data.referrerEdge.name_or_index;
-            ret += `${arrowPrefix}${edgeName}${edgeType}${arrowSuffix} `;
+            ret += this.getHeapEdgeTextContent(data.referrerEdge);
         }
         if (data.heapObject) {
-            const objectType = chalk_1.default.grey(`(${data.heapObject.type})`);
-            const objectId = chalk_1.default.grey(` @${data.heapObject.id}`);
-            const size = core_1.utils.getReadableBytes(data.heapObject.retainedSize);
-            const sizeInfo = chalk_1.default.grey(' [') + chalk_1.default.bold(chalk_1.default.blue(size)) + chalk_1.default.grey(']');
-            ret +=
-                chalk_1.default.green('[') +
-                    (isUsefulObjectForDebugging(data.heapObject)
-                        ? chalk_1.default.green(data.heapObject.name)
-                        : chalk_1.default.bold(chalk_1.default.grey(data.heapObject.name))) +
-                    chalk_1.default.green(']') +
-                    objectType +
-                    objectId +
-                    sizeInfo;
+            ret += this.getHeapObjectTextContent(data.heapObject);
         }
         if (data.referenceEdge) {
-            const edgeType = chalk_1.default.grey(`(${data.referenceEdge.type})`);
-            const edgeName = data.referenceEdge.name_or_index;
-            ret += ` ${arrowPrefix}${edgeName}${edgeType}${arrowSuffix} `;
+            ret += this.getHeapEdgeTextContent(data.referenceEdge);
         }
         return ret === '' ? chalk_1.default.grey('<undefinied>') : ret;
     }

package/dist/commands/heap/interactive/ui-components/ListComponent.js

@@ -203,7 +203,7 @@ class ListComponent {
             this.element.pushItem(content[i]);
             ++this.displayedItems;
         }
-        this.content = content;
+        this.content = content.map(v => v.replace(/\n/g, '\\n'));
         this.horizonScrollPositionMap.clear();
         this.insertDisplayMoreEntry();
         this.updateContent(oldContent, this.content);

package/dist/commands/helper/GenerateCLIDocCommand.js

@@ -46,6 +46,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const DocUtils_1 = __importDefault(require("./lib/DocUtils"));
 const BaseCommand_1 = __importStar(require("../../BaseCommand"));
 const core_1 = require("@memlab/core");
 const UniversalOptions_1 = __importDefault(require("../../options/lib/UniversalOptions"));
@@ -86,6 +87,10 @@ class GenerateCLIDocCommand extends BaseCommand_1.default {
     }
     writeCommandCategories(docFile) {
         this.writeTextWithNewLine(docFile, '# Command Line Interface');
+        this.writeTextWithNewLine(docFile, `Install the memlab command line tool with npm:
+\`\`\`bash
+npm install -g memlab
+\`\`\``);
         for (const category in BaseCommand_1.CommandCategory) {
             const commandsToPrintFirst = [];
             this.writeCategory(docFile, category, commandsToPrintFirst);
@@ -131,6 +136,7 @@ class GenerateCLIDocCommand extends BaseCommand_1.default {
         this.writeTextWithNewLine(docFile, `\n## ${categoryName} Commands\n`);
     }
     writeCommand(docFile, command, indent = '') {
+        var _a, _b;
         const name = command.getFullCommand();
         const desc = core_1.utils.upperCaseFirstCharacter(command.getDescription().trim());
         const cmdDoc = command.getDocumenation().trim();
@@ -144,17 +150,14 @@ class GenerateCLIDocCommand extends BaseCommand_1.default {
         }
         // get example
         const examples = command.getExamples();
-        let example = '';
-        if (examples.length > 0) {
-            example = examples[0].trim();
-        }
+        const example = (_a = examples[0]) !== null && _a !== void 0 ? _a : '';
         // write command synopsis
-        const cmd = `memlab ${name} ${example}`;
+        const cmd = DocUtils_1.default.generateExampleCommand(name, example);
         this.writeCodeBlock(docFile, cmd, 'bash');
         // write command examples if there is any
         const exampleBlock = examples
             .slice(1)
-            .map(example => `memlab ${name} ${example.trim()}`)
+            .map(example => DocUtils_1.default.generateExampleCommand(name, example))
             .join('\n');
         if (exampleBlock.length > 0) {
             this.writeTextWithNewLine(docFile, '\n#### examples\n');
@@ -162,7 +165,7 @@ class GenerateCLIDocCommand extends BaseCommand_1.default {
         }
         // write options
         this.writeCommandOptions(docFile, command);
-        const subCommands = command.getSubCommands();
+        const subCommands = (_b = command.getSubCommands()) !== null && _b !== void 0 ? _b : [];
         for (const subCommand of subCommands) {
             this.writeCommand(docFile, subCommand, indent + '#');
         }

package/dist/commands/helper/HelperCommand.d.ts

@@ -7,20 +7,23 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { BaseOption, CLIOptions } from '@memlab/core';
+import type { BaseOption, CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand from '../../BaseCommand';
-declare type HelperOption = CLIOptions & {
+declare type PrintCommandOptions = {
+    printOptions?: boolean;
+    printDoc?: boolean;
+};
+declare type HelperOption = CLIOptions & PrintCommandOptions & {
     modules: Map<string, BaseCommand>;
     command: BaseCommand | null;
     indent?: string;
-    printOptions?: boolean;
 };
 export default class HelperCommand extends BaseCommand {
     private printedCommand;
     private universalOptions;
     getCommandName(): string;
     getDescription(): string;
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     setUniversalOptions(options: BaseOption[]): void;
     private printHeader;
     private printCommandCategories;