Conventional-changelog-jshint NPM | npm.io

5.0.0 • Published 1 year ago

Install

Weekly downloads

484,398

License

ISC

Repository

Last release

1 year ago

conventional-changelog-jshint

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:

[[FIX]] --- Commit fixes a bug or regression
[[FEAT]] --- Commit introduces new functionality
[[DOCS]] --- Commit modifies documentation. Docs commits should only touch comments in source code, or scripts and assets which are used to generate the documentation.
[[TEST]] --- Commit modifies tests or test infrastructure only
[[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

conventional-changelog jshint preset

easy-select-rn react-native-bluetooth2 killi8n-react-native-fast-image airscan airscan-example react-native-esc-pos-sahaab @borisovart/atol-kkt-module deneme323112 @ntt_app/react-native-custom-notification react-native-covid-sdk @jttechnic/interpreter react-native-printer-brothers react-native-shekhar-bridge-test @oiti/documentoscopy-react-native quoc-test @infinitebrahmanuniverse/nolb-conv luminos-ui-core @everything-registry/sub-chunk-1377 jawwy-sdk jawwy_gamification_release mock-changelog react-native-sphereui sphereui jawwy_library react-native-credit-card-pkg react-native-jawwy_sample griffin-ui-library tailwind-vector-effect test-library-123 test-haptik-lib wifi_configuration_package test-zeo-collect vision-camera-plugin-face-detector vision-camera-plugin-scan-faces vision-camera-base64-resized vcloudcam-playkit-js-hls vantiq-react vue-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/localisationist jrennsoh88-react-native-scroll-indicator jesh-calculation jnf-accesscontrol-rnttl jordy-frijters-test-lib khaled-salem-custom-components lazy-bee-ui jawwy_library_new jawy_library_v1 gamification-jawwy-library framework_test_library_sixdee_new_jawwy test_lib_module_aar quickcapture_react_native rn-agora-ios-m react-native-omental-framework react-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-renderer yarn-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

1 year ago

2 years ago

2 years ago

5 years ago

5 years ago

5 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

9 years ago

10 years ago