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

@romeovs/sevenrules

v1.4.11

Published

Git commit message validator

Downloads

189

Readme

sevenrules

Validates a git commit message against The seven rules:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 72 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

The bolded rules 1-6 are checked. The remaining rule 7 is not detectable programmatically.

Rule 5 (Imperative mood) is heuristically checked using a blacklist of terms, but might give false negatives in some cases. The blacklist is based on this git hook.

The title of rule 2 says 50 characters but the body clarifies 72 is the hard limit.

A husky hook is provided for ease of use.

Inspired by the quality Bash implementation.

Usage

Installation through husky

Install husky and sevenrules:

npm install husky @romeovs/sevenrules --save-dev
# or
yarn add husky @romeovs/sevenrules --dev

Hook the validator to commit-msg in your package.json:

{
  "husky": {
    "hooks": {
      "commit-msg": "sevenrules"
    }
  }
}

Enjoy your clean commit log!

Manual installation

npm install --global husky @romeovs/sevenrules
# or
yarn global add  husky @romeovs/sevenrules

In the git repository you want to use sevenrules, add it to your commit-msg hook manually:

echo 'sevenrules "$@"' >> .git/hooks/commit-msg
chmod u+x .git/hooks/commit-msg

Enjoy your clean commit log!

Example

$ git commit -m "Updated README.md"
Your commit message breaks one of the seven rules of commit messages

  Rule 5: Use the imperative mood in the subject line

For more info on the seven rules, see https://chris.beams.io/posts/git-commit
commit-msg hook failed (add --no-verify to bypass)

Conduct

Respect agency. Follow the Code of Conduct.

License

Anybody caught using this work without our permission, will be mighty good friends of ourn, cause we don't give a dern. Study it. Hack it. Publish it, even without naming the source. We made it, that's all we wanted to do.

Released under the Severn license, an MIT derivative without the notice requirement. Contributor signatures available in the contributors repository.

NO rights reserved.