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

@speedy/commit-msg-hook

v1.9.0

Published

GIT commit-msg validator hook

Downloads

16,582

Readme

@speedy/commit-msg-hook

CircleCI npm version dependencies Status devDependencies Status

A highly customizable git commit message hook. Validates a commit message against a set of configuration, based on the Conventional Changelog standards.

Commit first line format:

<type>(<scope>): <subject>

Installation

npm install @speedy/commit-msg-hook --save-dev

Rules

The majority of the rules can be applied in any part of the configuration.

| Name | Description | Type | Section | |--------------------|--------------------------------------------------------------------------------------------------------|----------|---------| | no-unscoped | Disallows unscoped commit messages | boolean | Message | | skip-validation | Disable validation for commit messages matching a RegExp. Useful for Merge and Revert commits) | RegExp | Message | | valid-types | An array of allowed commit message types ex: ["feat", "chore"] | string[] | Type | | valid-scopes | An array of allowed commit message scopes ex: ["router", "platform"] (Case sensitive) | string[] | Scope | | banned-phrases | An array of disallowed phrases. (Case insensitive) | string[] | All | | max-length | Requires text to be under a certain max length | number | All | | no-dash | Disallows dashes | boolean | All | | no-space | Disallows spaces | boolean | All | | no-underscore | Disallows underscores | boolean | All | | no-camel-case | Disallows camel cases | boolean | All | | no-kebab-case | Disallows kebab case | boolean | All | | no-upper-first | Enforces first character to be lower case | boolean | All | | no-lower-first | Enforces first character to be upper case | boolean | All | | no-period-at-end | Enforces last character not to be a period | boolean | All |

Configuration

By default, will try to locate the speedy-commit-msg.json file in the root of your project folder.

If the file is not found it will fallback to an internal speedy-commit-msg.json found in config folder.

Default rules

speedy-commit-msg.json.

{
  "rules": {
    "message": {
      "skip-validation": "^(Merge)\\s",
      "max-length": 100,
      "banned-phrases": [
        "minor change",
        "minor fix",
        "minor refactor",
        "pr change",
        "pr comment",
        "following pr"
      ],
      "no-period-at-end": true,
      "no-upper-first": true
    },
    "type": {
      "valid-types": [
        "feat",
        "fix",
        "docs",
        "style",
        "refactor",
        "perf",
        "test",
        "chore",
        "revert"
      ]
    },
    "scope": {
      "no-dash": true,
      "no-underscore": true
    },
    "subject": {
      "no-period-at-end": true,
      "no-upper-first": true
    }
  }
}

extends

Configuration can be extended with one or many existing configurations.

{
  "extends": [
    "@speedy/commit-msg-hook:latest"
  ],
  "rules": {
    "message": {
      "no-unscoped": true
    },
    "scope": {
      "no-dash": false
    }
  }
}