feat(engine): add support for custom scopes option

README.md

@@ -37,13 +37,36 @@ Like commitizen, you specify the configuration of cz-conventional-changelog thro
                 "title": "Features"
               },
               ...
-            }
+            },
+            "scopes": {}
         }
     }
 // ...
 }
 ```
 
+#### Custom Scopes
+
+Following the example for custom types, you can build custom scopes in the package.json's `config.commitizen` key.
+
+```json5
+{
+  // ...
+  "config": {
+    "commitizen": {
+      "scopes": {
+        ...
+        "config": {
+          "description": "A configuration level change",
+          "title": "Configuration"
+        },
+        ...
+      }
+    }
+  }
+}
+```
+
 ### Environment variables
 
 The following environment variables can be used to override any default configuration or package.json based configuration.

engine.js

@@ -33,20 +33,21 @@ var filterSubject = function(subject, disableSubjectLowerCase) {
   return subject;
 };
 
+var mapToInquirerChoices = function (definitions) {
+  var maxLength = longest(Object.keys(definitions)).length + 1;
+  return map(definitions, function (definition, key) {
+    return {
+      name: (key + ':').padEnd(maxLength) + ' ' + definition.description,
+      value: key,
+    }
+  });
+};
+
 // This can be any kind of SystemJS compatible module.
 // We use Commonjs here, but ES6 or AMD would do just
 // fine.
 module.exports = function(options) {
-  var types = options.types;
-
-  var length = longest(Object.keys(types)).length + 1;
-  var choices = map(types, function(type, key) {
-    return {
-      name: (key + ':').padEnd(length) + ' ' + type.description,
-      value: key
-    };
-  });
-
+  var isUsingCustomScopes = options.scopes && Object.keys(options.scopes).length > 0;
   return {
     // When a user runs `git cz`, prompter will
     // be executed. We pass you cz, which currently
@@ -72,10 +73,16 @@ module.exports = function(options) {
           type: 'list',
           name: 'type',
           message: "Select the type of change that you're committing:",
-          choices: choices,
+          choices: mapToInquirerChoices(options.types),
           default: options.defaultType
         },
-        {
+        isUsingCustomScopes ? {
+          type: 'list',
+          name: 'scope',
+          message: "Select the scope of the change that you're committing:",
+          choices: mapToInquirerChoices(options.scopes),
+          default: options.defaultScope
+        } : {
           type: 'input',
           name: 'scope',
           message:

engine.test.js

@@ -355,6 +355,21 @@ describe('prompts', function() {
   });
 });
 
+describe('scope', function () {
+  it('commit scope prompts with input when scopes option is undefined', function () {
+    expect(getQuestion('scope', { types })).to.have.property('type', 'input');
+  });
+  it('commit scope prompts with list when scopes option is defined', function () {
+    var scopes = {
+      config: {
+        description: 'Configuration',
+        title: 'Configuration',
+      }
+    };
+    expect(getQuestion('scope', { types, scopes })).to.have.property('type', 'list');
+  });
+});
+
 describe('transformation', function() {
   it('subject w/ character count', () =>
     expect(

index.js

@@ -25,7 +25,8 @@ var options = {
     (process.env.CZ_MAX_LINE_WIDTH &&
       parseInt(process.env.CZ_MAX_LINE_WIDTH)) ||
     config.maxLineWidth ||
-    100
+    100,
+  scopes: config.scopes || {}
 };
 
 (function(options) {

package.json

@@ -44,7 +44,21 @@
   },
   "config": {
     "commitizen": {
-      "path": "./index.js"
+      "path": "./index.js",
+      "scopes": {
+        "deps": {
+          "description": "Depedency changes",
+          "title": "Dependencies"
+        },
+        "engine": {
+          "description": "Engine-level changes",
+          "title": "Engine"
+        },
+        "readme": {
+          "description": "README changes",
+          "title": "README"
+        }
+      }
     }
   }
 }