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

@guidecx/config-branchlint

v0.0.1-alpha.0

Published

Branch linting script for use in GCX applications

Downloads

1

Readme

GCX Branchlint Script

Installing script into another project

The index.js file exports the branchlint node script. In another project, you can do the following to include these linting rules:

  1. at the root of the other project, install the package with npm install --save-dependency @guidecx/config-branchlint
  2. if you haven't installed husky and lint-staged, install them. according to the lint-staged docs, the easiest way to do this is by running npx mrm lint-staged.
  3. in your package.json file, include the following to your husky commands:
    "husky": {
      "hooks": {
        "pre-commit": "node ./node_modules/@guidecx/config-branchlint"
      }
    }
    • Alternatively, if the current app has a .husky/ folder that manages your scripts, add npm run branchlint into the bash file for pre-commit, and then create an npm script in your package.json like:
        "scripts": {
          "branchlint": "node ./node_modules/@guidecx/config-branchlint"
        }
  4. if everything was done correctly, making a git commit will now enforce our branch linting rules

Example branchlint patterns

When using this package, all branch names must match the following pattern:

currentUser/type/chStory/simple-description

where 'type' is an enum [chore, feat, fix, revert], chStory is a positive integer that matches a clubhouse story number prefaced with ch, and simple-description is a brief description of the changes made.

Based on the rules file, these are some of the patterns that are considered valid:

agarvin/feat/ch1823/add-unit-tests-to-view
iclaw/chore/ch891/disable-time-entry-page
jgomez/revert/ch2761/revert-disable-time-entry-page