conventional-changelog-emojis - npm Package Compare versions

Comparing version 2.0.0 to 3.0.0

CHANGELOG.md

@@ -0,1 +1,15 @@
+# [3.0.0](https://github.com/sebald/conventional-changelog-emojis/compare/v2.0.0...v3.0.0) (2019-02-07)
+
+
+### Features
+
+- Add Jira support ([d9f259e](https://github.com/sebald/conventional-changelog-emojis/commit/d9f259e))
+
+
+### Tooling
+
+- No CI email on success ([b9397de](https://github.com/sebald/conventional-changelog-emojis/commit/b9397de))
+- Update prettier + jest ([79f3291](https://github.com/sebald/conventional-changelog-emojis/commit/79f3291))
+
+
 # [2.0.0](https://github.com/sebald/conventional-changelog-emojis/compare/v1.3.0...v2.0.0) (2019-01-28)
@@ -2,0 +16,0 @@

package.json

 {
   "name": "conventional-changelog-emojis",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "conventional-changelog preset with emojis",
   "license": "MIT",
   "repository": "sebald/conventional-changelog-emojis",
+  "bugs": {
+    "url": "http://jira.example.com/browse"
+  },
   "keywords": [
@@ -43,4 +46,4 @@ "conventional-changelog",
     "husky": "1.3.1",
-    "jest": "23.6.0",
-    "prettier": "1.16.1",
+    "jest": "24.1.0",
+    "prettier": "1.16.4",
     "pretty-quick": "1.10.0",
@@ -47,0 +50,0 @@ "shelljs": "0.8.3",

parser-opts.js

@@ -14,2 +14,3 @@ 'use strict';
   headerCorrespondence: [`type`, `subject`],
+  issuePrefixes: ['#', '[A-Z]{3}-'],
   noteKeywords: [`BREAKING CHANGE`, `BREAKING CHANGES`],
@@ -16,0 +17,0 @@ revertPattern: /^revert:\s([\s\S]*?)\s*This reverts commit (\w*)\./,

README.md

@@ -37,2 +37,20 @@ # conventional-changelog-emojis
 
+## Smart Commit Support
+
+This preset supporst mulitple smart commit formats.
+
+### GitHub, Gitlab, Bitbucket, ...
+
+If a smart commit references an issue with the `#` prefix (This is supported by `conventional-changelog` by default) they will be linked in the generated changelog.
+
+### Jira, ...
+
+If a smart commit references an issue with the `ABC-` prefix they will be linked in the generated changelog.
+
+### Different issue tracker URL
+
+If your issue tracker has a different URL than your repository (e.g. your using Bitbucket and track issues in Jira), you can specify this in your `package.json` via the `bugs.url` field.
+
+This preset supports [Jira Smart Commits](https://confluence.atlassian.com/bitbucket/use-smart-commits-298979931.html)
+
 ---
@@ -39,0 +57,0 @@

writer-opts.js

@@ -83,2 +83,20 @@ 'use strict';
 
+      // Use `package.json` -> `bugs.url` if available
+      const { bugs } = context.packageData;
+      const bugsUrl = bugs.url ? bugs.url.replace(/\/$/, '') : null;
+
+      // If available `<bugsUrl>/<pathname>` will be used in template.
+      commit.references = commit.references.map(ref => {
+        /**
+         * Git(Hub|Lab), Bitbucket, ... use #<number> to reference issues.
+         * But can not be part of URL.
+         */
+        const pathname = ref.raw.replace(/^#/, '');
+        return {
+          ...ref,
+          pathname,
+          bugsUrl,
+        };
+      });
+
       return commit;
@@ -85,0 +103,0 @@ },

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14549

increased by16.52%

Lines of code

165

increased by11.49%

Number of lines in readme file

69

increased by35.29%

No dependency changes