https://github.com/pranavparikh/complan
COMPLexity ANalyzer Tool for Javascript projects
https://github.com/pranavparikh/complan
code
Last synced: 4 months ago
JSON representation
COMPLexity ANalyzer Tool for Javascript projects
- Host: GitHub
- URL: https://github.com/pranavparikh/complan
- Owner: pranavparikh
- License: mit
- Created: 2016-09-30T21:59:44.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-23T23:31:03.000Z (almost 9 years ago)
- Last Synced: 2025-09-18T09:29:15.861Z (4 months ago)
- Topics: code
- Language: JavaScript
- Size: 17.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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
```
```
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 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]