Home
Cancel

Hours report

An Estimated time spent on a git repository report.

Please note that the information might not be accurate enough to be used in billing.

Usage

The best way to use it is to goto you project folder, and run:

1
$ npx hours-report

the console will output the location of a csv file that contains the report base on your git log.

Inspirations

Got the inspiration and many ideas from git-hours, git-time and more.

Support

Running with npx

  • Node.js 12
  • Node.js 14
  • Node.js 16
  • Node.js 18

The package is written in vanilla JS so no dependencies (only Typescript as dev dependency). This is so it can support version 12-18 of nodeJS.

Development

  • Node.js 19

To develop modify etc. use node 18 and above. All the test are written in node test runner that is available for this version, and the types dev-dependencies.

Installation

1
$ npm i hours-report

Unit testing

The unites testing is done with the new experimental NodeJs test runner.

1
$ npm test

E2e test

contains only one test (used for CI purposes and to check node versions compatibility)

1
$ npm run e2e