4.0.0 • Published 7 months ago

conventional-changelog-jshint v4.0.0

Weekly downloads
484,398
License
ISC
Repository
github
Last release
7 months ago

conventional-changelog-jshint

NPM version Node version Dependencies status Build status Coverage status

conventional-changelog jshint preset.

Issues with the convention itself should be reported on the JSHint issue tracker.

Install

# yarn
yarn add -D conventional-changelog-jshint
# pnpm
pnpm add -D conventional-changelog-jshint
# npm
npm i -D conventional-changelog-jshint

JSHint Convention

Overview

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]] <Short description>
<Blank line>

<Body / Detailed description>

<Footer>

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.

Header

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
  2. [[FEAT]] --- Commit introduces new functionality
  3. [[DOCS]] --- Commit modifies documentation. Docs commits should only touch comments in source code, or scripts and assets which are used to generate the documentation.
  4. [[TEST]] --- Commit modifies tests or test infrastructure only
  5. [[CHORE]] --- Commit affects dev-ops, CI, or package dependencies

Body

<Body> 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

Footer

<Footer> contains a description of any breaking changes, no matter how subtle, as well as a list of issues affected or fixed by this commit. Lines in the footer should be wrapped to 100 characters for best rendering.

For instance:

[[FEAT]] Enable `norecurs` option by default

Commit 124124a7f introduced an option which forbids recursion. We liked it so much, we've enabled
it by default.

BREAKING CHANGE:

This change will break the CI builds of many applications and frameworks.

In order to work around this issue, you will need to re-engineer your applications and frameworks
to avoid making recursive calls. Use Arrays as stacks rather than relying on the VM call stack.

Fixes #1000009
Closes #888888
Closes #77777

Based on https://github.com/jshint/jshint/blob/master/CONTRIBUTING.md#commit-message-guidelines

easy-select-rnreact-native-bluetooth2killi8n-react-native-fast-imageairscanairscan-examplereact-native-esc-pos-sahaab@borisovart/atol-kkt-moduledeneme323112@ntt_app/react-native-custom-notificationreact-native-covid-sdk@jttechnic/interpreterreact-native-printer-brothersreact-native-shekhar-bridge-test@oiti/documentoscopy-react-nativequoc-test@infinitebrahmanuniverse/nolb-convluminos-ui-core@everything-registry/sub-chunk-1377jawwy-sdkjawwy_gamification_releasemock-changelogreact-native-sphereuisphereuijawwy_libraryreact-native-credit-card-pkgreact-native-jawwy_sample@amirdiafi/react-native-ios-haptics@amiruldev/wajs@ali5049/react-native-buttons@azalpacir/react-native-dhp-printer@aysea/react-native-ui-library@con-test/react-native-concent-common@cs6/react-native-test-native-view-library@damruravihara/react-native-testing-package@boundless-inc/mobiledoc-dom-renderer@blusalt-sdk/react-native-blusalt-document-verification@brantalikp/rn-resizejawwy_library_newjawy_library_v1gamification-jawwy-libraryframework_test_library_sixdee_new_jawwyreac-native-arun-ramya-testreact-native-app-bubblereact-native-app-integrity-checksumreact-native-azure-communication-servicesreact-native-basic-appreact-native-basic-screenreact-native-biometric-authenticatereact-native-auth-service-clientreact-native-aventonfacetec-aventonreact-native-badge-controlreact-native-awesome-android-123react-native-awesome-android-123-zeotapreact-native-awesome-module-latestreact-native-awesome-module-tworeact-native-animate-textreact-native-android-video-player-viewreact-native-bleccs-componentsreact-native-dimensions-layoutreact-native-bubble-chartreact-native-bridge-packagereact-native-bluetooth-device-detectreact-native-contact-listreact-native-ctp-odpreact-native-fedlight-dsmreact-native-flyyreact-native-get-countriesreact-native-ghn-ekycreact-native-dhp-printerreact-native-dsphoto-modulereact-native-conekta-card-tokenizerreact-native-components-designreact-native-arps-authorize-netreact-native-arun-ramya-testreact-native-arunjeyam1987react-native-arunmeena1987react-native-arunramya151react-native-check-componentreact-native-chenaarreact-native-cplusreact-native-create-video-thumbnailreact-native-build-vesion-getterreact-native-additionreact-native-responsive-sizereact-native-rn-icons-libraryreact-native-rn-appreact-native-shared-gesturereact-native-syan-photo-pickerreact-native-onrampreact-native-rabbitmq-allreact-native-screen-idle-timerreact-native-rtn-ips-poslin-testreact-native-simple-timelinereact-native-sixdee_test_libreact-native-responsive-helperreact-native-sandycomponentreact-native-return-usb-datareact-native-savczuk-feature-libraryreact-native-sayhello-modulereact-native-sp-test-common
4.0.0

7 months ago

3.0.0

10 months ago

2.0.9

3 years ago

2.0.8

4 years ago

2.0.7

4 years ago

2.0.3

4 years ago

2.0.1

5 years ago

2.0.0

6 years ago

1.0.0

6 years ago

0.3.8

6 years ago

0.3.7

6 years ago

0.3.6

6 years ago

0.3.5

6 years ago

0.3.4

6 years ago

0.3.3

6 years ago

0.3.2

6 years ago

0.3.1

6 years ago

0.3.0

6 years ago

0.2.1

6 years ago

0.2.0

7 years ago

0.1.0

8 years ago

0.0.0

8 years ago