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

@bigcommerce/validate-commits

v2.3.4

Published

Validates commits based on a series of scopes/tasks

Downloads

8,047

Readme

@bigcommerce/validate-commits

This is a tool for validating commit messages - to ensure they have a consistent format and the required information.

Installation

npm install --save-dev @bigcommerce/validate-commits

Usage

Your commit message needs to have the following format:

task(scope): JIRA-1234 My commit message

You might also want to include a message body to provide additional information, for example, a breaking change.

task(scope): JIRA-1234 My commit message

BREAKING CHANGE: ABC has been renamed to XYZ.

Tasks

Below is a list of supported tasks:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Scopes

You need to add commit-validation.json to the root of your project in order to configure a list of supported scopes. i.e.:

{
    "scopes": [
        "payment",
        "checkout",
        "orders"
    ]
}

CLI

To run the validator in Terminal:

npx validate-commits

Requirements

  • Node: >=18

License

MIT