@captainsafia/dossier

1.0.1 • Public • Published

dossier

dossier is a command line utility that generates a report from any git repository that utilizes the Conventional Changelog Standard. Technically, this tool can be used on any commit message convention that denotes commit type with a prefix. Currently, dossier generates the following statistics:

  • Commit counts by prefix
  • Top contributor by prefix
  • Most frequent commit date by prefix

If you're interested in seeing more statistics reflected in dossier, you can submit an issue.

dossier aims to provide an output that can be easily piped and parsed by other utilities in your workflow.

Installation

npm install --global @captainsafia/dossier

Usage

  Usage: dossier [options]

  Options:

    -h, --help          output usage information
    -V, --version       output the version number
    -c, --commits <n>   Number of commits to analyze
    -p, --prefixes <l>  Conventional changelog prefixes used

Dossier Demo

Package Sidebar

Install

npm i @captainsafia/dossier

Weekly Downloads

1

Version

1.0.1

License

MIT

Last publish

Collaborators

  • captainsafia