@jimdo/components-stats

Collect usage statistics for any npm package exposing React UI components, across a GitHub organization. Inspired by Twilio.com blogpost.

Purpose

The aim is to provide better understanding of Design System or other shared UI libraries usage across the organization. This tool will facilitate things such as: deprecation of unused components and props, detection of misuse, set-up of alerts.

Compiling & Running Locally

Create a config.json file based on config.example.

A GitHub personal access token with scope repo is required, to access the org private repositories through GitHub APIs.

Usage for pkgName will be analyzed across org, excluding repositories that did not receive any commit in the last daysUntilStale days. Be patient, this will take some time.

The list of repositories having pkgName as dependency is collected through the package-adoption npm module.

Omit components to report all components.

Warning

The script will clone all the eligible repositories locally and use them as source for react-scanner. If a repository already exists locally, it will update it with a git pull.

# Install dependencies using npm
$ > npm i

# Start
$ > npm start

Results

The script outputs:

• a pkgAdoption.json file with the list of repositories that include pkgName as a dependency.

• two reports_by_repo folders with one scanner-report_[repo_name_subdir].json file for each repository. Each file is a report with the usage of React components exposed by the pkgName library. react-scanner is used to produce two kind of reports: one with the count-components-and-props processor and one with the raw-report processor, reporting all the props values.

Install

npm install @jimdo/components-stats

Usage

import { scanOrg } from '@jimdo/components-stats';

const config = {
  org: 'github_org_name',
  pkgName: '@org/package',
  ghAuthToken: 'github_auth_token',
  daysUntilStale: '730',
  components: { Accordion: true, Button: true },
};

await scanOrg(config);