@mktcodelib/github-insights NPM

GitHub Insights

A collection of functions to aggregate and evaluate data from the GitHub GraphQL API. Results are stored in IndexedDB.

npm i @mktcodelib/github-insights

Storing data is done by a web worker. The package provides a worker file that needs to be copied to a location that is accessible by the browser. E.g.:

cp node_modules/@mktcodelib/github-insights/dist/worker.js public/github-insights-worker.js

If you want to use a different filename/path, you can pass it to the Scanner constructor.

const scanner = new Scanner({
  accessToken: "<access token>",
  workerPath: '/path/to/worker.js', // default: '/github-insights-worker.js'
});

Usage

This package uses @mktcodelib/graphql-fetch-all to fetch all data from a complex GraphQL query with multiple paginated fields. A single "scan" can lead to hundreds of requests due to GitHub's API limitations.

You can either use functions with the Direct-suffic, to get all data at once, or use the generator functions, to get preliminary results and information after every request.

Direct

The results of the direct functions are NOT stored in IndexedDB!

import { Scanner } from '@mktcodelib/github-insights';

const scanner = new Scanner({ viewerToken: "<access token>" });

const {
  forkCount,
  followersForkCount,
  stargazerCount,
  followersStargazerCount,
  followersFollowerCount,
  mergedPullRequestCount,
  mergedPullRequestCount30d,
  mergedPullRequestCount365d,
} = await scanner.scanUserDirect('mktcode');

Generators

import { Scanner } from '@mktcodelib/github-insights';

const scanner = new Scanner({ viewerToken: "<access token>" });

scanner.scanUser('mktcode')((request) => {
  const {
    forkCount,
    followersForkCount,
    stargazerCount,
    followersStargazerCount,
    followersFollowerCount,
    mergedPullRequestCount,
    mergedPullRequestCount30d,
    mergedPullRequestCount365d,
  } = request.result;
})

Result will be complete after the last iteration Prelimanary and final results are stored in IndexedDB