git-conventional-commits - npm Package Compare versions

Comparing version 2.4.0 to 2.4.1

package.json

 {
   "name": "git-conventional-commits",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "description": "git conventional commits util",
@@ -27,4 +27,4 @@ "licence": "GPLv3",
     "lib/",
-    "git-conventional-commits.default.json"
+    "git-conventional-commits.default.yaml"
   ]
 }

README.md

@@ -16,3 +16,3 @@ # Git Conventional Commits [![Sparkline](https://stars.medv.io/qoomon/git-conventional-commits.svg)](https://stars.medv.io/qoomon/git-conventional-commits)
 * Create [config file](#config-file) `git-conventional-commits init`
-* Adjust config `git-conventional-commits.json` to your needs
+* Adjust config `git-conventional-commits.yaml` to your needs
 
@@ -22,3 +22,3 @@ #### Commands
 ```
-  init [options]                               creates a config file template `git-conventional-commits.json`
+  init [options]                               creates a config file template `git-conventional-commits.yaml`
   version [options]                            determine version from conventional commits
@@ -30,48 +30,39 @@ changelog [options]                          generate change log from conventional commits
 #### Config File
-Example `git-conventional-commits.json`
-```json
-{
-  "convention" : {
-    "commitTypes": [
-      "feat",
-      "fix",
-      "perf",
-      "refactor",
-      "style",
-      "test",
-      "build",
-      "ops",
-      "docs",
-      "merge"
-    ],
-    "commitScopes": [],
-    "releaseTagGlobPattern":  "v[0-9]*.[0-9]*.[0-9]*"
-  },
+Example `git-conventional-commits.yaml`
+```yaml
+---
+convention:
+  commitTypes:
+  - feat
+  - fix
+  - perf
+  - refactor
+  - style
+  - test
+  - build
+  - ops
+  - docs
+  - merge
+  commitScopes: []
+  releaseTagGlobPattern: v[0-9]*.[0-9]*.[0-9]*
+changelog:
+  commitTypes:
+  - feat
+  - fix
+  - perf
+  - merge
+  includeInvalidCommits: true
+  commitScopes: []
+  commitIgnoreRegexPattern: "^WIP "
+  headlines:
+    feat: Features
+    fix: Bug Fixes
+    perf: Performance Improvements
+    merge: Merges
+    breakingChange: BREAKING CHANGES
+  commitUrl: https://github.com/qoomon/git-conventional-commits/commit/%commit%
+  commitRangeUrl: https://github.com/qoomon/git-conventional-commits/compare/%from%...%to%?diff=split
+  issueRegexPattern: "#[0-9]+"
+  issueUrl: https://github.com/qoomon/git-conventional-commits/issues/%issue%
 
-  "changelog" : {
-    "commitTypes": [
-      "feat",
-      "fix",
-      "perf",
-      "merge"
-    ],
-    "includeInvalidCommits": true,
-    "commitScopes": [],
-    "commitIgnoreRegexPattern": "^WIP ",
-    "headlines": {
-      "feat": "Features",
-      "fix": "Bug Fixes",
-      "perf": "Performance Improvements",
-      "merge": "Merges",
-      "breakingChange": "BREAKING CHANGES"
-    },
-
-    "commitUrl": "https://github.com/ACCOUNT/REPOSITORY/commit/%commit%",
-    "commitRangeUrl": "https://github.com/ACCOUNT/REPOSITORY/compare/%from%...%to%?diff=split",
-    "issueRegexPattern": "#\\d+",
-    "issueUrl": "https://github.com/ACCOUNT/REPOSITORY/issues/%issue%"
-  }
-}
-
-
 ```
@@ -78,0 +69,0 @@ * `convention`

No alert changes

Improved metrics

Total package byte prevSize

74036

increased by0.99%

Number of package files

15

increased by7.14%

Worsened metrics

Number of lines in readme file

166

decreased by-5.14%

No dependency changes