# njs-stats

> Gather NodeJS project statistics over time using git history.

Latest version **0.0.2** (published 2016-06-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install njs-stats
pnpm add njs-stats
yarn add njs-stats
bun add njs-stats
```

Provides the command `njs-stats`.

## 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.0.2 |
| Published | 2016-06-14 |
| First published | 2016-06-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Chris Driscol |
| Maintainers | cdriscol |

## Links

- npm: https://www.npmjs.com/package/njs-stats
- Repository: https://github.com/cdriscol/njs-stats
- Homepage: https://github.com/cdriscol/njs-stats#readme
- Issues: https://github.com/cdriscol/njs-stats/issues
- npm.io page: https://npm.io/package/njs-stats

## Dependencies (8)

- [glob](https://npm.io/package/glob.md) ^7.0.3
- [sloc](https://npm.io/package/sloc.md) ^0.1.10
- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [gitlog](https://npm.io/package/gitlog.md) ^2.1.2
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.0
- [json2csv](https://npm.io/package/json2csv.md) ^3.4.2
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [gitignore-to-glob](https://npm.io/package/gitignore-to-glob.md) ^0.2.1

## Recent versions

- 0.0.2 (latest) — 2016-06-14
- 0.0.1 — 2016-06-13

## README

njs-stats
=========
Gather NodeJS project statistics over time using git history.

Stats collected (per file) include:
* LOC data (comments, source, empty, etc)
* Count of requires
* Count of jasmine expects
* Count of expects

To-do:
* Count of exported functions/objects
* Ignore expects in xdescribe/xit's

##Using njs-stats
```bash
$ njs-stats --help
```

###With gitlog history
You can pass the `--gitlog` (`-g`) option which will walk backwards through your
git history up to 12 months and collect the same stats from the last commit made each month.

##Developing
Mostly taken from [here](https://developer.atlassian.com/blog/2015/11/scripting-with-node/#packaging-shell-commands).
###Install dependencies
```bash
$ npm install
```
###Install module globally
```bash
$ npm install -g
```
###Link module
```bash
$ npm link
```

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