vile-escomplex
A Vile plugin for tracking the complexity of your JavaScript code (via escomplex).
Requirements
Installation
npm i -D vile vile-escomplex
Config
By default, cyclomatic
complexity is used, but you can
use the maintainability
index instead:
escomplex: config: use_maintainability_index: true
Options For escomplex
escomplex: config: options: logicalor: false noCoreSize: true
Ignoring Files
vile.ignore
is used as a base, but you can add onto it:
escomplex: ignore: - some/path/* - file - dir
Allowing Files
vile.allow
is used as a base, but you alternatively specify:
escomplex: allow: - dir
Vile Types Generated
Until per method support is available, vile.COMP
issues are
generated for each file only.
Versioning
This project uses Semver.
Licensing
This project is licensed under the MPL-2.0 license.
Any contributions made to this project are made under the current license.
Contributions
Current list of Contributors.
Any contributions are welcome and appreciated!
All you need to do is submit a Pull Request.
- Please consider tests and code quality before submitting.
- Please try to keep commits clean, atomic and well explained (for others).
Issues
Current issue tracker is on GitHub.
Even if you are uncomfortable with code, an issue or question is welcome.
Code Of Conduct
By participating in this project you agree to our Code of Conduct.
Maintainers
- Brent Lintner - @brentlintner
Developing
cd vile-escomplex
npm install
npm test
To run compile task with file watch in the background:
npm run dev
To run tests with coverage:
npm run test-cov
See npm run
for other available scripts.
Architecture
The node library written in basic JavaScript.
The test code is written in CoffeeScript.