feat(rules): add support for optional scopes

Brett Uglow · Brett Uglow · commit 6efd13b50332 · 2016-12-17T21:18:16.000+11:00
E.g. `fix: allow scope to be optional` is now a valid message
diff --git a/lib/index.js b/lib/index.js
@@ -104,7 +104,7 @@ function validateMessage(firstLine, fullMsg) {
   }
 
   let type = match[1];
-  let scope = match[3];
+  let scope = match[3];     // This may be undefined, because scope is optional. e.g. 'feat: foo' is perfectly fine
   let subject = match[4];
   let allowedScopesForType = SCOPE_OVERRIDES[type] ? SCOPE_OVERRIDES[type] : [];
 
@@ -115,7 +115,7 @@ function validateMessage(firstLine, fullMsg) {
     return false;
   }
 
-  if (!SCOPES.length && !allowCustomScopes && allowedScopesForType.indexOf(scope) === -1) {
+  if (scope && !SCOPES.length && !allowCustomScopes && allowedScopesForType.indexOf(scope) === -1) {
     commitError(`No valid scopes defined! Check your package.json and cz-customisable rules file and define the "scopes" there (or set allowCustomScopes to true)`);
     return false;
   }
@@ -125,7 +125,7 @@ function validateMessage(firstLine, fullMsg) {
     return false;
   }
 
-  if (!allowCustomScopes && allowedScopesForType.indexOf(scope) === -1) {
+  if (scope && !allowCustomScopes && allowedScopesForType.indexOf(scope) === -1) {
     commitError(`"${scope}" is not allowed scope for a "${type}" commit!\nValid "${type}" scopes: ${allowedScopesForType.sort().join(', ')}`);
     return false;
   }
@@ -201,16 +201,16 @@ function appendIssueToCommit(lines, issue) {
 
 function processCLI(commitMsgFileName, cb) {
   let incorrectLogFileName = commitMsgFileName.replace('COMMIT_EDITMSG', 'logs/incorrect-commit-msgs');
-  let callback = cb || function() {};   // Used for testing
+  let callback = cb || (() => {});   // Used for testing
 
   appendBranchNameToCommitMessage = czConfig && czConfig.appendBranchNameToCommitMessage != undefined ? czConfig.appendBranchNameToCommitMessage : appendBranchNameToCommitMessage;
 
-  fs.readFile(commitMsgFileName, function(err, buffer) {
+  fs.readFile(commitMsgFileName, (err, buffer) => {
     let lines = getLinesFromBuffer(buffer);
     let msg = lines.join('\n');
 
     if (!validateMessage(lines[0], msg)) {
-      fs.appendFile(incorrectLogFileName, msg + '\n', function() {
+      fs.appendFile(incorrectLogFileName, msg + '\n', () => {
         process.exit(1);
         callback();
       });
@@ -223,10 +223,10 @@ function processCLI(commitMsgFileName, cb) {
         callback();
       } else {
         // If valid, add the issue/branch name to the last line
-        exec('git rev-parse --abbrev-ref HEAD', function(err, stdout/* , stderr*/) {
+        exec('git rev-parse --abbrev-ref HEAD', (err, stdout/* , stderr*/) => {
           let lastline = appendIssueToCommit(lines, getIssueFromBranch(stdout));
 
-          fs.appendFile(commitMsgFileName, lastline, function() {
+          fs.appendFile(commitMsgFileName, lastline, () => {
             process.exit(0);
             callback();
           });
diff --git a/test/ccg.spec.js b/test/ccg.spec.js
@@ -60,6 +60,8 @@ describe('cz-customizable-ghooks', () => {
         {msg: 'docs(ccc): breaking change allowed\n\nBREAKING CHANGE: blah', expectedResult: false},
         {msg: 'fix(ccc): breaking change allowed\n\nBREAKING CHANGE: blah', expectedResult: true},
         {msg: 'feat(ccc): breaking change allowed\n\nBREAKING CHANGE: blah', expectedResult: true},
+        {msg: 'docs: type with no scope is valid', expectedResult: true},
+        {msg: 'fix(): but blank scopes are invalid', expectedResult: false},
         {msg: 'docs(dddd): but this is ok', expectedResult: true},
         {msg: 'feat(customScope): this ok', expectedResult: true},
       ];
@@ -119,6 +121,8 @@ describe('cz-customizable-ghooks', () => {
         {msg: 'feat(customScope): this not ok', expectedResult: false},
         {msg: 'docs(custom): docs has an override scope', expectedResult: true},
         {msg: 'fix(merge): and so does fix', expectedResult: true},
+        {msg: 'fix: and so does fix with no scope', expectedResult: true},
+        {msg: 'fix(): but blank scopes are invalid', expectedResult: false},
         {msg: 'docs(invalidCustom): not a valid custom scope', expectedResult: false},
       ];
 
@@ -152,7 +156,6 @@ describe('cz-customizable-ghooks', () => {
           {value: 'fix', name: 'fix:      A bug fix'},
           {value: 'docs', name: 'docs:     Documentation only changes'},
         ],
-
         scopeOverrides: {
           fix: baseScopes,
           docs: baseScopes.concat({name: 'custom'}),
@@ -169,6 +172,8 @@ describe('cz-customizable-ghooks', () => {
         {msg: 'docs(custom): this has an override scope', expectedResult: true},
         {msg: 'feat(merge): no scopes for feature', expectedResult: false},
         {msg: 'docs(invalidCustom): not a valid custom scope', expectedResult: false},
+        {msg: 'docs(): but blank scopes are invalid', expectedResult: false},
+        {msg: 'docs: the scope is in fact optional', expectedResult: true},
       ];
 
       let consoleData = '';
@@ -451,6 +456,30 @@ describe('cz-customizable-ghooks', () => {
     });
 
 
+    it('should try to append to the incorrect-log-file when the commit message is invalid()', (done) => {
+      createCommitMessageFile('foo');
+
+      let fileNameThatIsAppended;
+      let fileDataThatIsAppended;
+
+      revert2 = module.__set__({
+        'validateMessage': () => false,
+        'fs.appendFile': (name, data, callback) => {
+          fileNameThatIsAppended = name;
+          fileDataThatIsAppended = data;
+          callback();
+        },
+      });
+
+      function cb() {
+        assert(fileNameThatIsAppended.indexOf('test/COMMIT_MSG') !== -1);
+        assert.equal(fileDataThatIsAppended, 'foo\n');
+        done();
+      }
+      module.processCLI(commitMsgFileName, cb);
+    });
+
+
     it('should display "Commit message is valid." when the commit message is valid', (done) => {
       createCommitMessageFile('feat(a): something');
 
