# Node.js Package Analyzer (pkga)
[![Build Status](https://dev.azure.com/tmkndev/packageanalyzer/_apis/build/status/tmkn.packageanalyzer?branchName=master)](https://dev.azure.com/tmkndev/packageanalyzer/_build/latest?definitionId=1&branchName=master)
[![codecov](https://codecov.io/gh/tmkn/packageanalyzer/branch/master/graph/badge.svg)](https://codecov.io/gh/tmkn/packageanalyzer)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=tmkn_packageanalyzer&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=tmkn_packageanalyzer)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=tmkn_packageanalyzer&metric=sqale_index)](https://sonarcloud.io/dashboard?id=tmkn_packageanalyzer)
[![npm (scoped)](https://img.shields.io/npm/v/@tmkn/packageanalyzer)](https://www.npmjs.com/package/@tmkn/packageanalyzer)
[![npm](https://img.shields.io/npm/dw/@tmkn/packageanalyzer)](https://www.npmjs.com/package/@tmkn/packageanalyzer)

> A sample output of the `analyze` command
![App Banner](./banner.png)

A framework to introspect Node.js projects.

Stats are fun!

Please see the [Documentation](http://packageanalyzer-docs.vercel.app/) for a more in depth introduction.

## Install
```
yarn add @tmkn/packageanalyzer
```

## Usage
Please see the [CLI documentation](https://packageanalyzer-docs.vercel.app/docs/cli/) on usage.

## Develop
Please see [here](./DEVELOP.md) how to setup the dev environment

## Roadmap
* Stabilize API
* Better ux for missing cli/reports parameters
* Finding a better shorthand name
* Release v1 :)

## License
MIT