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

omni-common-ui

v0.39.0

Published

Project Omni's common UI components.

Downloads

137

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

e1-odine1-odin

Keywords

Readme

Omni Common UI

Branch | Build | Coverage ------ | --- | --- master | Build Status – master | Coverage Status Code Climate

Setting up the environment

Follow this steps to setup your development environment.

  1. Install NodeJS.
    It is highly recommended to use Node Version Manager (for Mac and Linux).
    A Windows version is also available.
  2. Install Yarn running npm install -g yarn.
  3. Open a terminal at the root folder of the project.
  4. Run yarn.

Committing

All commits should follow the patterns described by semantic-release.

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Or its simpler version <type>(<scope>): <subject>. For example, a fix commit could be:

fix(Avatar): Avoided a bug that happened on IE11.

Or adding a new feature:

feat(Avatar): Allowed passing in a default avatar to show if the user's avatar cannot be loaded.

Starting the development environment

When all your dependencies are installed, you can follow this steps to build the project on your machine for development.

  1. Open a terminal at the root folder of the project.
  2. Run yarn start.

Running our linting tools

  1. Run yarn lint:css to run Stylelint.
  2. Run yarn lint:js to run ESLint.

Testing during development

  1. Open a terminal at the root folder of the project.
  2. Run yarn test -- --watch or yarn test -- --watch --silent.
  3. The tests will run.
  4. The tests will run again automatically when you change the code.

Deploying

Make sure your commits follow the Committing section. And just push/merge to the master branch. The CI job will do the rest.

Frequent problems

yarn start is broken :(

If you meet some error when trying to run yarn start or yarn test, the most common cause is that someone has added or updated some new dependency into the project.

Run yarn to get your environment up to date.

Some tests keep failing unless I use --no-cache

If you have some tests that are always failing unless you use yarn test -- --no-cache, that means that the Jest cache is kind of broken. To fix this quickly:

  1. Run yarn test -- --showConfig
  2. Look for the value cacheDirectory
  3. Remove that directory manually