# typhonjs-escomplex-module

> Provides module / individual file oriented AST processing for typhonjs-escomplex complexity reports.

Latest version **0.1.0** (published 2018-12-21) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install typhonjs-escomplex-module
pnpm add typhonjs-escomplex-module
yarn add typhonjs-escomplex-module
bun add typhonjs-escomplex-module
```

## 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.1.0 |
| Published | 2018-12-21 |
| First published | 2016-06-13 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 69.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Michael Leahy |
| Maintainers | typhonrt |
| Keywords | typhonjs, escomplex, module, complexity, simplicity, cyclomatic, halstead, maintainability, dependencies, static, analysis, metrics, es6, es7, es8, es9, es10 |

## Links

- npm: https://www.npmjs.com/package/typhonjs-escomplex-module
- Repository: https://github.com/typhonjs-node-escomplex/typhonjs-escomplex-module
- Issues: https://github.com/typhonjs-node-escomplex/typhonjs-escomplex-module/issues
- npm.io page: https://npm.io/package/typhonjs-escomplex-module

## Dependencies (5)

- [typhonjs-ast-walker](https://npm.io/package/typhonjs-ast-walker.md) ^0.2.0
- [typhonjs-plugin-manager](https://npm.io/package/typhonjs-plugin-manager.md) ^0.2.0
- [typhonjs-escomplex-commons](https://npm.io/package/typhonjs-escomplex-commons.md) ^0.1.0
- [escomplex-plugin-metrics-module](https://npm.io/package/escomplex-plugin-metrics-module.md) ^0.1.0
- [escomplex-plugin-syntax-babylon](https://npm.io/package/escomplex-plugin-syntax-babylon.md) ^0.1.0

## Recent versions

- 0.1.0 (latest) — 2018-12-21
- 0.0.12 — 2016-08-10
- 0.0.11 — 2016-08-09
- 0.0.10 — 2016-08-09
- 0.0.9 — 2016-08-03
- 0.0.7 — 2016-08-02
- 0.0.6 — 2016-07-25
- 0.0.5 — 2016-07-22
- 0.0.4 — 2016-07-06
- 0.0.3 — 2016-07-02
- 0.0.2 — 2016-06-30
- 0.0.1 — 2016-06-13

## README

![typhonjs-escomplex-module](https://i.imgur.com/xsQDVG1.png)

[![NPM](https://img.shields.io/npm/v/typhonjs-escomplex-module.svg?label=npm)](https://www.npmjs.com/package/typhonjs-escomplex-module)
[![Documentation](http://docs.typhonjs.io/typhonjs-node-escomplex/typhonjs-escomplex-module/badge.svg)](http://docs.typhonjs.io/typhonjs-node-escomplex/typhonjs-escomplex-module/)
[![Code Style](https://img.shields.io/badge/code%20style-allman-yellowgreen.svg?style=flat)](https://en.wikipedia.org/wiki/Indent_style#Allman_style)
[![License](https://img.shields.io/badge/license-MPLv2-yellowgreen.svg?style=flat)](https://github.com/typhonjs-node-escomplex/typhonjs-escomplex-module/blob/master/LICENSE)
[![Gitter](https://img.shields.io/gitter/room/typhonjs/TyphonJS.svg)](https://gitter.im/typhonjs/TyphonJS)

[![Build Status](https://travis-ci.org/typhonjs-node-escomplex/typhonjs-escomplex-module.svg?branch=master)](https://travis-ci.org/typhonjs-node-escomplex/typhonjs-escomplex-module)
[![Coverage](https://img.shields.io/codecov/c/github/typhonjs-node-escomplex/typhonjs-escomplex-module.svg)](https://codecov.io/github/typhonjs-node-escomplex/typhonjs-escomplex-module)
[![Dependency Status](https://david-dm.org/typhonjs-node-escomplex/typhonjs-escomplex-module/status.svg)](https://david-dm.org/typhonjs-node-escomplex/typhonjs-escomplex-module)

Provides module / individual file oriented AST processing for typhonjs-escomplex complexity reports. The following JS AST generators are supported / tested: [acorn](https://www.npmjs.com/package/acorn), [babel parser](https://www.npmjs.com/package/@babel/parser), [babylon](https://www.npmjs.com/package/babylon), [espree](https://www.npmjs.com/package/espree), [esprima](https://www.npmjs.com/package/esprima). Any compliant JS parser that supports Babylon or ESTree AST should work as well.

More information forthcoming. This NPM module can be installed as a dependency in `package.json` as follows:
```
"dependencies": {
  "typhonjs-escomplex-module": "^0.1.0"
}
```

An ES6 example follows:
```
import escomplexModule from 'typhonjs-escomplex-module';

const ast = <some parsed AST>;

const report = escomplexModule.analyze(ast);
```


A CJS example follows:
```
var escomplexModule = require('typhonjs-escomplex-module');

var ast = <some parsed AST>;

var report = escomplexModule.analyze(ast);
```

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