@memlab/cli 1.0.7 → 1.0.11

package/bin/{memlab → memlab.js}

@@ -6,14 +6,16 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 
-var cli = require("../dist/index");
+// eslint-disable-next-line no-var
+var cli = require('../dist/index');
 
 // register the `@memlab/cli` package info
 // so that `memlab version` get use the info
-(cli.registerPackage()).then(() => {
+// eslint-disable-next-line fb-www/promise-termination
+cli.registerPackage().then(() => {
   cli.run();
 });

package/dist/BaseCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions, Nullable } from '@memlab/core';
 import { BaseOption } from '@memlab/core';

package/dist/BaseCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/CommandLoader.d.ts

@@ -4,19 +4,20 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import BaseCommand from './BaseCommand';
 export default class CommandLoader {
-    private isLoaded;
-    private OSSModules;
-    private modules;
-    private modulePaths;
+    protected isLoaded: boolean;
+    protected OSSModules: Map<string, BaseCommand>;
+    protected modules: Map<string, BaseCommand>;
+    protected modulePaths: Map<string, string>;
     getModules(): Map<string, BaseCommand>;
     getModulePaths(): Map<string, string>;
     registerCommands(): void;
-    private registerCommandsFromDir;
-    private postRegistration;
+    protected shouldRegisterCommand(command: BaseCommand): boolean;
+    protected registerCommandsFromDir(modulesDir: string): void;
+    protected postRegistration(): void;
 }
 //# sourceMappingURL=CommandLoader.d.ts.map

package/dist/CommandLoader.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -41,6 +41,10 @@ class CommandLoader {
         this.registerCommandsFromDir(modulesDir);
         this.postRegistration();
     }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldRegisterCommand(command) {
+        return true;
+    }
     registerCommandsFromDir(modulesDir) {
         const moduleFiles = fs_1.default.readdirSync(modulesDir);
         for (const moduleFile of moduleFiles) {
@@ -61,6 +65,9 @@ class CommandLoader {
             if (!(moduleInstance instanceof BaseCommand_1.default)) {
                 core_1.utils.haltOrThrow('loading a command that does not extend BaseCommand');
             }
+            if (!this.shouldRegisterCommand(moduleInstance)) {
+                continue;
+            }
             const commandName = moduleInstance.getCommandName();
             const loadingOssCommand = !core_1.fileManager.isWithinInternalDirectory(modulePath);
             // reigster OSS commands

package/dist/Dispatcher.d.ts

@@ -4,22 +4,27 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { ParsedArgs } from 'minimist';
 import type { AnyRecord, MemLabConfig } from '@memlab/core';
 import BaseCommand from './BaseCommand';
+import CommandLoader from './CommandLoader';
 declare type RunCommandOptions = {
     isPrerequisite?: boolean;
     commandIndex?: number;
     configFromOptions: AnyRecord;
 };
-declare class CommandDispatcher {
+declare type CommandDispatcherOptions = {
+    commandLoader?: CommandLoader;
+};
+export declare class CommandDispatcher {
     private modules;
     private executedCommands;
     private executingCommandStack;
-    constructor();
+    constructor(options?: CommandDispatcherOptions);
+    protected resetData(): void;
     dispatch(args: ParsedArgs): Promise<void>;
     parseOptions(command: BaseCommand, config: MemLabConfig, args: ParsedArgs): Promise<AnyRecord>;
     private runCommand;

package/dist/Dispatcher.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -21,21 +21,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandDispatcher = void 0;
 const core_1 = require("@memlab/core");
 const HelperCommand_1 = __importDefault(require("./commands/helper/HelperCommand"));
 const UniversalOptions_1 = __importDefault(require("./options/lib/UniversalOptions"));
 const CommandLoader_1 = __importDefault(require("./CommandLoader"));
 const helperCommand = new HelperCommand_1.default();
 class CommandDispatcher {
-    constructor() {
-        this.executedCommands = new Set();
-        this.executingCommandStack = [];
+    constructor(options = {}) {
+        var _a;
+        this.resetData();
         // auto load all command modules
-        const commandLoader = new CommandLoader_1.default();
+        const commandLoader = (_a = options.commandLoader) !== null && _a !== void 0 ? _a : new CommandLoader_1.default();
         this.modules = commandLoader.getModules();
     }
+    resetData() {
+        this.executedCommands = new Set();
+        this.executingCommandStack = [];
+    }
     dispatch(args) {
         return __awaiter(this, void 0, void 0, function* () {
+            this.resetData();
             // triggered by `memlab` (without specific command)
             if (!args._ || !(args._.length >= 1)) {
                 core_1.info.error('\n  command argument missing');
@@ -121,7 +127,7 @@ class CommandDispatcher {
             const subCommands = command.getSubCommands();
             for (const subCommand of subCommands) {
                 if (subCommand.getCommandName() === args._[subCommandIndex]) {
-                    this.runCommand(subCommand, args, runCmdOpt);
+                    yield this.runCommand(subCommand, args, runCmdOpt);
                     return;
                 }
             }
@@ -140,4 +146,5 @@ class CommandDispatcher {
         });
     }
 }
+exports.CommandDispatcher = CommandDispatcher;
 exports.default = new CommandDispatcher();

package/dist/TypesThirdParty.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 /// <reference types="node" />
 declare module 'html-inline' {

package/dist/TypesThirdParty.js

@@ -5,6 +5,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */

package/dist/commands/CleanLoggerDataCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../BaseCommand';

package/dist/commands/CleanLoggerDataCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/CleanRunDataCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../BaseCommand';

package/dist/commands/CleanRunDataCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/GetVersionCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../BaseCommand';

package/dist/commands/GetVersionCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -53,7 +53,7 @@ class GetVersionCommand extends BaseCommand_1.default {
     run(options) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.loadDepencyPackageInfo();
-            const packages = core_1.config.packageInfo;
+            const packages = [...core_1.config.packageInfo].sort((p1, p2) => p1.name < p2.name ? 1 : -1);
             core_1.info.topLevel('');
             for (const pkg of packages) {
                 const version = chalk_1.default.grey(`@${pkg.version}`);

package/dist/commands/InitDirectoryCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../BaseCommand';

package/dist/commands/InitDirectoryCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/ListScenariosCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../BaseCommand';

package/dist/commands/ListScenariosCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/MemLabRunCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { BaseOption, CLIOptions } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../BaseCommand';

package/dist/commands/MemLabRunCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

package/dist/commands/PrintSummaryCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../BaseCommand';

package/dist/commands/PrintSummaryCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/ResetDirectoryCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../BaseCommand';

package/dist/commands/ResetDirectoryCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/RunMeasureCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../BaseCommand';

package/dist/commands/RunMeasureCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/WarmupAppCommand.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import { BaseOption } from '@memlab/core';

package/dist/commands/WarmupAppCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

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

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';

package/dist/commands/heap/CheckLeakCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -60,6 +60,7 @@ const LeakFilterFileOption_1 = __importDefault(require("../../options/heap/leak-
 const LeakClusterSizeThresholdOption_1 = __importDefault(require("../../options/heap/LeakClusterSizeThresholdOption"));
 const MLClusteringOption_1 = __importDefault(require("../../options/MLClusteringOption"));
 const MLClusteringLinkageMaxDistanceOption_1 = __importDefault(require("../../options/MLClusteringLinkageMaxDistanceOption"));
+const MLClusteringMaxDFOption_1 = __importDefault(require("../../options/MLClusteringMaxDFOption"));
 class CheckLeakCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'find-leaks';
@@ -87,6 +88,7 @@ class CheckLeakCommand extends BaseCommand_1.default {
             new LogTraceAsClusterOption_1.default(),
             new MLClusteringOption_1.default(),
             new MLClusteringLinkageMaxDistanceOption_1.default(),
+            new MLClusteringMaxDFOption_1.default(),
         ];
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars

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

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';

package/dist/commands/heap/GetRetainerTraceCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

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

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';

package/dist/commands/heap/HeapAnalysisCommand.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

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

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { CLIOptions } from '@memlab/core';
 import { BaseOption } from '@memlab/core';

package/dist/commands/heap/HeapAnalysisSubCommandWrapper.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

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

@@ -0,0 +1,16 @@
+/**
+ * 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 ws_labs
+ */
+import BaseCommand from '../../../BaseCommand';
+import CommandLoader from '../../../CommandLoader';
+export default class InteractiveCommandLoader extends CommandLoader {
+    protected shouldRegisterCommand(command: BaseCommand): boolean;
+    protected postRegistration(): void;
+}
+//# sourceMappingURL=InteractiveCommandLoader.d.ts.map

package/dist/commands/heap/interactive/InteractiveCommandLoader.js

@@ -0,0 +1,33 @@
+"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 ws_labs
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const CommandLoader_1 = __importDefault(require("../../../CommandLoader"));
+const HelperCommand_1 = __importDefault(require("../../helper/HelperCommand"));
+const GetRetainerTraceCommand_1 = __importDefault(require("../GetRetainerTraceCommand"));
+const HeapAnalysisCommand_1 = __importDefault(require("../HeapAnalysisCommand"));
+const commandToInclude = new Set([
+    HeapAnalysisCommand_1.default,
+    GetRetainerTraceCommand_1.default,
+    HelperCommand_1.default,
+]);
+class InteractiveCommandLoader extends CommandLoader_1.default {
+    shouldRegisterCommand(command) {
+        const constructor = command.constructor;
+        return commandToInclude.has(constructor);
+    }
+    postRegistration() {
+        // do nothing
+    }
+}
+exports.default = InteractiveCommandLoader;

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

@@ -0,0 +1,28 @@
+/**
+ * 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 ws_labs
+ */
+import { CLIOptions } 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[];
+    getOptions(): BaseOption[];
+    private exitAttempt;
+    private printPromptInfo;
+    private quit;
+    private initPrompt;
+    private setupInterruptHandle;
+    private setupCommandHandle;
+    private startInteractiveCLI;
+    run(options: CLIOptions): Promise<void>;
+}
+//# sourceMappingURL=InteractiveHeapCommand.d.ts.map