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

@episerver/commitlint-config

v1.1.1

Published

Shareable commitlint config enforcing the episerver commit convention

Downloads

16

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

johanpeterssonjohanpeterssonryanbareryanbarebarteksekulabarteksekulaalwaalwarobinjacrobinjac

Keywords

conventional-changelogcommitlintcommitlint-configepiserver

Readme

@episerver/commitlint-config

Shareable commitlint config enforcing the Episerver commit convention.

Installation

yarn

yarn add --dev @commitlint/cli @episerver/commitlint-config

npm

npm install --save-dev @commitlint/cli @episerver/commitlint-config

Usage

Configure commitlint to use the episerver configuration via a commitlint.config.js file or a commitlint field in package.json.

commitlint.config.js

module.exports = {
    extends: ['@episerver']
};

package.json

"commitlint": {
    "extends": ["@episerver"]
}

Commit Message Format

Commits should adhere to the following format:

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

<body>

<footer>

<references>

The following rules apply to the above format:

  1. A commit message consists of a header, body, footer, and references.
  2. The header is the only mandatory part of the commit message.
  3. The header must have a type and a subject; scope is optional.
  4. Scope should be surrounded by parenthesis; otherwise they are omitted.
  5. The type and scope should be lower case.
  6. The subject and body should be sentence case.
  7. The subject should not end with a dot.
  8. The header line is limited to 72 characters.
  9. Any other line should be wrapped at 100 characters.

Types

Must be one of the following:

| Type | Description | | --- | --- | | chore | Build process or auxiliary tool changes | | docs | Documentation only changes | | feat | A new feature | | fix | A bug fix | | refactor | A code change that neither fixes a bug or adds a feature | | release | Create a release commit | | revert | Revert a previous commit | | test | Add missing tests |

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Footer

The footer should only contain information about breaking changes and should use the following format:

BREAKING CHANGE: <description>

The description should be a concise explanation of the breaking change. The body can be omitted if the breaking change description and subject give enough information to understand the commit.