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

@shibayu36/merged-pr-stat

v0.4.0

Published

A tool to create merged PullRequest statistics

Downloads

223

Readme

merged-pr-stat

This is a tool to creates merged PullRequest statistics. It is useful to measure the productivity and health of your team.

Installation

$ npm install -g shibayu36/merged-pr-stat

Usage

The following command aggregates PullRequests of microsoft/vscode and microsoft/TypesScript which merged between --start and --end. You can filter PullRequests by --query option. See also https://docs.github.com/en/github/searching-for-information-on-github/searching-issues-and-pull-requests if you want to know what you can specify for --query

$ GITHUB_TOKEN=... merged-pr-stat --start=2020-07-01T00:00:00 --end=2020-07-30T23:59:59 --query="repo:microsoft/vscode repo:microsoft/TypeScript"

output is

{
  "count": 258,
  "authorCount": 77,
  "additionsAverage": 107.89147286821705,
  "additionsMedian": 19,
  "deletionsAverage": 41.97286821705426,
  "deletionsMedian": 3,
  "leadTimeSecondsAverage": 578271,
  "leadTimeSecondsMedian": 58163,
  "timeToMergeSecondsAverage": 735697,
  "timeToMergeSecondsMedian": 82453,
  "timeToMergeFromFirstReviewSecondsAverage": 426871,
  "timeToMergeFromFirstReviewSecondsMedian": 15432
}
  • count: the number of merged PullRequests
  • authorCount: the number of author who creates PullRequests
  • additionsAverage: the average of number of added lines
  • additionsMedian: the median of number of added lines
  • deletionsAverage: the average of number of deleted lines
  • deletionsMedian: the median of number of deleted lines
  • leadTimeSecondsAverage: the average of seconds between a first commit date and a PullRequest merged date
  • leadTimeSecondsMedian: the median of seconds between a first commit date and a PullRequest merged date
  • timeToMergeSecondsAverage: the average of seconds between a PullRequest created and a PullRequest merged
  • timeToMergeSecondsMedian: the median of seconds between a PullRequest created and a PullRequest merged
  • timeToMergeFromFirstReviewSecondsAverage: the average of seconds between a first review and a PullRequest merged.
  • timeToMergeFromFirstReviewSecondsMedian: the median of seconds between a first review and a PullRequest merged.

If you want to know about leadTime and timeToMerge for details, See https://sourcelevel.io/blog/5-metrics-engineering-managers-can-extract-from-pull-requests

|------------- lead time -------------|
                |--- time to merge ---|
---------------------------------------
^               ^                     ^
first commit    create PullRequest    merge PullRequest

log command

If you want to get raw information about PullRequests, you can use log command.

$ GITHUB_TOKEN=... merged-pr-stat log --start=2020-07-01T00:00:00 --end=2020-07-30T23:59:59 --query="repo:microsoft/vscode repo:microsoft/TypeScript"

Use --format option if you need other formats (ex. csv).

GitHub Enterprise Support

In case you are using GitHub Enterprise, you can use by setting GITHUB_ENDPOINT=https://<HOST>/api/graphql.

For example

$ GITHUB_TOKEN=... GITHUB_ENDPOINT=https://<HOST>/api/graphql merged-pr-stat --start=2020-07-01T00:00:00 --end=2020-07-30T23:59:59 --query="repo:org/repository"