# @morione/git-report

> Generate xlsx file report with git history data - author, score, commits

Latest version **1.0.12** (published 2023-05-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @morione/git-report
pnpm add @morione/git-report
yarn add @morione/git-report
bun add @morione/git-report
```

Provides the command `git-report`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.12 |
| Published | 2023-05-21 |
| First published | 2023-05-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 12.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | kalman@morione.sk |
| Maintainers | morione |
| Keywords | git, contribution, xlsx score report, command tool, commit score, git history data, commit complexity |

## Links

- npm: https://www.npmjs.com/package/@morione/git-report
- Repository: https://gitlab.com/morione/git-report
- Homepage: https://gitlab.com/morione/git-report/#readme
- Issues: https://gitlab.com/morione/git-report/-/issues
- npm.io page: https://npm.io/package/@morione/git-report

## Dependencies (6)

- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [moment](https://npm.io/package/moment.md) ^2.29.4
- [whodid](https://npm.io/package/whodid.md) ^1.1.4
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.1.1
- [csvtojson](https://npm.io/package/csvtojson.md) ^2.0.10
- [xlsx-populate](https://npm.io/package/xlsx-populate.md) ^1.21.0

## Recent versions

- 1.0.12 (latest) — 2023-05-21
- 1.0.11 — 2023-05-17
- 1.0.10 — 2023-05-17
- 1.0.9 — 2023-05-17
- 1.0.8 — 2023-05-14
- 1.0.7 — 2023-05-14
- 1.0.6 — 2023-05-14
- 1.0.4 — 2023-05-14
- 1.0.3 — 2023-05-14
- 1.0.2 — 2023-05-14
- 1.0.1 — 2023-05-14
- 1.0.0 — 2023-05-14

## README

# git-report

The Command tool display the commit score from a specific local git repository. The score is calculated based on git history data (number of commits, number of files added and removed, commit complexity). Author scores, commits and other information are exported in **XLSX** format.
Exported data can be generated at intervals into separated sheets.

[![npm version](https://img.shields.io/npm/v/@morione/git-report)](https://www.npmjs.com/package/@morione/git-report)
[![MIT License](https://badges.frapsoft.com/os/mit/mit.svg?v=102)](https://github.com/ellerbrock/open-source-badge/)
[![Downloads](https://img.shields.io/npm/dm/@morione/git-report)](https://www.npmjs.com/package/@morione/git-report)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint.svg?type=shield)](https://app.fossa.com/projects/custom%2b37792%2fgitlab.com%2fmorione%2fgit-report/refs/branch/main/013f9fc3aed391578b7ad44e0954eab7189cc2b8)


## Install

```sh
npm install @morione/git-report
```


## Usage

**<i>Basic</i>** usage will generate **xlsx** document for defined local repository path.


```
npx @morione/git-report  [local path to repository]
```

**<i>Usage with all params</i>** will generate  **xlsx** document (named by defined name [reportFileName]) from the git history using a start date [since] and end date [until]. The generated data will be ranged by defined weeks [springDuration]. 


```
npx @morione/git-report [local path to repository] \
 --since 2023-01-04 --until 2023-05-12 \
 --sprintDuration 2 \
 --reportFileName "/tmp/eza-be.xlsx" \
 --sprintOffset=8
```

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