JSPM

commitlint-with-husky

2.1.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q19686F
  • License MIT

No-Sweat™ commitlint and husky Setup

Package Exports

  • commitlint-with-husky
  • commitlint-with-husky/bin/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (commitlint-with-husky) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

No-Sweat™ Commitlint and Husky Setup

This is my attempt at setting up a project/repo with Commitlint and Husky as fast as possible.

What it does

  • Commitlint (you guessed it) lints your comments based on conventional commits' Standards
  • Husky uses githooks to lint the commits before they are actually executed (pre-commit hook)

You are very welcome to overwrite any of these settings, or just fork the entire thing to create your own.

Installing

  1. If you don't already have a package.json file, create one with npm init.

  2. Then ensure you have a .git folder create one with git init.

  3. In the root of your project execute the following command in your terminal:

npm i commitlint-with-husky --save-dev

Notice

I work on a windows machine, to the best of my knowledge the package works on all platforms, if not please don't hesitate to let me know.

Enjoy!

MIT