@noedel/commit-stats

Gather statistics about git commits

Usage no npm install needed!

<script type="module">
  import noedelCommitStats from 'https://cdn.skypack.dev/@noedel/commit-stats';
</script>

README

Build: CircleCI

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