feat(engine.js): add jira step

add a new prompt step for jira id input

Author: DawChihLiou

README.md

@@ -1,9 +1,13 @@
 # cz-conventional-changelog-with-jiraid-detection
 
-[![npm version](https://img.shields.io/npm/v/cz-conventional-changelog-with-jiraid-detection.svg?style=flat-square)](https://www.npmjs.org/package/cz-conventional-changelog-with-jiraid-detection)
-[![npm downloads](https://img.shields.io/npm/dm/cz-conventional-changelog-with-jiraid-detection.svg?style=flat-square)](http://npm-stat.com/charts.html?package=cz-conventional-changelog-with-jiraid-detection&from=2020-09-16)
+[![npm version](https://img.shields.io/npm/v/cz-conventional-changelog-with-jiraid-detection.svg?style=flat)](https://www.npmjs.org/package/cz-conventional-changelog-with-jiraid-detection)
+[![npm downloads](https://img.shields.io/npm/dm/cz-conventional-changelog-with-jiraid-detection.svg?style=flat)](http://npm-stat.com/charts.html?package=cz-conventional-changelog-with-jiraid-detection&from=2020-09-16)
 
-A fork of [cz-conventional-changelog-with-jiraid](https://github.com/commitizen/cz-conventional-changelog). Prompts for [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) standard with an extra step to insert Jira ID. Jira ID is auto-detected from your branch name by default.
+A fork of [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog).
+
+Prompts for [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) standard with an extra step to insert Jira ID. Jira ID is auto-detected from your branch name by default.
+
+Jira ID in the format of /^[A-Z]+-[0-9]+\$/ will be automatically detected from the current branch name and be displayed as default at the prompt step. The step is optional so you can skip it if you do not have a Jira ID.
 
 ## Configuration
 
@@ -44,13 +48,13 @@ Like commitizen, you specify the configuration of cz-conventional-changelog thro
 
 The following environment varibles can be used to override any default configuration or package.json based configuration.
 
-* CZ_TYPE = defaultType
-* CZ_SCOPE = defaultScope
-* CZ_SUBJECT = defaultSubject
-* CZ_BODY = defaultBody
-* CZ_MAX_HEADER_WIDTH = maxHeaderWidth
-* CZ_MAX_LINE_WIDTH = maxLineWidth
+- CZ_TYPE = defaultType
+- CZ_SCOPE = defaultScope
+- CZ_SUBJECT = defaultSubject
+- CZ_BODY = defaultBody
+- CZ_MAX_HEADER_WIDTH = maxHeaderWidth
+- CZ_MAX_LINE_WIDTH = maxLineWidth
 
 ### Commitlint
 
-If using the [commitlint](https://github.com/conventional-changelog/commitlint) js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 100.  This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.
+If using the [commitlint](https://github.com/conventional-changelog/commitlint) js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 100. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.

engine.js

@@ -4,6 +4,7 @@ var wrap = require('word-wrap');
 var map = require('lodash.map');
 var longest = require('longest');
 var chalk = require('chalk');
+var branch = require('git-branch');
 
 var filter = function(array) {
   return array.filter(function(x) {
@@ -23,7 +24,10 @@ var maxSummaryLength = function(options, answers) {
 
 var filterSubject = function(subject, disableSubjectLowerCase) {
   subject = subject.trim();
-  if (!disableSubjectLowerCase && subject.charAt(0).toLowerCase() !== subject.charAt(0)) {
+  if (
+    !disableSubjectLowerCase &&
+    subject.charAt(0).toLowerCase() !== subject.charAt(0)
+  ) {
     subject =
       subject.charAt(0).toLowerCase() + subject.slice(1, subject.length);
   }
@@ -47,6 +51,11 @@ module.exports = function(options) {
     };
   });
 
+  // detect jira id in branch name
+  var branchName = branch.sync() || '';
+  var jiraIdFound = branchName.match(/[A-Z]+-[0-9]+/) || [];
+  var defaultJiraId = jiraIdFound.shift();
+
   return {
     // When a user runs `git cz`, prompter will
     // be executed. We pass you cz, which currently
@@ -75,6 +84,22 @@ module.exports = function(options) {
           choices: choices,
           default: options.defaultType
         },
+        {
+          type: 'input',
+          name: 'jira',
+          message:
+            "JIRA ID (e.g. WEB-12345): (press enter to skip if you don't have one)",
+          default: defaultJiraId,
+          validate: function(jira) {
+            if (!jira) {
+              return true;
+            }
+            return /^[A-Z]+-[0-9]+$/.test(jira);
+          },
+          filter: function(jira) {
+            return jira ? jira.toUpperCase() : '';
+          }
+        },
         {
           type: 'input',
           name: 'scope',
@@ -99,7 +124,10 @@ module.exports = function(options) {
           },
           default: options.defaultSubject,
           validate: function(subject, answers) {
-            var filteredSubject = filterSubject(subject, options.disableSubjectLowerCase);
+            var filteredSubject = filterSubject(
+              subject,
+              options.disableSubjectLowerCase
+            );
             return filteredSubject.length == 0
               ? 'subject is required'
               : filteredSubject.length <= maxSummaryLength(options, answers)
@@ -111,7 +139,10 @@ module.exports = function(options) {
                 ' characters.';
           },
           transformer: function(subject, answers) {
-            var filteredSubject = filterSubject(subject, options.disableSubjectLowerCase);
+            var filteredSubject = filterSubject(
+              subject,
+              options.disableSubjectLowerCase
+            );
             var color =
               filteredSubject.length <= maxSummaryLength(options, answers)
                 ? chalk.green
@@ -202,6 +233,9 @@ module.exports = function(options) {
         // Hard limit this line in the validate
         var head = answers.type + scope + ': ' + answers.subject;
 
+        // jira id will be injected into body
+        var jiraid = answers.jira ? wrap(answers.jira, wrapOptions) : false;
+
         // Wrap these lines at options.maxLineWidth characters
         var body = answers.body ? wrap(answers.body, wrapOptions) : false;
 
@@ -214,7 +248,7 @@ module.exports = function(options) {
 
         var issues = answers.issues ? wrap(answers.issues, wrapOptions) : false;
 
-        commit(filter([head, body, breaking, issues]).join('\n\n'));
+        commit(filter([head, jiraid, body, breaking, issues]).join('\n\n'));
       });
     }
   };

engine.test.js

@@ -3,6 +3,7 @@ var chalk = require('chalk');
 var engine = require('./engine');
 var mock = require('mock-require');
 var semver = require('semver');
+var branch = require('git-branch');
 
 var types = require('conventional-commit-types').types;
 
@@ -46,8 +47,19 @@ var longIssuesSplit =
     .trim() +
   '\n' +
   longIssues.slice(defaultOptions.maxLineWidth * 2, longIssues.length).trim();
+var jira = 'AAA-11223';
 
 describe('commit message', function() {
+  it('should append jira id on top of commmit body', () => {
+    expect(
+      commitMessage({
+        type,
+        subject,
+        jira,
+        body
+      })
+    ).to.equal(`${type}: ${subject}\n\n${jira}\n\n${body}`);
+  });
   it('only header w/ out scope', function() {
     expect(
       commitMessage({
@@ -282,6 +294,12 @@ describe('validation', function() {
 });
 
 describe('defaults', function() {
+  it('Jira id default', () => {
+    const branchName = branch.sync() || '';
+    const jiraIdMatch = branchName.match(/[A-Z]+-[0-9]+/) || [];
+    const jiraId = jiraIdMatch.shift(); // stirng or undefined ;
+    expect(questionDefault('jira')).to.equal(jiraId);
+  });
   it('defaultType default', function() {
     expect(questionDefault('type')).to.be.undefined;
   });
@@ -373,6 +391,9 @@ describe('transformation', function() {
 });
 
 describe('filter', function() {
+  it('uppercase jira', () => {
+    expect(questionFilter('jira', 'web-12345')).to.equal('WEB-12345');
+  });
   it('lowercase scope', () =>
     expect(questionFilter('scope', 'HelloMatt')).to.equal('hellomatt'));
   it('lowerfirst subject trimmed and trailing dots striped', () =>