# @noedel/commit-stats

> Gather statistics about git commits

Latest version **0.0.3** (published 2019-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @noedel/commit-stats
pnpm add @noedel/commit-stats
yarn add @noedel/commit-stats
bun add @noedel/commit-stats
```

Provides the command `commit-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.3 |
| Published | 2019-03-20 |
| First published | 2019-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sam Noedel |
| Maintainers | delta62 |

## Links

- npm: https://www.npmjs.com/package/@noedel/commit-stats
- Repository: https://github.com/delta62/commit-stats
- npm.io page: https://npm.io/package/@noedel/commit-stats

## Dependencies (3)

- [rxjs](https://npm.io/package/rxjs.md) ^6.4.0
- [yargs](https://npm.io/package/yargs.md) ^13.2.2
- [@noedel/editcount](https://npm.io/package/@noedel/editcount.md) ^1.0.6

## Recent versions

- 0.0.3 (latest) — 2019-03-20

## README

Build: [![CircleCI](https://circleci.com/gh/delta62/commit-stats.svg?style=svg)](https://circleci.com/gh/delta62/commit-stats)

# commit-stats

This package exposes a command-line interface to your Git data. Give it a range
of commits and it will print each commit's metadata.

## Installation

`yarn global add @noedel/commit-stats`

or

`npm i -g @noedel/commit-stats`

## Usage

```
commit-stats --from <from-sha> --to <to-sha> [ options ]

Options:
  --version       Show version number                                  [boolean]
  --cwd           The directory to read commits from
                                         [default: "/home/sam/src/commit-stats"]
  --from          The commit after which commits should be considred
                                                             [string] [required]
  --to            The commit at which more commits should be ignored
                                                             [string] [required]
  --no-creations  Omit created files from the output                   [boolean]
  --no-deletions  Omit deleted files from the output                   [boolean]
  --no-renames    Omit renamed files from the output                   [boolean]
  --format        How output should be formatted
                                      [choices: "json", "csv"] [default: "json"]
  --iso           Format dates as ISO8601 instead of timestamps        [boolean]
  --help          Show help                                            [boolean]
```

You can currently choose between JSON and CSV output. If you want to pipe this
data into other node modules, try using the underlying library
[@noedel/editcount](https://github.com/delta62/editcount)

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