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

@vingle/commitlint-preset

v2.0.0

Published

commitlint rules for Vingle, Inc.

Downloads

1,804

Readme

Vingle commitlint preset

A common commitlint preset for TypeScript projects at Vingle.

IMPORTANT NOTE

This preset requires global npm dependency. Make sure commitizen is installed globally:

$ npm install commitizen -g

Local Setup

If you want to lint commit message via Git Hook to enforce commit message style in local dev environment, Follow these instructions.

In this setup, You'll need to install additional husky dependency.

$ npm install @vingle/commitlint-preset husky --save-dev

Add the following to package.json

{
  "config": {
    "commitizen": {
      "path": "cz-conventional-changelog"
    }
  },
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },
  "commitlint": {
    "extends": [
      "@vingle/commitlint-preset"
    ]
  }
}

Done. There is no any additional steps to check commit message. commitlint will be automatically executed every commits.

CI Setup

If you want to lint commit message via CI environment, Follow these instructions.

In this setup, husky is not required.

Add the following to package.json

{
  "config": {
    "commitizen": {
      "path": "cz-conventional-changelog"
    }
  },
  "commitlint": {
    "extends": [
      "@vingle/commitlint-preset"
    ]
  }
}

Done. Please follow below steps to execute commitlint.

Github Actions

Add following to workflow.yml

  steps:
    - name: CommitLint
      run: npx commitlint --from ${{ github.event.before || github.event.head || 'master' }} --verbose

Travis CI

Install additional dependency:

$ npm install @commitlint/travis-cli --save-dev

Add following to travis.yml

# travis.yml
language: node_js
script:
  - commitlint-travis

Other CI Environments

Execute following to check commit message:

$ npx run commitlint --from [COMMIT_SHA1] --to [COMMIT_SHA1]

Commit Helpers

cz-cli

cz-cli provides git extension to create semantic commits.

Simply use git cz instead of using git commit.