# lizard-py

> A Node.js wrapper for Lizard, a code complexity analyser.

Latest version **0.0.3** (published 2019-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install lizard-py
pnpm add lizard-py
yarn add lizard-py
bun add lizard-py
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-09-23 |
| First published | 2019-09-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | remin |
| Maintainers | remin |

## Links

- npm: https://www.npmjs.com/package/lizard-py
- Repository: git@github.com:rdrgn/node-lizard-py
- npm.io page: https://npm.io/package/lizard-py

## Recent versions

- 0.0.3 (latest) — 2019-09-23
- 0.0.2 — 2019-09-23
- 0.0.1 — 2019-09-23
- 0.0.0 — 2019-09-12

## README

# Lizard on npm

[![Latest NPM release][npm-badge]][npm-badge-url]
[![Install Size][npm-size-badge]][npm-size-badge-url]
[![License][license-badge]][license-badge-url]

A Node.js wrapper for [Lizard](https://github.com/terryyin/lizard), a code complexity analyser.

## Requirements

- Node.js
- Python

## Usage

```
yarn add lizard-py
```

### Sample code

```ts
import * as lizard from 'lizard-py';

const result = lizard.analyzeFile('fizzbuzz.cpp');
const s = JSON.stringify(result);
console.log(s);
```

You can also use source code string instead of file.

```ts
const result = lizard.analyzeSourceCode('foo.cpp', 'int foo(){}');
```

[Sample input and output](./__tests__)

## Licence

[![License][license-badge]][license-badge-url]

[npm-badge]: https://img.shields.io/npm/v/lizard-py.svg
[npm-badge-url]: https://www.npmjs.com/package/lizard-py
[npm-size-badge]: https://packagephobia.now.sh/badge?p=lizard-py
[npm-size-badge-url]: https://packagephobia.now.sh/result?p=lizard-py
[license-badge]: https://img.shields.io/npm/l/lizard-py.svg
[license-badge-url]: ./LICENSE

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