# perfdoc

> CLI tool to get human readable about v8 de-optimizations

Latest version **0.0.3** (published 2018-04-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install perfdoc
pnpm add perfdoc
yarn add perfdoc
bun add perfdoc
```

Provides the command `perfdoc`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2018-04-30 |
| First published | 2018-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 106.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Marvin Hagemeister |
| Maintainers | marvinhagemeister |

## Links

- npm: https://www.npmjs.com/package/perfdoc
- Repository: https://github.com/marvinhagemeister/perfdoc
- Homepage: https://github.com/marvinhagemeister/perfdoc#readme
- Issues: https://github.com/marvinhagemeister/perfdoc/issues
- npm.io page: https://npm.io/package/perfdoc

## Dependencies (3)

- [mri](https://npm.io/package/mri.md) ^1.1.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [@marvinh/locateable-error](https://npm.io/package/@marvinh/locateable-error.md) ^1.2.1

## Recent versions

- 0.0.3 (latest) — 2018-04-30
- 0.0.2 — 2018-04-30
- 0.0.1 — 2018-04-30

## README

# perfdoc

Print V8 deoptimization reasons in a developer friendly way.

Example output:

![Default CLI output](./fancy.png)

Example output with `--short` flag:

![Short CLI output](./short.png)

## Usage

```bash
npm i -g perfdoc
```

and then run the script you want to analyze

```bash
perfdoc foo.js
```

## CLI

```txt
🔍  Print V8 deoptimization reasons in a developer friendly way

Usage:
  $ perfdoc [options] <file>

Options:
  --short         Hide code frame
  --bail          Exit with code 1 if a deoptimization has been found
  --help, -h      Show usage information and the options listed here
  --version, -v   Show version information

Examples:
  $ perfdoc foo.js
  $ perfdoc --short foo.js
  $ node --trace-deopt foo.js | perfdoc
```

## License

`MIT`, see [license file](./LICENSE.md).

---
_Source: https://npm.io/package/perfdoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._