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

gimbal-react

v1.0.3

Published

Create a React application to show the output from @modus/gimbal

Downloads

7

Readme

Gimbal React Output Plugin

CircleCI PRs Welcome MIT Licensed

Installation | Contributing | Code of Conduct | Twitter

A plugin that creates a React app to consume Gimbal's report.

gimbal-react example output

Installation

npm install --save-dev gimbal-react

Usage

In your project's Gimbal configuration file, specify this plugin:

YAML

plugins:
  - gimbal-react

JSON

{
  "plugins": ["gimbal-react"]
}

JavaScript

module.exports = {
  plugins: ['gimbal-react'],
};

Configuration

This plugin has a few configs that you can modify:

  • build Defaults to true to build the generated React application. This will run npm run build, if you'd like to specify a different command, instead of true, pass a string of the command: yarn build.
  • clean Defaults to true, set to false if you do not want to remove the out directory prior to generating the React application.
  • install Defaults to true to install the node dependencies in the generated React application. This will run npm install, if you'd like to specify a different command, instead of true, pass a string of the command: yarn.
  • logError Default to false, set to true to show the error logs during commands like the build and install commands.
  • out Defaults to './artifacts/report' which is relative to where Gimbal is running (or told to run).

To specify a configuration, instead of the usage above, return an object:

YAML Configuration

plugins:
  - plugin: gimbal-react
    build: yarn build
    install: yarn

JSON Configuration

{
  "plugins": [
    {
      "plugin": "gimbal-react",
      "build": "yarn build",
      "install": "yarn"
    }
  ]
}

JavaScript Configuration

module.exports = {
  plugins: [
    {
      plugin: 'gimbal-react',
      build: 'yarn build',
      install: 'yarn',
    },
  ],
};

Notes

Due to how npm and yarn install node dependencies, if it detects a dependency being installed is available in a parent directory, it won't install in the generated React application directory. This means you may need to change the out to be somewhere that will install all the dependencies.

Licensing

This project is MIT licensed.