# complan

> COMPLexity ANalyzer Tool For Javascript

Latest version **1.0.9** (published 2016-10-26) · MIT license · 0 weekly downloads

## Install

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

Provides the command `complan`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.9 |
| Published | 2016-10-26 |
| First published | 2016-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Pranav Parikh |
| Maintainers | complan, pranavparikh |
| Keywords | complexity, node, javascript |

## Links

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

## Dependencies (9)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [lodash](https://npm.io/package/lodash.md) ^4.16.4
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.4
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.30.0
- [node-dir](https://npm.io/package/node-dir.md) ^0.1.16
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [git-clone](https://npm.io/package/git-clone.md) ^0.1.0
- [git-url-parse](https://npm.io/package/git-url-parse.md) ^6.0.5
- [complexity-report](https://npm.io/package/complexity-report.md) ^1.4.1

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.9 (latest) — 2016-10-26
- 1.0.8 — 2016-10-26
- 1.0.7 — 2016-10-25
- 1.0.6 — 2016-10-15
- 1.0.5 — 2016-10-11
- 1.0.4 — 2016-10-05
- 1.0.3 — 2016-10-03
- 1.0.2 — 2016-10-03
- 1.0.1 — 2016-10-03
- 1.0.0 — 2016-09-30

## README

# Complan

A Complexity Analyzer Tool which computes software complexity for a Javascript project hosted on Github.

* [How it works](#how-it-works)
* [Installation](#installation)
* [Usage](#usage)
    * [Command-line options](#command-line-options)
* [License](#license)

## How it works

```Complan``` is a node.js based
command-line wrapper around [complexity-report] (https://www.npmjs.com/package/complexity-report) which computes code complexity for a Javascript project hosted on Github.


## Installation

Assuming you've nodejs installed,

For a project-based ~~install:~~

```
npm install complan
```

For global installation:

```
sudo npm install -g complan
```

## Usage

```
complan -g <git url>
```
```
e.g 
complan -g https://github.com/pranavparikh/complan
or 
complan -g git@github.com:pranavparikh/complan.git
```
The above command will generate complexity report (JSON and HTML files) under a directory named ```pranavparikh/complan``` in your current directory.

The tool will locally clone the repository from git (Git has to be installed as a pre-requisite) , compute complexity and output it in a form of JSON & HTML reports.

### Command-line options

```
-h, --help                            output usage information
-g, --gitUrl <path>                   specify the http url or the git url of the repository
-c, --gitCheckout                     Branch / tag / checkout of the git project (Defaults to master)
```
## License

[MIT]

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