@memlab/cli 1.0.23 → 1.0.25

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

@@ -40,6 +40,7 @@ function positionToNumber(info) {
 class CliScreen {
     constructor(title, heap, objectCategory) {
         this.currentFocuseKey = 1;
+        this.fullScreenComponent = null;
         this.heapController = new HeapViewController_1.default(heap, objectCategory);
         this.screen = this.initScreen(title);
         const callbacks = this.initCallbacks(this.heapController, this.screen);
@@ -118,16 +119,20 @@ class CliScreen {
     }
     registerScreenResize() {
         const screen = this.screen;
-        screen.on('resize', () => {
-            // all boxes/lists needs to resize
-            this.updateComponentSize(this.clusteredObjectBox, this.getClusteredObjectBoxSize());
-            this.updateComponentSize(this.referrerBox, this.getReferrerBoxSize());
-            this.updateComponentSize(this.objectBox, this.getObjectBoxSize());
-            this.updateComponentSize(this.objectPropertyBox, this.getObjectPropertyBoxSize());
-            this.updateComponentSize(this.referenceBox, this.getReferenceBoxSize());
-            this.updateComponentSize(this.retainerTraceBox, this.getRetainerTraceBoxSize());
-            this.updateElementSize(this.helperTextElement, this.getHelperTextSize());
-        });
+        screen.on('resize', this.updateAllComponentsSize.bind(this));
+    }
+    updateAllComponentsSize() {
+        // all boxes/lists needs to resize
+        this.updateComponentSize(this.clusteredObjectBox, this.getClusteredObjectBoxSize());
+        this.updateComponentSize(this.referrerBox, this.getReferrerBoxSize());
+        this.updateComponentSize(this.objectBox, this.getObjectBoxSize());
+        this.updateComponentSize(this.objectPropertyBox, this.getObjectPropertyBoxSize());
+        this.updateComponentSize(this.referenceBox, this.getReferenceBoxSize());
+        this.updateComponentSize(this.retainerTraceBox, this.getRetainerTraceBoxSize());
+        if (this.fullScreenComponent != null) {
+            this.updateComponentSize(this.fullScreenComponent, this.getComponentFullScreenSize());
+        }
+        this.updateElementSize(this.helperTextElement, this.getHelperTextSize());
     }
     updateComponentSize(component, size) {
         this.updateElementSize(component.element, size);
@@ -141,7 +146,16 @@ class CliScreen {
     registerKeys() {
         const screen = this.screen;
         // Quit on Escape, q, or Control-C.
-        screen.key(['escape', 'q', 'C-c'], () => process.exit(0));
+        screen.key(['escape', 'q', 'C-c'], () => {
+            if (this.fullScreenComponent != null) {
+                // exit component full screen mode
+                this.makeNoComponentFullScreen();
+            }
+            else {
+                // quit the program
+                process.exit(0);
+            }
+        });
         const keyToComponent = this.keyToComponent;
         const heapController = this.heapController;
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -150,13 +164,30 @@ class CliScreen {
                 // focus on the selected element
                 const component = keyToComponent.get(char);
                 if (component) {
+                    if (component !== this.fullScreenComponent) {
+                        // quit full screen mode if the component to focus
+                        // is not the current full screen component
+                        this.makeNoComponentFullScreen();
+                    }
                     heapController.focusOnComponent(component.id);
                     screen.render();
                 }
             }
+            // enter full screen
+            if (char === 'f') {
+                this.makeComponentFullScreen(heapController.getFocusedComponent());
+            }
         };
         screen.on('keypress', callback);
     }
+    makeComponentFullScreen(component) {
+        this.fullScreenComponent = component;
+        this.updateAllComponentsSize();
+    }
+    makeNoComponentFullScreen() {
+        this.fullScreenComponent = null;
+        this.updateAllComponentsSize();
+    }
     addComponentToFocusKeyMap(component) {
         const key = `${this.currentFocuseKey++}`;
         this.keyToComponent.set(key, component);
@@ -208,6 +239,14 @@ class CliScreen {
         this.addComponentToFocusKeyMap(box);
         return box;
     }
+    getComponentFullScreenSize() {
+        return {
+            width: positionToNumber(this.screen.width) - 4,
+            height: positionToNumber(this.screen.height) - 5,
+            top: 2,
+            left: 2,
+        };
+    }
     getObjectBoxSize() {
         return {
             width: Math.floor(positionToNumber(this.screen.width) / 3),
@@ -282,6 +321,7 @@ class CliScreen {
             '←': '',
             '→': '',
             Enter: 'select',
+            f: 'full screen',
             q: 'quit',
         };
         const keysToFocus = Array.from(this.keyToComponent.keys());

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

@@ -22,6 +22,7 @@ export default class HeapViewController {
     private componentIdToDataMap;
     private componentIdToComponentMap;
     private heap;
+    private focusedComponent;
     private clusteredBox;
     private referrerBox;
     private objectBox;
@@ -30,6 +31,7 @@ export default class HeapViewController {
     private retainerTracePropertyBox;
     private scriptManager;
     constructor(heap: IHeapSnapshot, objectCategory: ObjectCategory);
+    getFocusedComponent(): ListComponent;
     private getFlattenHeapObjectsInfo;
     private getFlattenClusteredObjectsInfo;
     private shouldClusterCategory;

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

@@ -27,6 +27,9 @@ class HeapViewController {
         this.scriptManager = new e2e_1.ScriptManager();
         this.scriptManager.loadFromFiles();
     }
+    getFocusedComponent() {
+        return this.focusedComponent;
+    }
     getFlattenHeapObjectsInfo(objectCategory) {
         let ret = [];
         for (const category of objectCategory.keys()) {
@@ -341,7 +344,7 @@ class HeapViewController {
         this.objectBox.setLabel('Objects');
         this.setSelectedHeapObject(node);
         if (!options.skipFocus) {
-            this.focusOnComponent(this.objectBox.id);
+            this.focusOnComponent(this.clusteredBox.id);
         }
     }
     focusOnComponent(componentId) {
@@ -349,6 +352,7 @@ class HeapViewController {
         for (const component of this.componentIdToComponentMap.values()) {
             if (component.id === componentId) {
                 component.focus();
+                this.focusedComponent = component;
                 const data = this.componentIdToDataMap.get(componentId);
                 const selectIndex = (_a = (data && data.selectedIdx)) !== null && _a !== void 0 ? _a : -1;
                 this.setSelectedHeapObjectFromComponent(componentId, selectIndex);

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

@@ -145,6 +145,7 @@ class ListComponent {
     }
     focus() {
         this.element.focus();
+        this.element.setFront();
         this.element.style.border.fg = 'white';
         this.element.style.selected = {
             bg: 'grey',
@@ -202,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,25 +136,28 @@ 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());
+        const desc = core_1.utils.upperCaseFirstCharacter(command.getDescription().trim());
+        const cmdDoc = command.getDocumenation().trim();
         // write command title
         this.writeTextWithNewLine(docFile, `\n###${indent} memlab ${name}\n`);
         // write description
         this.writeTextWithNewLine(docFile, `${desc}\n`);
+        // write detailed command documentation
+        if (cmdDoc.length > 0) {
+            this.writeTextWithNewLine(docFile, `${cmdDoc}\n`);
+        }
         // 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');
@@ -157,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;

package/dist/commands/helper/HelperCommand.js

@@ -48,10 +48,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const chalk_1 = __importDefault(require("chalk"));
 const string_width_1 = __importDefault(require("string-width"));
 const core_1 = require("@memlab/core");
+const heap_analysis_1 = require("@memlab/heap-analysis");
+const DocUtils_1 = __importDefault(require("./lib/DocUtils"));
 const CommandOrder_1 = __importDefault(require("./lib/CommandOrder"));
 const BaseCommand_1 = __importStar(require("../../BaseCommand"));
 const UniversalOptions_1 = __importDefault(require("../../options/lib/UniversalOptions"));
-const heap_analysis_1 = require("@memlab/heap-analysis");
+const CLIUtils_1 = require("../../lib/CLIUtils");
 class HelperCommand extends BaseCommand_1.default {
     constructor() {
         super(...arguments);
@@ -137,7 +139,7 @@ class HelperCommand extends BaseCommand_1.default {
         if (options.length === 0) {
             return '';
         }
-        const width = Math.min(70, process.stdout.columns);
+        const width = Math.min(CLIUtils_1.READABLE_CMD_FLAG_WIDTH, process.stdout.columns);
         let summary = '';
         let curLine = chalk_1.default.bold(`${indent}Options:`);
         for (const option of options) {
@@ -177,37 +179,40 @@ class HelperCommand extends BaseCommand_1.default {
     }
     formatOptionText(optionText, indent, headerLength) {
         const header = chalk_1.default.green(optionText.header);
-        const prefix = core_1.utils.repeat(' ', headerLength - optionText.header.length);
+        const prefix = (0, CLIUtils_1.getBlankSpaceString)(headerLength - optionText.header.length);
         const headerString = `${indent}${prefix}${header} `;
         const headerStringWidth = (0, string_width_1.default)(headerString);
-        const maxWidth = Math.min(process.stdout.columns, 150);
-        const descMaxWidth = maxWidth - headerStringWidth;
-        let descString = optionText.desc.substring(0, descMaxWidth);
-        let descStringRemain = optionText.desc.substring(descMaxWidth);
-        while (descStringRemain.length > 0) {
-            descString += '\n';
-            descString += core_1.utils.repeat(' ', headerStringWidth);
-            descString += descStringRemain.substring(0, descMaxWidth);
-            descStringRemain = descStringRemain.substring(descMaxWidth);
-        }
-        return `${headerString}${descString}`;
+        const maxWidth = Math.min(process.stdout.columns, CLIUtils_1.READABLE_TEXT_WIDTH);
+        const descString = (0, CLIUtils_1.alignTextInBlock)(optionText.desc, {
+            leftIndent: headerStringWidth,
+            lineLength: maxWidth,
+        });
+        return `${headerString}${descString.substring(headerStringWidth)}`;
     }
-    printCommand(command, extraIndent = '', printOptions = false) {
+    printCommand(command, extraIndent = '', options = {}) {
+        var _a;
         const indent = '  ' + extraIndent;
         const name = command.getFullCommand();
-        const desc = core_1.utils.upperCaseFirstCharacter(command.getDescription());
+        const desc = core_1.utils.upperCaseFirstCharacter(command.getDescription().trim());
+        const cmdDoc = command.getDocumenation().trim();
         // get example
         const examples = command.getExamples();
-        let example = '';
-        if (examples.length > 0) {
-            example = ' ' + examples[0].trim();
-        }
-        const cmd = chalk_1.default.green(`memlab ${name}${example}`);
+        const example = (_a = examples[0]) !== null && _a !== void 0 ? _a : '';
+        // write command synopsis
+        const cmd = DocUtils_1.default.generateExampleCommand(name, example, {
+            descriptionAsBashComment: false,
+        });
         let msg = `${indent}${cmd}`;
         msg += `\n${indent}${desc}`;
+        if (options.printOptions && cmdDoc.length > 0) {
+            const cmdDocBlock = (0, CLIUtils_1.alignTextInBlock)(cmdDoc, {
+                leftIndent: indent.length + 2,
+            });
+            msg += `\n\n${chalk_1.default.grey(cmdDocBlock)}`;
+        }
         core_1.info.topLevel(msg);
         // print options info
-        if (printOptions) {
+        if (options.printOptions) {
             // print full options description
             this.printOptions(command, indent);
         }
@@ -221,11 +226,12 @@ class HelperCommand extends BaseCommand_1.default {
         core_1.info.topLevel('');
     }
     printHelperTextForCommand(command, options) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             // print helper text for a specific command
-            this.printCommand(command, options.indent, options.printOptions);
+            this.printCommand(command, options.indent, options);
             // print helper text for its subcommands
-            const subcommands = command.getSubCommands();
+            const subcommands = (_a = command.getSubCommands()) !== null && _a !== void 0 ? _a : [];
             const subOptions = Object.assign({}, options);
             subOptions.indent = (subOptions.indent || '') + ' ';
             for (const subcommand of subcommands) {
@@ -235,6 +241,7 @@ class HelperCommand extends BaseCommand_1.default {
         });
     }
     printFullHelperTextForCommand(args, modules) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             // get the command to print
             let map = modules;
@@ -249,7 +256,7 @@ class HelperCommand extends BaseCommand_1.default {
                 if (!command) {
                     break;
                 }
-                const subCommands = command.getSubCommands();
+                const subCommands = (_a = command.getSubCommands()) !== null && _a !== void 0 ? _a : [];
                 map = new Map(subCommands.map((cmd) => [cmd.getCommandName(), cmd]));
             }
             if (!command) {
@@ -257,9 +264,9 @@ class HelperCommand extends BaseCommand_1.default {
             }
             // print the helper text of the command
             core_1.info.topLevel('');
-            this.printCommand(command, '', true);
+            this.printCommand(command, '', { printOptions: true, printDoc: true });
             // print the helper text of the subcommands
-            const subCommands = command.getSubCommands();
+            const subCommands = (_b = command.getSubCommands()) !== null && _b !== void 0 ? _b : [];
             if (subCommands.length > 0) {
                 core_1.info.topLevel(chalk_1.default.bold('  SUB-COMMANDS\n'));
                 for (const subCommand of subCommands) {

package/dist/commands/helper/lib/DocUtils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall web_perf_infra
+ */
+import type { CommandOptionExample } from '@memlab/core';
+declare type GenerateExampleCommandOption = {
+    descriptionAsBashComment?: boolean;
+};
+declare function generateExampleCommand(command: string, cliExample: CommandOptionExample, options?: GenerateExampleCommandOption): string;
+declare const _default: {
+    generateExampleCommand: typeof generateExampleCommand;
+};
+export default _default;
+//# sourceMappingURL=DocUtils.d.ts.map

package/dist/commands/helper/lib/DocUtils.js

@@ -0,0 +1,39 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall web_perf_infra
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+function generateExampleCommand(command, cliExample, options = {}) {
+    if (typeof cliExample === 'string') {
+        return exampleFromCliOptionString(command, cliExample);
+    }
+    let commandExample = '';
+    if (cliExample.description != null &&
+        // if it's not null, undefined, or true
+        options.descriptionAsBashComment !== false) {
+        const desc = cliExample.description.trim();
+        if (desc.length > 0) {
+            // inject the description as a bash command in the bash example
+            const bashText = cliExample.description
+                .trim()
+                .split('\n')
+                .map(line => `# ${line.trim()}`)
+                .join('\n');
+            commandExample += bashText + '\n';
+        }
+    }
+    commandExample += exampleFromCliOptionString(command, cliExample.cliOptionExample);
+    return commandExample;
+}
+function exampleFromCliOptionString(command, cliExample) {
+    return `memlab ${command} ${cliExample.trim()}`;
+}
+exports.default = {
+    generateExampleCommand,
+};

package/dist/commands/snapshot/TakeSnapshotCommand.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 TakeSnapshotCommand extends BaseCommand {
     getCommandName(): string;
     getDescription(): string;
     getPrerequisites(): BaseCommand[];
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     getOptions(): BaseOption[];
     run(_options: CLIOptions): Promise<void>;
 }

package/dist/commands/snapshot/TakeSnapshotCommand.js

@@ -45,6 +45,7 @@ const DisableWebSecurityOption_1 = __importDefault(require("../../options/e2e/Di
 const EnableJSRewriteOption_1 = __importDefault(require("../../options/e2e/EnableJSRewriteOption"));
 const EnableJSInterceptOption_1 = __importDefault(require("../../options/e2e/EnableJSInterceptOption"));
 const TargetWorkerOption_1 = __importDefault(require("../../options/e2e/TargetWorkerOption"));
+const SetChromiumBinaryOption_1 = __importDefault(require("../../options/e2e/SetChromiumBinaryOption"));
 class TakeSnapshotCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'snapshot';
@@ -80,6 +81,7 @@ class TakeSnapshotCommand 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/snapshot/WarmupAndSnapshotCommand.d.ts

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

package/dist/commands/snapshot/WarmupAndSnapshotCommand.js

@@ -22,6 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseCommand_1 = __importDefault(require("../../BaseCommand"));
+const SetWorkingDirectoryOption_1 = __importDefault(require("../../options/SetWorkingDirectoryOption"));
 const InitDirectoryCommand_1 = __importDefault(require("../InitDirectoryCommand"));
 const WarmupAppCommand_1 = __importDefault(require("../WarmupAppCommand"));
 const TakeSnapshotCommand_1 = __importDefault(require("./TakeSnapshotCommand"));
@@ -32,6 +33,28 @@ class WarmupAndSnapshotCommand extends BaseCommand_1.default {
     getDescription() {
         return 'Warm up server and take heap snapshots';
     }
+    getDocumenation() {
+        const warmupCommand = new WarmupAppCommand_1.default();
+        const warmupCLI = `memlab ${warmupCommand.getCommandName()}`;
+        const takeSnapshotCommand = new TakeSnapshotCommand_1.default();
+        const snapshotCLI = `memlab ${takeSnapshotCommand.getCommandName()}`;
+        return ('This is equivalent to running ' +
+            `\`${warmupCLI}\` and \`${snapshotCLI}\`.`);
+    }
+    getExamples() {
+        return [
+            {
+                description: 'specify a test scenario file, memlab will ' +
+                    'warm up the server and take heap snapshots',
+                cliOptionExample: '--scenario <TEST_SCENARIO_FILE>',
+            },
+            '--scenario /tmp/test-scenario.js',
+            {
+                description: new SetWorkingDirectoryOption_1.default().getDescription(),
+                cliOptionExample: '--scenario /tmp/test-scenario.js --work-dir /tmp/test-1/',
+            },
+        ];
+    }
     getPrerequisites() {
         return [
             new InitDirectoryCommand_1.default(),

package/dist/lib/CLIUtils.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall web_perf_infra
+ */
+import type { ParsedArgs } from 'minimist';
+import type { AnyRecord } from '@memlab/core';
+export declare type BlockTextOption = {
+    leftIndent?: number;
+    lineLength?: number;
+};
+export declare const READABLE_CMD_FLAG_WIDTH = 70;
+export declare const READABLE_TEXT_WIDTH = 150;
+export declare function filterAndGetUndefinedArgs(cliArgs: ParsedArgs): AnyRecord;
+export declare function argsToString(args: AnyRecord): string;
+export declare function getBlankSpaceString(length: number): string;
+export declare function alignTextInBlock(text: string, options: BlockTextOption): string;
+//# sourceMappingURL=CLIUtils.d.ts.map