@memlab/cli 1.0.43 → 1.0.44

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -27,7 +27,7 @@ export default class BaseCommand extends Command {
27
27
  getExamples(): CommandOptionExample[];
28
28
  getCategory(): CommandCategory;
29
29
  getDescription(): string;
30
- getDocumenation(): string;
30
+ getDocumentation(): string;
31
31
  getPrerequisites(): BaseCommand[];
32
32
  isInternalCommand(): boolean;
33
33
  getOptions(): BaseOption[];
@@ -1 +1 @@
1
- {"version":3,"file":"BaseCommand.d.ts","sourceRoot":"","sources":["../src/BaseCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,UAAU,EACV,oBAAoB,EACpB,QAAQ,EACR,QAAQ,EACT,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAC,UAAU,EAAC,MAAM,cAAc,CAAC;AAExC,oBAAY,eAAe;IACzB,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED,uBAAe,OAAO;IACpB,cAAc,IAAI,MAAM;IAUxB,OAAO,CAAC,aAAa,CAA+B;IAEpD,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;IAI3C,gBAAgB,IAAI,QAAQ,CAAC,WAAW,CAAC;IAIzC,cAAc,IAAI,MAAM;IAOxB,mCAAmC,IAAI,UAAU,EAAE;CA6BpD;AAED,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,OAAO;IAG9C,cAAc,IAAI,MAAM;IAOxB,WAAW,IAAI,oBAAoB,EAAE;IAMrC,WAAW,IAAI,eAAe;IAM9B,cAAc,IAAI,MAAM;IAQxB,eAAe,IAAI,MAAM;IAMzB,gBAAgB,IAAI,WAAW,EAAE;IAKjC,iBAAiB,IAAI,OAAO;IAK5B,UAAU,IAAI,UAAU,EAAE;IAQ1B,kBAAkB,IAAI,UAAU,EAAE;IAYlC,cAAc,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;IAOnC,GAAG,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAI/C"}
1
+ {"version":3,"file":"BaseCommand.d.ts","sourceRoot":"","sources":["../src/BaseCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,UAAU,EACV,oBAAoB,EACpB,QAAQ,EACR,QAAQ,EACT,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAC,UAAU,EAAC,MAAM,cAAc,CAAC;AAExC,oBAAY,eAAe;IACzB,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED,uBAAe,OAAO;IACpB,cAAc,IAAI,MAAM;IAUxB,OAAO,CAAC,aAAa,CAA+B;IAEpD,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;IAI3C,gBAAgB,IAAI,QAAQ,CAAC,WAAW,CAAC;IAIzC,cAAc,IAAI,MAAM;IAOxB,mCAAmC,IAAI,UAAU,EAAE;CA6BpD;AAED,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,OAAO;IAG9C,cAAc,IAAI,MAAM;IAOxB,WAAW,IAAI,oBAAoB,EAAE;IAMrC,WAAW,IAAI,eAAe;IAM9B,cAAc,IAAI,MAAM;IAQxB,gBAAgB,IAAI,MAAM;IAM1B,gBAAgB,IAAI,WAAW,EAAE;IAKjC,iBAAiB,IAAI,OAAO;IAK5B,UAAU,IAAI,UAAU,EAAE;IAQ1B,kBAAkB,IAAI,UAAU,EAAE;IAYlC,cAAc,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;IAOnC,GAAG,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAI/C"}
@@ -104,7 +104,7 @@ class BaseCommand extends Command {
104
104
  // More detailed description or documentation about this command.
105
105
  // This will be printed as helper text in CLI for a specific command.
106
106
  // Documentation generator will also use the description returned here.
107
- getDocumenation() {
107
+ getDocumentation() {
108
108
  return '';
109
109
  }
110
110
  // get a sequence of commands that must be executed before
@@ -16,7 +16,7 @@ export default class RunMeasureCommand extends BaseCommand {
16
16
  getPrerequisites(): BaseCommand[];
17
17
  getExamples(): CommandOptionExample[];
18
18
  getOptions(): BaseOption[];
19
- getDocumenation(): string;
19
+ getDocumentation(): string;
20
20
  run(options: CLIOptions): Promise<void>;
21
21
  }
22
22
  //# sourceMappingURL=RunMeasureCommand.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"RunMeasureCommand.d.ts","sourceRoot":"","sources":["../../src/commands/RunMeasureCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,UAAU,EAAE,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAEnE,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAEzC,OAAO,EAAgB,UAAU,EAAC,MAAM,cAAc,CAAC;AA0BvD,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,WAAW;IACxD,cAAc,IAAI,MAAM;IAIxB,cAAc,IAAI,MAAM;IAIxB,gBAAgB,IAAI,WAAW,EAAE;IAIjC,WAAW,IAAI,oBAAoB,EAAE;IAQrC,UAAU,IAAI,UAAU,EAAE;IA2B1B,eAAe,IAAI,MAAM;IAYnB,GAAG,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAS9C"}
1
+ {"version":3,"file":"RunMeasureCommand.d.ts","sourceRoot":"","sources":["../../src/commands/RunMeasureCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,UAAU,EAAE,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAEnE,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAEzC,OAAO,EAAgB,UAAU,EAAC,MAAM,cAAc,CAAC;AA0BvD,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,WAAW;IACxD,cAAc,IAAI,MAAM;IAIxB,cAAc,IAAI,MAAM;IAIxB,gBAAgB,IAAI,WAAW,EAAE;IAIjC,WAAW,IAAI,oBAAoB,EAAE;IAQrC,UAAU,IAAI,UAAU,EAAE;IA2B1B,gBAAgB,IAAI,MAAM;IAYpB,GAAG,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAS9C"}
@@ -91,7 +91,7 @@ class RunMeasureCommand extends BaseCommand_1.default {
91
91
  new EnableJSInterceptOption_1.default(),
92
92
  ];
93
93
  }
94
- getDocumenation() {
94
+ getDocumentation() {
95
95
  return ('In some web apps, the heap size can show considerable variability' +
96
96
  ' across various runs. This fluctuation can often make it hard to' +
97
97
  ' understand the impact of memory leaks. The introduction of the measure' +
@@ -22,7 +22,7 @@ export default class CheckLeakCommand extends BaseCommand {
22
22
  getCommandName(): string;
23
23
  getExamples(): CommandOptionExample[];
24
24
  getDescription(): string;
25
- getDocumenation(): string;
25
+ getDocumentation(): string;
26
26
  getCategory(): CommandCategory;
27
27
  getPrerequisites(): BaseCommand[];
28
28
  getOptions(): BaseOption[];
@@ -1 +1 @@
1
- {"version":3,"file":"CheckLeakCommand.d.ts","sourceRoot":"","sources":["../../../src/commands/heap/CheckLeakCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,oBAAoB,EAErB,MAAM,cAAc,CAAC;AAEtB,OAAO,WAAW,EAAE,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAsB/D,MAAM,MAAM,uBAAuB,GAAG;IACpC,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,WAAW;IACvD,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,0BAA0B,CAAS;IAE3C,SAAS,CAAC,6BAA6B,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;IAOlE,SAAS,CAAC,iCAAiC,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;gBAM1D,OAAO,GAAE,uBAA4B;IAKjD,cAAc,IAAI,MAAM;IAIxB,WAAW,IAAI,oBAAoB,EAAE;IAgCrC,cAAc,IAAI,MAAM;IAIxB,eAAe,IAAI,MAAM;IAqBzB,WAAW,IAAI,eAAe;IAI9B,gBAAgB,IAAI,WAAW,EAAE;IAIjC,UAAU,IAAI,UAAU,EAAE;IAqBpB,GAAG,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAoB9C"}
1
+ {"version":3,"file":"CheckLeakCommand.d.ts","sourceRoot":"","sources":["../../../src/commands/heap/CheckLeakCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,oBAAoB,EAErB,MAAM,cAAc,CAAC;AAEtB,OAAO,WAAW,EAAE,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAsB/D,MAAM,MAAM,uBAAuB,GAAG;IACpC,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,WAAW;IACvD,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,0BAA0B,CAAS;IAE3C,SAAS,CAAC,6BAA6B,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;IAOlE,SAAS,CAAC,iCAAiC,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;gBAM1D,OAAO,GAAE,uBAA4B;IAKjD,cAAc,IAAI,MAAM;IAIxB,WAAW,IAAI,oBAAoB,EAAE;IAgCrC,cAAc,IAAI,MAAM;IAIxB,gBAAgB,IAAI,MAAM;IAqB1B,WAAW,IAAI,eAAe;IAI9B,gBAAgB,IAAI,WAAW,EAAE;IAIjC,UAAU,IAAI,UAAU,EAAE;IAqBpB,GAAG,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAoB9C"}
@@ -105,7 +105,7 @@ class CheckLeakCommand extends BaseCommand_1.default {
105
105
  cliOptionExample: `${baselineOption} /tmp/baseline.heapsnapshot ${targetOption} /tmp/target.heapsnapshot ${finalOption} /tmp/final.heapsnapshot`,
106
106
  },
107
107
  {
108
- description: 'specifies the directory that holds all three heap snapshot files',
108
+ description: 'specifies the directory that contains all three heap snapshot files',
109
109
  cliOptionExample: `${snapshotDirOption} /dir/containing/heapsnapshot/files/`,
110
110
  },
111
111
  {
@@ -117,7 +117,7 @@ class CheckLeakCommand extends BaseCommand_1.default {
117
117
  getDescription() {
118
118
  return 'find memory leaks in heap snapshots';
119
119
  }
120
- getDocumenation() {
120
+ getDocumentation() {
121
121
  const optionNames = OptionConstant_1.default.optionNames;
122
122
  const workDirOption = `--${optionNames.WORK_DIR}`;
123
123
  const snapshotDirOption = `--${optionNames.SNAPSHOT_DIR}`;
@@ -126,7 +126,7 @@ class CheckLeakCommand extends BaseCommand_1.default {
126
126
  const finalOption = `--${optionNames.FINAL}`;
127
127
  return `There are three ways to specify inputs for the \`memlab ${this.getCommandName()}\` command:
128
128
  1. \`${baselineOption}\`, \`${targetOption}\`, \`${finalOption}\` specifies each heap snapshot input individually;
129
- 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);
129
+ 2. \`${snapshotDirOption}\` specifies the directory that contains all three heap snapshot files (MemLab will assign baseline, target, and final based on alphabetic order of the file);
130
130
  3. \`${workDirOption}\` specifies the output working directory of the \`memlab run\` or the \`memlab snapshot\` command;
131
131
 
132
132
  Please only use one of the three ways to specify the input.
@@ -109,7 +109,7 @@ class ComponentDataItem {
109
109
  if (data.referenceEdge) {
110
110
  ret += this.getHeapEdgeTextContent(data.referenceEdge);
111
111
  }
112
- return ret === '' ? chalk_1.default.grey('<undefinied>') : ret;
112
+ return ret === '' ? chalk_1.default.grey('<undefined>') : ret;
113
113
  }
114
114
  }
115
115
  exports.ComponentDataItem = ComponentDataItem;
@@ -149,7 +149,7 @@ npm install -g memlab
149
149
  var _a, _b;
150
150
  const name = command.getFullCommand();
151
151
  const desc = core_1.utils.upperCaseFirstCharacter(command.getDescription().trim());
152
- const cmdDoc = command.getDocumenation().trim();
152
+ const cmdDoc = command.getDocumentation().trim();
153
153
  // write command title
154
154
  this.writeTextWithNewLine(docFile, `\n###${indent} memlab ${name}\n`);
155
155
  // write description
@@ -204,7 +204,7 @@ class HelperCommand extends BaseCommand_1.default {
204
204
  const indent = ' ' + extraIndent;
205
205
  const name = command.getFullCommand();
206
206
  const desc = core_1.utils.upperCaseFirstCharacter(command.getDescription().trim());
207
- const cmdDoc = command.getDocumenation().trim();
207
+ const cmdDoc = command.getDocumentation().trim();
208
208
  // get example
209
209
  const examples = command.getExamples();
210
210
  const example = (_a = examples[0]) !== null && _a !== void 0 ? _a : '';
@@ -12,7 +12,7 @@ import BaseCommand from '../../BaseCommand';
12
12
  export default class WarmupAndSnapshotCommand extends BaseCommand {
13
13
  getCommandName(): string;
14
14
  getDescription(): string;
15
- getDocumenation(): string;
15
+ getDocumentation(): string;
16
16
  getExamples(): CommandOptionExample[];
17
17
  getPrerequisites(): BaseCommand[];
18
18
  run(_options: CLIOptions): Promise<void>;
@@ -1 +1 @@
1
- {"version":3,"file":"WarmupAndSnapshotCommand.d.ts","sourceRoot":"","sources":["../../../src/commands/snapshot/WarmupAndSnapshotCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,UAAU,EAAE,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAEnE,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAM5C,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,WAAW;IAC/D,cAAc,IAAI,MAAM;IAIxB,cAAc,IAAI,MAAM;IAIxB,eAAe,IAAI,MAAM;IAWzB,WAAW,IAAI,oBAAoB,EAAE;IAiBrC,gBAAgB,IAAI,WAAW,EAAE;IAS3B,GAAG,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAG/C"}
1
+ {"version":3,"file":"WarmupAndSnapshotCommand.d.ts","sourceRoot":"","sources":["../../../src/commands/snapshot/WarmupAndSnapshotCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,UAAU,EAAE,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAEnE,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAM5C,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,WAAW;IAC/D,cAAc,IAAI,MAAM;IAIxB,cAAc,IAAI,MAAM;IAIxB,gBAAgB,IAAI,MAAM;IAW1B,WAAW,IAAI,oBAAoB,EAAE;IAiBrC,gBAAgB,IAAI,WAAW,EAAE;IAS3B,GAAG,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAG/C"}
@@ -33,7 +33,7 @@ class WarmupAndSnapshotCommand extends BaseCommand_1.default {
33
33
  getDescription() {
34
34
  return 'Warm up server and take heap snapshots';
35
35
  }
36
- getDocumenation() {
36
+ getDocumentation() {
37
37
  const warmupCommand = new WarmupAppCommand_1.default();
38
38
  const warmupCLI = `memlab ${warmupCommand.getCommandName()}`;
39
39
  const takeSnapshotCommand = new TakeSnapshotCommand_1.default();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@memlab/cli",
3
- "version": "1.0.43",
3
+ "version": "1.0.44",
4
4
  "license": "MIT",
5
5
  "description": "command line interface for memlab",
6
6
  "author": "Liang Gong <lgong@meta.com>",
@@ -26,10 +26,10 @@
26
26
  "access": "public"
27
27
  },
28
28
  "dependencies": {
29
- "@memlab/api": "^1.0.40",
30
- "@memlab/core": "^1.1.41",
31
- "@memlab/e2e": "^1.0.41",
32
- "@memlab/heap-analysis": "^1.0.38",
29
+ "@memlab/api": "^1.0.41",
30
+ "@memlab/core": "^1.1.42",
31
+ "@memlab/e2e": "^1.0.42",
32
+ "@memlab/heap-analysis": "^1.0.39",
33
33
  "ansi": "^0.3.1",
34
34
  "babar": "^0.2.0",
35
35
  "blessed": "^0.1.81",