@commitlint/config-conventional - npm Package Compare versions

Comparing version 8.3.4 to 9.0.0

CHANGELOG.md

@@ -6,2 +6,24 @@ # Change Log
 
+# [9.0.0](https://github.com/conventional-changelog/commitlint/compare/v8.3.5...v9.0.0) (2020-05-21)
+
+
+### Bug Fixes
+
+* drop support for 'improvement' type ([#899](https://github.com/conventional-changelog/commitlint/issues/899)) ([b27ab08](https://github.com/conventional-changelog/commitlint/commit/b27ab08544373cfb72a4808756e2e8126ea96a97))
+
+
+### Features
+
+* **config-conventional:** footer/body-max-line ([#436](https://github.com/conventional-changelog/commitlint/issues/436)) ([8b394c9](https://github.com/conventional-changelog/commitlint/commit/8b394c94ffe37322d734bd4944add4a6cb2a4689))
+* **config-conventional:** increase header-max-length to 100 ([#860](https://github.com/conventional-changelog/commitlint/issues/860)) ([ff11998](https://github.com/conventional-changelog/commitlint/commit/ff11998e0cf6fcd4f03bc18ab27b1bdd6bf21906)), closes [#859](https://github.com/conventional-changelog/commitlint/issues/859)
+
+
+### BREAKING CHANGES
+
+* 'improvement' type will now be rejected by this config.
+
+
+
+
+
 ## [8.3.4](https://github.com/conventional-changelog/commitlint/compare/v8.3.3...v8.3.4) (2020-01-03)
@@ -8,0 +30,0 @@

index.js

@@ -5,4 +5,6 @@ module.exports = {
 		'body-leading-blank': [1, 'always'],
+		'body-max-line-length': [2, 'always', 100],
 		'footer-leading-blank': [1, 'always'],
-		'header-max-length': [2, 'always', 72],
+		'footer-max-line-length': [2, 'always', 100],
+		'header-max-length': [2, 'always', 100],
 		'scope-case': [2, 'always', 'lower-case'],
@@ -28,3 +30,2 @@ 'subject-case': [
 				'fix',
-				'improvement',
 				'perf',
@@ -31,0 +32,0 @@ 'refactor',

package.json

 {
   "name": "@commitlint/config-conventional",
-  "version": "8.3.4",
+  "version": "9.0.0",
   "description": "Shareable commitlint config enforcing conventional commits",
@@ -9,7 +9,4 @@ "files": [
   "scripts": {
-    "clean": "exit 0",
     "deps": "dep-check",
-    "pkg": "pkg-check",
-    "start": "exit 0",
-    "test": "exit 0"
+    "pkg": "pkg-check"
   },
@@ -21,3 +18,3 @@ "publishConfig": {
     "type": "git",
-    "url": "git+https://github.com/conventional-changelog/commitlint.git"
+    "url": "https://github.com/conventional-changelog/commitlint.git"
   },
@@ -36,9 +33,13 @@ "keywords": [
   "homepage": "https://github.com/conventional-changelog/commitlint#readme",
+  "engines": {
+    "node": ">=8"
+  },
   "devDependencies": {
-    "@commitlint/utils": "^8.3.4"
+    "@commitlint/lint": "^9.0.0",
+    "@commitlint/utils": "^9.0.0"
   },
   "dependencies": {
-    "conventional-changelog-conventionalcommits": "4.2.1"
+    "conventional-changelog-conventionalcommits": "4.2.3"
   },
-  "gitHead": "3fce33999e1e5f23b15545f1c6f3e7bd78e8d37b"
+  "gitHead": "71f0194f33943954a8dac1c458be47e5049717cd"
 }

README.md

@@ -8,6 +8,2 @@ > Lint your conventional commits
 
-| :warning: |  |
-|:-------:|--|
-| **IMPORTANT** | This is a direct replacement for [@commitlint/config-angular](https://npm.im/@commitlint/config-angular) prior to version 4. `config-angular` diverged from the conventional commit convention as of version 5. See [#146](https://github.com/conventional-changelog/commitlint/issues/146) for details.  |
-
 ## Getting started
@@ -21,2 +17,3 @@
 ## Rules
+
 ### Problems
@@ -28,9 +25,10 @@
 
-
 #### type-enum
-* **condition**: `type` is found in value
-* **rule**: `always`
-* **value**
 
-  ```js
+- **condition**: `type` is found in value
+- **rule**: `always`
+- **level**: `error`
+- **value**
+
+  ```
   [
@@ -48,3 +46,3 @@ 'build',
     'test'
-  ]
+  ];
   ```
@@ -58,8 +56,10 @@
 #### type-case
-* **description**: `type` is in case `value`
-* **rule**: `always`
-* **value**
-  ```js
-    'lowerCase'
+
+- **description**: `type` is in case `value`
+- **rule**: `always`
+- **level**: `error`
+- **value**
   ```
+  'lowerCase'
+  ```
 
@@ -72,5 +72,7 @@ ```sh
 #### type-empty
-* **condition**: `type` is empty
-* **rule**: `never`
 
+- **condition**: `type` is empty
+- **rule**: `never`
+- **level**: `error`
+
 ```sh
@@ -82,7 +84,10 @@ echo ": some message" # fails
 #### scope-case
-* **condition**: `scope` is in case `value`
-* **rule**: `always`
-```js
-  'lowerCase'
+
+- **condition**: `scope` is in case `value`
+- **rule**: `always`
+- **level**: `error`
+
 ```
+'lowerCase'
+```
 
@@ -95,5 +100,7 @@ ```sh
 #### subject-case
-* **condition**: `subject` is in one of the cases `['sentence-case', 'start-case', 'pascal-case', 'upper-case']`
-* **rule**: `never`
 
+- **condition**: `subject` is in one of the cases `['sentence-case', 'start-case', 'pascal-case', 'upper-case']`
+- **rule**: `never`
+- **level**: `error`
+
 ```sh
@@ -109,5 +116,7 @@ echo "fix(SCOPE): Some message" # fails
 #### subject-empty
-* **condition**: `subject` is empty
-* **rule**: `never`
 
+- **condition**: `subject` is empty
+- **rule**: `never`
+- **level**: `error`
+
 ```sh
@@ -119,8 +128,11 @@ echo "fix:" # fails
 #### subject-full-stop
-* **condition**: `subject` ends with `value`
-* **rule**: `never`
-* **value**
-```js
-  '.'
+
+- **condition**: `subject` ends with `value`
+- **rule**: `never`
+- **level**: `error`
+- **value**
+
 ```
+'.'
+```
 
@@ -132,10 +144,12 @@ ```sh
 
+#### header-max-length
 
-#### header-max-length
-* **condition**: `header` has `value` or less characters
-* **rule**: `always`
-* **value**
-```js
-  72
+- **condition**: `header` has `value` or less characters
+- **rule**: `always`
+- **level**: `error`
+- **value**
+
 ```
+100
+```
 
@@ -146,1 +160,87 @@ ```sh
 ```
+
+#### footer-leading-blank
+
+- **condition**: `footer` should have a leading blank line
+- **rule**: `always`
+- level: `warning`
+- **value**
+
+```
+100
+```
+
+```sh
+echo "fix: some message
+BREAKING CHANGE: It will be significant" # warning
+
+echo "fix: some message
+
+BREAKING CHANGE: It will be significant" # passes
+```
+
+#### footer-max-line-length
+
+- **condition**: `footer` each line has `value` or less characters
+- **rule**: `always`
+- level: `error`
+- **value**
+
+```
+100
+```
+
+```sh
+echo "fix: some message
+
+BREAKING CHANGE: footer with multiple lines
+has a message that is way too long and will break the line rule 'line-max-length' by several characters" # fails
+
+echo "fix: some message
+
+BREAKING CHANGE: footer with multiple lines
+but still no line is too long" # passes
+```
+
+#### body-leading-blank
+
+- **condition**: `body` should have a leading blank line
+- **rule**: `always`
+- level: `warning`
+- **value**
+
+```js
+100;
+```
+
+```sh
+echo "fix: some message
+body" # warning
+
+echo "fix: some message
+
+body" # passes
+```
+
+#### body-max-line-length
+
+- **condition**: `body` each line has `value` or less characters
+- **rule**: `always`
+- level: `error`
+- **value**
+
+```js
+100;
+```
+
+```sh
+echo "fix: some message
+
+body with multiple lines
+has a message that is way too long and will break the line rule 'line-max-length' by several characters" # fails
+
+echo "fix: some message
+
+body with multiple lines
+but still no line is too long" # passes
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13152

increased by21.68%

Lines of code

37

increased by2.78%

Number of lines in readme file

235

increased by74.07%

Worsened metrics

Dev dependency count

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedconventional-changelog-conventionalcommits@4.2.3(transitive)

• - Removedconventional-changelog-conventionalcommits@4.2.1(transitive)

• Updatedconventional-changelog-conventionalcommits@4.2.3