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

@superkoders/commitlint-config

v2.0.3

Published

SUPERKODERS commitlint configuration

Downloads

3

Readme

@superkoders/commitlint-config

Our custom commitlint rules.

Instalation

1. Install the package

npm i -D @superkoders/commitlint-config

2. Add commitlint.config.js

This tells commitlint when to locate our rules. You can also override the rules here, if you have some exception on a given project.

module.exports = {
	extends: ["@superkoders/commitlint-config"],
};

3. Install husky - git hooks utility

npm i -D husky

4. Set up husky hook

Add to the package.json

{
	"husky": {
		"hooks": {
			"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
		}
	},
}

Commit Keywords

When commiting, we stick with conventional config settings. Permitted keywords are those:

  • feat: add or extend backwards compatible functionality. It bumps version by minor and reset patch number to 0.

  • fix: bugfixes, it bumps version by patch.

  • refactor: code changes, which don't fix anything nor adds new functionality

  • perf: performance related changes

  • tpl: update templates

  • revert: for reverting commits

  • ui: UI adjustments

  • style: code changes, which don't alter its function (eg. formatting)

  • content: Images, text edits and alike

  • docs: only documentation changes

  • test: add or edit tests

  • build: changes related to project build (eg. webpack)

  • ci: changes related to project integration (eg. CI)

  • config: Config and rules changes

  • chore: other changes, which don't alter source or test code (eg. release new version)

  • when introducing backwards incompatible API changes (which bumps version by MAJOR), indicate it with keyword BREAKING CHANGE written at the very beginning of commit body, ideally with additional information. Commit subject should be as usual - ketyword and explanation. Eg.

refactor: unify componentA and componentB, change input data

BREAKING CHANGE here can be another explanation and reasoning

Commit formatting rules

  • subject always starts with small letter
  • empty line between subject and body is mandatory

For more on commitlint visit official documentation.