5.0.0 • Published 1 year ago

conventional-changelog-jshint v5.0.0

Weekly downloads
484,398
License
ISC
Repository
github
Last release
1 year ago

conventional-changelog-jshint

ESM-only package NPM version Node version Dependencies status Install size 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_samplegriffin-ui-librarytailwind-vector-effecttest-library-123test-haptik-libwifi_configuration_packagetest-zeo-collectvision-camera-plugin-face-detectorvision-camera-plugin-scan-facesvision-camera-base64-resizedvcloudcam-playkit-js-hlsvantiq-reactvue-dev-clone@dotconf-pro/dotconf-pro@dotconf-pro/dotenv@cs6/react-native-test-native-view-library@con-test/react-native-concent-common@damruravihara/react-native-testing-package@corelmax/react-native-my2c2p-sdk@praella/localisationistjrennsoh88-react-native-scroll-indicatorjesh-calculationjnf-accesscontrol-rnttljordy-frijters-test-libkhaled-salem-custom-componentslazy-bee-uijawwy_library_newjawy_library_v1gamification-jawwy-libraryframework_test_library_sixdee_new_jawwytest_lib_module_aarquickcapture_react_nativern-agora-ios-mreact-native-omental-frameworkreact-native-sixdee_test_lib@amiruldev/wajs@amirdiafi/react-native-ios-haptics@apardellass/react-native-audio-stream@aviinash_jha/react-native-test_multiply@ali5049/react-native-buttons@aysea/react-native-ui-library@brantalikp/rn-resize@cdk8s-extensions/argo-rollout@adatechnology/react-native-android-getnet-pos@adembacaj/react-native-google-pay@_nomtek/react-native-shimmer-animation@azalpacir/react-native-dhp-printer@boundless-inc/mobiledoc-dom-rendereryarn-react-hook-form@felipesimmi/react-native-datalogic-module@hawkingnetwork/react-native-tab-view@hbglobal/react-native-actions-shortcuts@idas1/ui-component-lib@geeky-apo/react-native-advanced-clipboard@labiebhn_/react-native-multiplier@lordbeanbag/vite-plugin-svg-icons-monorepo@latiwesh/conventional-changelog@lehuyaa/my-assets@marionebl/conventional-changelog@nader3456/zigbee2mqtt-frontend@navabi/react-native-ssl-pinning@enirisdev/angular-google-charts@enkeledi/react-native-week-month-date-picker@extrieve_technologies/quickcapture_react_native@ko-developerhong/react-native-multiple-image-picker@jscutlery/semver@jfilipe-sparta/react-native-module_2@hemith/react-native-tnk@oiti/rn-liveness2d@react-native-ui-design/button@saad27/react-native-bottom-tab-tour@ponchodien/react-native-printer-imin@npm_fluentco/adflow-react-native-sdk@phong95/react-native-multiple-image-picker@sephriot/react-native-persistable-uri
5.0.0

1 year ago

4.0.0

2 years ago

3.0.0

2 years ago

2.0.9

5 years ago

2.0.8

5 years ago

2.0.7

5 years ago

2.0.3

6 years ago

2.0.1

7 years ago

2.0.0

7 years ago

1.0.0

7 years ago

0.3.8

7 years ago

0.3.7

7 years ago

0.3.6

7 years ago

0.3.5

7 years ago

0.3.4

7 years ago

0.3.3

7 years ago

0.3.2

7 years ago

0.3.1

7 years ago

0.3.0

8 years ago

0.2.1

8 years ago

0.2.0

8 years ago

0.1.0

9 years ago

0.0.0

10 years ago