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

@jimdo/components-stats

v3.2.0

Published

Collect stats about ui components usage across the specified GitHub org

Downloads

69

Readme

@jimdo/components-stats

npm package Build Status Downloads Issues Commitizen Friendly

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);