Merge pull request #11 from Guria/issue-5

Issue 5

cz-config-EXAMPLE.js

@@ -31,6 +31,8 @@ module.exports = {
       {name: 'e2eTest'},
       {name: 'unitTest'}
     ]
-  }
+  },
+
+  allowBreakingChanges: ['feat', 'fix']
 
 };

index.js

@@ -6,7 +6,6 @@ var wrap = require('word-wrap');
 var SYMLINK_CONFIG_NAME = 'cz-config';
 var log = require('winston');
 
-
 /* istanbul ignore next */
 function readConfigFile() {
   // this function is replaced in test.
@@ -16,15 +15,14 @@ function readConfigFile() {
     // This file is a symlink to the real one usually placed in the root of your project.
     config = require('./' + SYMLINK_CONFIG_NAME);
   } catch (err) {
-    log.warn('You don\'t have a file "' + SYMLINK_CONFIG_NAME + '" in your porject root directory. We will use the default configuration file inside this directory: ' + __dirname);
+    log.warn('You don\'t have a file "' + SYMLINK_CONFIG_NAME + '" in your project root directory. We will use the default configuration file inside this directory: ' + __dirname);
     log.warn('You should go to your "node_modules/cz-customizable" and run "npm run postinstall" to fix it up. Please report on Github if this doenst work.');
 
     config = require('./cz-config-EXAMPLE');
   }
   return config;
 }
 
-
 function buildCommit(answers) {
   var maxLineWidth = 100;
 
@@ -52,12 +50,16 @@ function buildCommit(answers) {
   var body = wrap(answers.body, wrapOptions) || '';
   body = body.split('|').join('\n');
 
+  var breaking = wrap(answers.breaking, wrapOptions);
   var footer = wrap(answers.footer, wrapOptions);
 
   var result = head;
   if (body) {
     result += '\n\n' + body;
   }
+  if (breaking) {
+    result += '\n\n' + 'BREAKING CHANGE:\n' + breaking;
+  }
   if (footer) {
     result += '\n\n' + footer;
   }
@@ -69,7 +71,6 @@ var isNotWip = function(answers) {
   return answers.type.toLowerCase() !== 'wip';
 };
 
-
 module.exports = {
 
   prompter: function(cz, commit) {
@@ -85,7 +86,6 @@ module.exports = {
         message: '\nSelect the type of change that you\'re committing:',
         choices: config.types
       },
-
       {
         type: 'list',
         name: 'scope',
@@ -105,14 +105,28 @@ module.exports = {
         validate: function(value) {
           return !!value;
         }
-      }, {
+      },
+      {
         type: 'input',
         name: 'body',
         message: '\nProvide a LONGER description of the change (optional). Use "|" to break new line:\n'
-      }, {
+      },
+      {
+        type: 'input',
+        name: 'breaking',
+        message: '\nList any BREAKING CHANGES (optional):\n',
+        when: function(answers) {
+          if (config.allowBreakingChanges) {
+            return config.allowBreakingChanges.indexOf(answers.type.toLowerCase()) >= 0;
+          }
+
+          return true;
+        }
+      },
+      {
         type: 'input',
         name: 'footer',
-        message: '\nList any BREAKING CHANGES or ISSUES CLOSED by this change (optional):\n',
+        message: '\nList any ISSUES CLOSED by this change (optional):\n',
         when: isNotWip
       },
       {

package.json

@@ -26,6 +26,7 @@
   },
   "devDependencies": {
     "codecov.io": "0.1.6",
+    "commitizen": "^2.4.6",
     "cz-conventional-changelog": "1.1.4",
     "eslint": "1.9.0",
     "ghooks": "1.0.0",

spec/czCustomizableSpec.js

@@ -21,7 +21,8 @@ describe('cz-customizable', function() {
           scopes: [{name: 'myScope'}],
           scopeOverrides: {
             fix: [{name: 'fixOverride'}]
-          }
+          },
+          allowBreakingChanges: ['feat']
         };
       }
     });
@@ -62,14 +63,20 @@ describe('cz-customizable', function() {
     expect(getQuestion(4).type).toEqual('input');
 
     //question 5
-    expect(getQuestion(5).name).toEqual('footer');
+    expect(getQuestion(5).name).toEqual('breaking');
     expect(getQuestion(5).type).toEqual('input');
-    expect(getQuestion(5).when({type: 'fix'})).toEqual(true);
-    expect(getQuestion(5).when({type: 'WIP'})).toEqual(false);
+    expect(getQuestion(5).when({type: 'feat'})).toEqual(true);
+    expect(getQuestion(5).when({type: 'fix'})).toEqual(false);
 
-    //question 6, last one
-    expect(getQuestion(6).name).toEqual('confirmCommit');
-    expect(getQuestion(6).type).toEqual('confirm');
+    //question 6
+    expect(getQuestion(6).name).toEqual('footer');
+    expect(getQuestion(6).type).toEqual('input');
+    expect(getQuestion(6).when({type: 'fix'})).toEqual(true);
+    expect(getQuestion(6).when({type: 'WIP'})).toEqual(false);
+
+    //question 7, last one
+    expect(getQuestion(7).name).toEqual('confirmCommit');
+    expect(getQuestion(7).type).toEqual('confirm');
 
 
     var answers = {
@@ -78,10 +85,10 @@ describe('cz-customizable', function() {
       scope: 'myScope',
       subject: 'create a new cool feature'
     };
-    expect(getQuestion(6).message(answers)).toMatch('Are you sure you want to proceed with the commit above?');
+    expect(getQuestion(7).message(answers)).toMatch('Are you sure you want to proceed with the commit above?');
   });
 
-  it('should call not call commit() function if there is no final confirmation', function() {
+  it('should not call commit() function if there is no final confirmation', function() {
     module.prompter(cz, commit);
     var commitAnswers = cz.prompt.mostRecentCall.args[1];
     var res = commitAnswers({});
@@ -100,11 +107,12 @@ describe('cz-customizable', function() {
       scope: 'myScope',
       subject: 'create a new cool feature',
       body: '-line1|-line2',
+      breaking: 'breaking',
       footer: 'my footer'
     };
 
     commitAnswers(answers);
-    expect(commit).toHaveBeenCalledWith('feat(myScope): create a new cool feature\n\n-line1\n-line2\n\nmy footer');
+    expect(commit).toHaveBeenCalledWith('feat(myScope): create a new cool feature\n\n-line1\n-line2\n\nBREAKING CHANGE:\nbreaking\n\nmy footer');
   });
 
   it('should call commit() function with commit message with the minimal required fields', function() {
@@ -129,11 +137,11 @@ describe('cz-customizable', function() {
     var answers = {
       confirmCommit: true,
       type: 'WIP',
-      subject: 'this is my worl-in-progress'
+      subject: 'this is my work-in-progress'
     };
 
     commitAnswers(answers);
-    expect(commit).toHaveBeenCalledWith('WIP: this is my worl-in-progress');
+    expect(commit).toHaveBeenCalledWith('WIP: this is my work-in-progress');
   });
 
   it('should truncate first line if number of characters is higher than 200', function() {
@@ -169,8 +177,7 @@ describe('cz-customizable', function() {
   });
 
 
-
-  describe('optional fixOverride', function() {
+  describe('optional fixOverride and allowBreakingChanges', function() {
 
     beforeEach(function() {
       module.__set__({
@@ -207,13 +214,19 @@ describe('cz-customizable', function() {
       expect(getQuestion(2).when({type: 'WIP'})).toEqual(false);
       expect(getQuestion(2).when({type: 'wip'})).toEqual(false);
 
+      //question 5
+      expect(getQuestion(5).name).toEqual('breaking');
+      expect(getQuestion(5).when({type: 'feat'})).toEqual(true);
+      expect(getQuestion(5).when({type: 'fix'})).toEqual(true);
+      expect(getQuestion(5).when({type: 'FIX'})).toEqual(true);
+
       var answers = {
         confirmCommit: true,
         type: 'feat',
         scope: 'myScope',
         subject: 'create a new cool feature'
       };
-      expect(getQuestion(6).message(answers)).toMatch('Are you sure you want to proceed with the commit above?');
+      expect(getQuestion(7).message(answers)).toMatch('Are you sure you want to proceed with the commit above?');
     });
   });