@memlab/cli 1.0.23 → 1.0.25

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,14 +24,15 @@ declare abstract class Command {
 }
 export default class BaseCommand extends Command {
     getCommandName(): string;
-    getExamples(): string[];
+    getExamples(): CommandOptionExample[];
     getCategory(): CommandCategory;
     getDescription(): string;
+    getDocumenation(): string;
     getPrerequisites(): BaseCommand[];
     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 [];
@@ -101,6 +101,12 @@ class BaseCommand extends Command {
         const className = this.constructor.name;
         throw new Error(`${className}.getDescription is not implemented`);
     }
+    // More detailed description or documentation about this command.
+    // This will be printed as helper text in CLI for a specific command.
+    // Documentation generator will also use the description returned here.
+    getDocumenation() {
+        return '';
+    }
     // get a sequence of commands that must be executed before
     // running this command
     getPrerequisites() {
@@ -125,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(),
@@ -86,9 +88,8 @@ class RunMeasureCommand extends BaseCommand_1.default {
         ];
     }
     run(options) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const numRuns = (_b = (_a = options.configFromOptions) === null || _a === void 0 ? void 0 : _a.numOfRuns) !== null && _b !== void 0 ? _b : NumberOfRunsOption_1.default.DEFAULT_NUM_RUNS;
+            const numRuns = NumberOfRunsOption_1.default.getParsedOption(options.configFromOptions);
             core_1.config.runningMode = core_1.modes.get('measure', core_1.config);
             for (let i = 0; i < numRuns; ++i) {
                 yield (0, Snapshot_1.runPageInteractionFromCLI)();

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

@@ -7,11 +7,22 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { BaseOption, CLIOptions } from '@memlab/core';
+import type { ParsedArgs } from 'minimist';
+import type { BaseOption, CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';
+export declare type CheckLeakCommandOptions = {
+    isMLClustering?: boolean;
+};
 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;
+    getExamples(): CommandOptionExample[];
     getDescription(): string;
+    getDocumenation(): string;
     getCategory(): CommandCategory;
     getPrerequisites(): BaseCommand[];
     getOptions(): BaseOption[];

package/dist/commands/heap/CheckLeakCommand.js

@@ -1,13 +1,4 @@
 "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
- */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -63,13 +54,77 @@ 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();
+        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 '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() {
+        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.
+
+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;
     }
@@ -100,8 +155,15 @@ class CheckLeakCommand extends BaseCommand_1.default {
         return __awaiter(this, void 0, void 0, function* () {
             const workDir = (_a = options.configFromOptions) === null || _a === void 0 ? void 0 : _a.workDir;
             core_1.fileManager.initDirs(core_1.config, { workDir });
+            const { runMetaInfoManager } = core_1.runInfoUtils;
+            runMetaInfoManager.setConfigFromRunMeta({
+                workDir,
+                silentFail: true,
+            });
             core_1.config.chaseWeakMapEdge = false;
+            this.useDefaultMLClusteringSetting(options.cliArgs);
             yield core_1.analysis.checkLeak();
+            this.restoreDefaultMLClusteringSetting(options.cliArgs);
             const configFromOptions = (_b = options.configFromOptions) !== null && _b !== void 0 ? _b : {};
             if (configFromOptions['cleanUpSnapshot']) {
                 core_1.fileManager.removeSnapshotFiles();

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

@@ -7,15 +7,26 @@
  * @format
  * @oncall web_perf_infra
  */
-import { 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';
-import { BaseOption } from '@memlab/core';
+export declare type WorkDirSettings = {
+    controlWorkDirs: Array<string>;
+    treatmentWorkDir: 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

@@ -1,13 +1,4 @@
 "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
- */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -45,9 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@memlab/core");
-const core_2 = require("@memlab/core");
 const BaseCommand_1 = __importStar(require("../../BaseCommand"));
-const core_3 = require("@memlab/core");
 const JSEngineOption_1 = __importDefault(require("../../options/heap/JSEngineOption"));
 const InitDirectoryCommand_1 = __importDefault(require("../InitDirectoryCommand"));
 const OversizeThresholdOption_1 = __importDefault(require("../../options/heap/OversizeThresholdOption"));
@@ -61,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';
     }
@@ -76,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(),
@@ -87,23 +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.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'];
+        return {
+            controlWorkDirs,
+            treatmentWorkDir,
+        };
+    }
+    run(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            core_3.config.chaseWeakMapEdge = false;
-            // double check parameters
-            if (!((_a = options.configFromOptions) === null || _a === void 0 ? void 0 : _a.controlWorkDir) ||
-                !((_b = options.configFromOptions) === null || _b === void 0 ? void 0 : _b.treatmentWorkDir)) {
-                core_2.info.error('Please specify control and test working directory');
-                throw core_1.utils.haltOrThrow('No control or test working directory specified');
-            }
-            // get parameters
-            const controlWorkDir = options.configFromOptions['controlWorkDir'];
-            const treatmentWorkDir = options.configFromOptions['treatmentWorkDir'];
+            core_1.config.chaseWeakMapEdge = false;
+            const { controlWorkDirs, treatmentWorkDir } = this.getWorkDirs(options);
+            const { runMetaInfoManager } = core_1.runInfoUtils;
+            runMetaInfoManager.setConfigFromRunMeta({
+                workDir: treatmentWorkDir,
+                silentFail: true,
+            });
             // diff memory leaks
-            yield core_3.analysis.diffLeakByWorkDir({ controlWorkDir, treatmentWorkDir });
+            this.useDefaultMLClusteringSetting(options.cliArgs);
+            yield core_1.analysis.diffLeakByWorkDir({ controlWorkDirs, treatmentWorkDir });
+            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/CliScreen.d.ts

@@ -12,6 +12,7 @@ export default class CliScreen {
     private currentFocuseKey;
     private keyToComponent;
     private heapController;
+    private fullScreenComponent;
     constructor(title: string, heap: IHeapSnapshot, objectCategory: Map<string, ComponentDataItem[]>);
     private setFirstObjectAsCurrrent;
     private initScreen;
@@ -19,9 +20,12 @@ export default class CliScreen {
     start(): void;
     private registerEvents;
     private registerScreenResize;
+    private updateAllComponentsSize;
     private updateComponentSize;
     private updateElementSize;
     private registerKeys;
+    private makeComponentFullScreen;
+    private makeNoComponentFullScreen;
     private addComponentToFocusKeyMap;
     private getNextFocusKey;
     private initClusteredObjectBox;
@@ -29,6 +33,7 @@ export default class CliScreen {
     private initReferrerBox;
     private getReferrerBoxSize;
     private initObjectBox;
+    private getComponentFullScreenSize;
     private getObjectBoxSize;
     private initObjectPropertyBox;
     private getObjectPropertyBoxSize;