Contribution-counters NPM

Contribution Counters

npm npm GitHub last commit (branch) npm bundle size NPM

Have you ever wanted to find out how many repos/projects you've contributed to and with how many commits? Well, now you can easily do so with this simple to use module!

This contribution counter is for 3 VCSs: GitHub, Bitbucket & GitLab and is achieved via each of their APIs and access tokens.

Instructions

Installing

To install locally: npm install contribution-counters --save
To install globally: npm install contribution-counters --global

Using module

Import the necessary counter like below:
const { getGitHubCounts } = require("contribution-counters");
Set up the configuration for the selected counter
The config is an object with the following properties (all available on all counters unless specified):
- username: Your username (string:required)
- accessToken: An access token for the user above (string:required)
- minCommits: The minimum number of commits a repo needs to count as a contribution (int:default=1)
- includeCommits: Whether to include count of your commits (bool:default=true)
- includeProjects: Whether to include count of repo/projects you've contributed to (bool:default=true)
- includePullRequests: Whether to include count of pull/merge request contributions (bool:default=false)
The below two are only used if a commit doesn't have a real user attached (At least one is required for Bitbucket & GitLab & both optional for GitHub BUT advised to use both for all)
- userEmailAddresses: Array of email addresses which may be associated with your commits (array)
- userNames: Array of name's which may be associated with your commits (array)
If you only want counts for after and/or before a particular date (inclusive) (or if you know the date you first and/or last contributed this can be used to minimise API requests)
- fromDate: Datetime string (ISO-8601 Date/timestamp (YYYY-MM-DDTHH:mm:ss.sssZ))
- untilDate: Datetime string (ISO-8601 Date/timestamp (YYYY-MM-DDTHH:mm:ss.sssZ))
To get repos of which you have a minimum access to
- minRepoAccessLevel: Only for GitLab (int:default=30)[10, 20, 30, 40, 50] (see here)
- minRepoRole: Only for Bitbucket (string:default=contributor)[admin, contributor, member, owner] (see here)
- minRepoRole: Only for GitHub (comma separated string:default=owner,collaborator,organization_member)[owner, collaborator, organization_member] (see here)
If you have a selfhosted GitLab, you will need to use url option
- url: The URL where your GitLab is located at (for example https://gitlab.jahidulpabelislam.com/ or https://jahidulpabelislam.com/gitlab/)

Start the counter with the following:

```javascript
const counts = await getGitHubCounts(config);
```

The returned result (counts) is an object with one or more properties (based on what you've requested):
- commits total number of your commits
- projects total number of projects you've contributed to
- pullRequests total number of pull/merge requests you've authored

getGitHubCounts in the above example can be replaced with getBitbucketCounts or getGitLabCounts.

Creating access tokens

Upgrading

v1 to v2

In version 2, the only breaking change is that only functions can be imported/required, instead of Counter classes.

To upgrade you will need to import/require the 3 new functions: getBitbucketCounts, getGitHubCounts & getGitLabCounts instead of Bitbucket, GitHub & GitLab. Where before you created an instance of a class (e.g. GitHub) and passed in an object of config, then called a function (getCounters) to get the counts. Now the new functions will do both in one. So just call the new function and pass in the existing config object as the only parameter and then your counts will be returned.