JSHint preset for conventional-changelog.
npm install conventional-changelog-jshint[![ESM-only package][package]][package-url]
[![NPM version][npm]][npm-url]
[![Node version][node]][node-url]
[![Dependencies status][deps]][deps-url]
[![Install size][size]][size-url]
[![Build status][build]][build-url]
[![Coverage status][coverage]][coverage-url]
[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
[package-url]: https://nodejs.org/api/esm.html
[npm]: https://img.shields.io/npm/v/conventional-changelog-jshint.svg
[npm-url]: https://npmjs.com/package/conventional-changelog-jshint
[node]: https://img.shields.io/node/v/conventional-changelog-jshint.svg
[node-url]: https://nodejs.org
[deps]: https://img.shields.io/librariesio/release/npm/conventional-changelog-jshint
[deps-url]: https://libraries.io/npm/conventional-changelog-jshint/tree
[size]: https://packagephobia.com/badge?p=conventional-changelog-jshint
[size-url]: https://packagephobia.com/result?p=conventional-changelog-jshint
[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master
[build-url]: https://github.com/conventional-changelog/conventional-changelog/actions
[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master
conventional-changelog jshint preset.
Issues with the convention itself should be reported on the JSHint issue tracker.
``bash`yarn
yarn add -D conventional-changelog-jshintpnpm
pnpm add -D conventional-changelog-jshintnpm
npm i -D conventional-changelog-jshint
Commit messages are written in a simple format which clearly describes the purpose of a change.
The format in general should look like this:
`
[[TYPE]]
Line lengths in commit messages are not strict, but good commit messages should have headers of no
more than 60 characters, and bodies/footers wrapped at 100 columns. This renders nicely on Github's
UI.
The first line is the commit message header, which will indicate the type of change, and a general
description of the change. This should fit within 60 characters, ideally. For instance:
`
[[FIX]] Ignore "nocomma" when parsing object literals
The title [[FIX]] indicates that the change is a bugfix, while the remainder clarifies what the
change actually contains.
Several commit types are used by jshint:
1. [[FIX]] --- Commit fixes a bug or regression[[FEAT]]
2. --- Commit introduces new functionality[[DOCS]]
3. --- Commit modifies documentation. Docs commits should only touch comments in source code, or scripts and assets which are used to generate the documentation.[[TEST]]
4. --- Commit modifies tests or test infrastructure only[[CHORE]]
5. --- Commit affects dev-ops, CI, or package dependencies
is a detailed commit message explaining exactly what has changed, and a summary of the
reason why. Lines in the body should be wrapped to 100 characters for best rendering.For a historical example, see this example
$3