memlab 1.1.9-alpha → 1.1.12-alpha

package/README.md

@@ -9,7 +9,7 @@ for analyzing heap snapshots taken from Chrome/Chromium, Node.js, Hermes, and El
 Install the CLI
 
 ```bash
-npm install -g @memlab
+npm install -g memlab
 ```
 
 ### Find Memory Leaks
@@ -25,11 +25,13 @@ function url() {
 
 // action where we want to detect memory leaks: click the Hotels button
 async function action(page) {
+  // puppeteer page API
   await page.click('button[aria-label="Hotels"]');
 }
 
 // action where we want to go back to the step before: click clear search
 async function back(page) {
+  // puppeteer page API
   await page.click('[aria-label="Clear search"]');
 }
 
@@ -47,7 +49,7 @@ If you want to use a self-defined leak detector, add a `filterLeak` callback
 in the scenario file. `filterLeak` will be called for every unreleased heap
 object (`node`) allocated by the target interaction.
 
-```
+```javascript
 function filterLeak(node, heap) {
   // ... your leak detector logic
   // return true to mark the node as a memory leak
@@ -55,6 +57,7 @@ function filterLeak(node, heap) {
 ```
 
 `heap` is the graph representation of the final JavaScript heap snapshot.
+For more details, view the [doc site](https://facebookincubator.github.io/memlab).
 
 ### Heap Analysis and Investigation
 

package/bin/memlab

@@ -1,4 +1,4 @@
-#!/usr/bin/env -S node --expose-gc --max-old-space-size=4096
+#!/usr/bin/env node --expose-gc --max-old-space-size=4096
 
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "memlab",
-  "version": "1.1.9-alpha",
+  "version": "1.1.12-alpha",
   "license": "MIT",
   "description": "memlab is a framework that analyzes memory and finds memory leaks in JavaScript applications.",
   "main": "dist/index.js",
@@ -50,6 +50,7 @@
     "typescript": "^4.6.3"
   },
   "scripts": {
+    "preinstall": "node bin/preinstall",
     "build-pkg": "tsc",
     "clean-pkg": "rm -rf ./dist && rm -rf ./node_modules && rm -f ./tsconfig.tsbuildinfo"
   },