@commitlint/config-angular - npm Package Compare versions

Comparing version 4.3.0 to 5.0.0

index.js

@@ -0,1 +1,3 @@
+const typeEnum = require('@commitlint/config-angular-type-enum');
+
 module.exports = {
@@ -6,25 +8,14 @@ rules: {
 		'header-max-length': [2, 'always', 72],
-		'scope-case': [2, 'always', 'lowerCase'],
+		'scope-case': [2, 'always', 'lower-case'],
+		'subject-case': [
+			2,
+			'never',
+			['sentence-case', 'start-case', 'pascal-case', 'upper-case']
+		],
 		'subject-empty': [2, 'never'],
 		'subject-full-stop': [2, 'never', '.'],
-		'type-case': [2, 'always', 'lowerCase'],
+		'type-case': [2, 'always', 'lower-case'],
 		'type-empty': [2, 'never'],
-		'type-enum': [
-			2,
-			'always',
-			[
-				'build',
-				'chore',
-				'ci',
-				'docs',
-				'feat',
-				'fix',
-				'perf',
-				'refactor',
-				'revert',
-				'style',
-				'test'
-			]
-		]
+		'type-enum': typeEnum.rules['type-enum']
 	}
 };

package.json

 {
   "name": "@commitlint/config-angular",
-  "version": "4.3.0",
+  "version": "5.0.0",
   "description": "Shareable commitlint config enforcing the angular commit convention",
@@ -30,3 +30,6 @@ "scripts": {
     "@commitlint/utils": "^4.2.1"
+  },
+  "dependencies": {
+    "@commitlint/config-angular-type-enum": "^5.0.0"
   }
 }

README.md

@@ -30,3 +30,2 @@ > Lint your commits, angular-style
     'build',
-    'chore',
     'ci',
@@ -44,2 +43,7 @@ 'docs',
 
+```sh
+echo "foo: some message" # fails
+echo "fix: some message" # passes
+```
+
 #### type-case
@@ -53,2 +57,7 @@ * **description**: `type` is in case `value`
 
+```sh
+echo "FIX: some message" # fails
+echo "fix: some message" # passes
+```
+
 #### type-empty
@@ -58,2 +67,7 @@ * **condition**: `type` is empty
 
+```sh
+echo ": some message" # fails
+echo "fix: some message" # passes
+```
+
 #### scope-case
@@ -66,2 +80,20 @@ * **condition**: `scope` is in case `value`
 
+```sh
+echo "fix(SCOPE): some message" # fails
+echo "fix(scope): some message" # passes
+```
+
+#### subject-case
+* **condition**: `subject` is in one of the cases `['sentence-case', 'start-case', 'pascal-case', 'upper-case']`
+* **rule**: `never`
+
+```sh
+echo "fix(SCOPE): Some message" # fails
+echo "fix(SCOPE): Some Message" # fails
+echo "fix(SCOPE): SomeMessage" # fails
+echo "fix(SCOPE): SOMEMESSAGE" # fails
+echo "fix(scope): some message" # passes
+echo "fix(scope): some Message" # passes
+```
+
 #### subject-empty
@@ -71,2 +103,7 @@ * **condition**: `subject` is empty
 
+```sh
+echo "fix:" # fails
+echo "fix: some message" # passes
+```
+
 #### subject-full-stop
@@ -80,2 +117,8 @@ * **condition**: `subject` ends with `value`
 
+```sh
+echo "fix: some message." # fails
+echo "fix: some message" # passes
+```
+
+
 #### header-max-length
@@ -89,2 +132,7 @@ * **condition**: `header` has `value` or less characters
 
+```sh
+echo "fix: some message that is way too long and breaks the line max-length by several characters" # fails
+echo "fix: some message" # passes
+```
+
 ### Warnings
@@ -96,9 +144,1 @@ The following rules are considered warnings for `@commitlint/config-angular` and will print warning messages when not met.
 * **rule**: `always`
-
-#### lang
-* **condition**: `subject` is of language `value`
-* **rule**: `always`
-* **value**
-```js
-  eng
-```

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

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

5381

increased by23.11%

Number of lines in readme file

136

increased by41.67%

Worsened metrics

Dependency count

1

increased byInfinity%

Lines of code

19

decreased by-34.48%

Dependency changes

• + Added@commitlint/config-angular-type-enum@^5.0.0

• + Added@commitlint/config-angular-type-enum@5.1.1(transitive)