npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hours-report

v1.1.6

Published

hours report based on git repo

Downloads

92

Readme

Status badge npm version Licence

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 package is written in 100% Vanilla js without dependencies (Not including dev-dependencies), to be able to run on most versions of NodeJs. That is why it's recommended not to install it but to use it like this:

npx hour-report

Output

The output is default to output a csv file, like this:

report-example

The file could then be saved to Excel, Google Sheets etc.

Options

Usage: hours-report <options>

Options:
-e,   --email                        email address. Default: current git user email address
-mx,  --max-diff-for-session         maximum difference in minutes between commits counted to one session. Default: 120
-mn,  --min-session                  how many minutes the first commit of a session should add to total. Default: 30
-df,  --date-from                    Analyze data since certain date (git log format). default: always (with limit of 1000 rows)
-du,  --date-until                   Analyze data until certain date (git log format). default: now
-fr,  --format                       output format : 'csv' | 'console' | 'xlsx'. Default: 'xlsx'
-o,   --output                       output folder. Default: temp/hours-report
-p,   --path                         Git repository to analyze. Default: . (current folder)
-h,   --help                         prints help options

Examples:

 - Estimate your hours for current repo

     $  hours-report

 - Estimate hours in repository where developers commit more seldom: they might have 4h(240min) pause between commits

     $  hours-report  --max-diff-for-session=240

For more information see the docs.

Inspirations

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

Support

Running with npx

  • [x] Node.js 12
  • [x] Node.js 14
  • [x] Node.js 16
  • [x] Node.js 18
  • [x] Node.js 20

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

  • [x] 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

$ npm i hours-report

Unit testing

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

$ npm test

E2e test

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

$ npm run e2e

Fixes

  • version 1.1.6

fixed https://github.com/ChenPeleg/hours-report/issues/36