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

contrail-lib

v1.0.0

Published

![Contrail](https://images.robertharding.com/preview/RF/MI/HORIZONTAL/1174-3075.jpg)

Downloads

2

Readme

Contrail Library

Common functionality and libraries that are used throughout VibeIQ's services and apps.

Local Development

Local development is largely test-driven.

When changing functionality:

  1. Write tests that define the expected behavior
  2. Implement changes so tests pass
  3. Test your changes where the library is used (e.g. contrail-api)
    • If the changes is small:
      1. npm run build in the library your change is modifying
      2. Copy build files in lib into the node_modules of the project you want to use the new code
      3. Make sure the behavior has changed as expected
    • If the change is large and spans multiple libraries:
      1. Publish an alpha version of the library to NPM
      2. Install the alpha version where the change needs to be tested

Example - Copy changes from core library into the Users Service in the api

$ cp -r contrail-lib/core/lib/* \
        contrail-api/services/users/node_modules/@contrail/core/lib

Publish Change to NPM Library

  1. cd <library-to-publish>
  2. npm version [major | minor | patch | prerelease --preid=alpha]
    • Effect - Upgrade the version number of the library that you're currently in
  3. npm run build
  4. npm publish

Pre-commit Formatting Check

Every time you run git commit, a pre-commit hook will run to check if the code is formatted correctly. If it is not, the commit will fail. To fix this, run npm run lint-staged:format from the top-level directory and then try to commit again. This cannot be run within a service's directory those directories do no have lint-staged installed.

Bypass Formatting Check

This check can be bypassed by setting the BYPASS_FORMATTING_CHEKC to true. The best way to do this is to set that environment variable temporarily, only for the life cycle of the commit. This reduces the likelihood of accidentally committing unformatted code.

BYPASS_FORMATTING_CHECK=true git commit -m "commit message"