.gitignore

@@ -5,4 +5,5 @@
 .idea/
 node_modules/
 npm-debug.log
-yarn.lock
+yarn.lock
+.vscode/

.travis.yml

@@ -5,6 +5,8 @@ script:
   - npm run lint
 after_success:
   - npm run semantic-release
+  - npx ci-scripts slack
+  - npx ci-scripts github-post
 branches:
   except:
     - /^v\d+\.\d+\.\d+$/

README.md

@@ -6,19 +6,19 @@
 
 Install commitizen
 
-```
+```shell
 npm install -g commitizen
 ```
 
 Install the `mol-conventional-changelog` package.
 
-```
+```shell
 npm install --save-dev mol-conventional-changelog
 ```
 
 Init commitizen configuration
 
-```
+```shell
 commitizen init mol-conventional-changelog --save-dev --save-exact
 ```
 
@@ -28,25 +28,32 @@ commitizen init mol-conventional-changelog --save-dev --save-exact
 git cz
 ```
 
-#### Examples
+## Examples
 
 ```
-feat: add 'graphiteWidth' option
+feat: 🎸 add 'graphiteWidth' option
 ```
 
 ```
-fix: stop graphite breaking when width < 0.1
+fix: 🐞 stop graphite breaking when width < 0.1
 ```
 
 ```
-perf: remove graphiteWidth option
+perf: ⚡️ remove graphiteWidth option
 
 BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.
 
 Issues: MOL-1234
 ```
 
-### Commit Message Format
+
+## Custom config
+
+You can provide custom configuration in `changelog.congfig.js` file
+in your repo. See [default configuration file](./src/defaults.js) for reference.
+
+
+## Commit Message Format
 
 * A commit message consists of a **header**, **body** and **footer**.
 * The header has a **type** and a **subject**:
@@ -76,11 +83,12 @@ Must be one of the following:
 * `feat`: A new feature.
 * `fix`: A bug fix.
 * `docs`: Documentation only changes.
-* `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
+* `style`: Markup-only changes (white-space, formatting, missing semi-colons, etc).
 * `refactor`: A code change that neither fixes a bug or adds a feature.
 * `perf`: A code change that improves performance.
 * `test`: Adding or updating tests.
-* `chore`: Changes to the build process or auxiliary tools and libraries such as documentation generation and linters.
+* `chore`: Build process or auxiliary tool changes.
+* `ci`: CI related changes.
 
 ### Subject
 

package.json

@@ -19,8 +19,10 @@
   "dependencies": {
     "app-root-path": "^2.0.1",
     "inquirer": "^3.1.1",
-    "shelljs": "^0.7.8",
-    "word-wrap": "^1.2.3"
+    "shelljs": "^0.8.2",
+    "word-wrap": "^1.2.3",
+    "pad-right": "^0.2.2",
+    "signale": "^1.1.0"
   },
   "optionalDependencies": {
     "lerna": "^2.0.0-rc.5"
@@ -29,16 +31,28 @@
     "lerna": "^2.0.0-rc.5"
   },
   "devDependencies": {
-    "commitizen": "^2.9.5",
-    "eslint": "^3.19.0",
-    "eslint-config-mailonline": "^6.1.0",
-    "husky": "^0.13.4",
+    "commitizen": "^2.9.6",
+    "eslint": "^4.19.1",
+    "eslint-config-mailonline": "^9.0.0",
+    "husky": "^0.14.3",
     "lerna": "^2.0.0-rc.5",
     "semantic-release": "^6.3.6"
   },
   "config": {
     "commitizen": {
-      "path": "./index.js"
+      "path": "./index.js",
+      "changelog": {
+        "maxMessageLength": 72,
+        "list": [
+          "feat",
+          "fix",
+          "chore",
+          "docs",
+          "refactor",
+          "style",
+          "ci"
+        ]
+      }
     }
   }
 }

src/createPrompter.js

@@ -0,0 +1,83 @@
+const fs = require('fs');
+const inquirer = require('inquirer');
+const wrap = require('word-wrap');
+const appRoot = require('app-root-path');
+const {
+  createPackagesQuestion,
+  createQuestions
+} = require('./questions');
+const LimitedInput = require('./LimitedInput');
+const {
+  getAllPackages,
+  getChangedPackages
+} = require('./lernaUtils');
+
+const MAX_LINE_WIDTH = 72;
+
+inquirer.registerPrompt('limitedInput', LimitedInput);
+
+const IS_LERNA_PROJECT = fs.existsSync(appRoot.resolve('lerna.json'));
+
+const makeAffectsLine = function (answers) {
+  const selectedPackages = answers.packages;
+
+  if (selectedPackages && selectedPackages.length) {
+    return `\naffects: ${selectedPackages.join(', ')}`;
+  }
+
+  return '';
+};
+
+module.exports = (config) => {
+  const prompter = {
+    prompter (cz, commit) {
+      let promptQuestions = createQuestions(config);
+
+      if (IS_LERNA_PROJECT) {
+        const allPackages = getAllPackages().map((pkg) => pkg.name);
+        const changedPackages = getChangedPackages();
+
+        promptQuestions = promptQuestions.concat(createPackagesQuestion(allPackages, changedPackages));
+      }
+
+      return inquirer.prompt(promptQuestions)
+        .then((answers) => {
+          const wrapOptions = {
+            indent: '',
+            trim: true,
+            width: MAX_LINE_WIDTH
+          };
+
+          const emoji = config.types[answers.type].emoji;
+          const emojiPrefix = emoji ? emoji + ' ' : '';
+          const head = answers.type + ': ' + emojiPrefix + answers.subject;
+          const affectsLine = makeAffectsLine(answers);
+
+          // Wrap these lines at MAX_LINE_WIDTH character
+          const body = wrap(answers.body + affectsLine, wrapOptions);
+          const breaking = wrap(answers.breaking, wrapOptions);
+          const footer = wrap(answers.footer, wrapOptions);
+
+          let msg;
+
+          msg = head;
+
+          if (body) {
+            msg += '\n\n' + body;
+          }
+
+          if (breaking) {
+            msg += '\n\nBREAKING CHANGE: ' + breaking;
+          }
+
+          if (footer) {
+            msg += '\n\nIssues: ' + footer;
+          }
+
+          return commit(msg);
+        });
+    }
+  };
+
+  return prompter;
+};

src/defaults.js

@@ -0,0 +1,66 @@
+const types = {
+  chore: {
+    description: 'Build process or auxiliary tool changes',
+    emoji: '🚜',
+    value: 'chore'
+  },
+  ci: {
+    description: 'CI related changes',
+    emoji: '🎡',
+    value: 'ci'
+  },
+  docs: {
+    description: 'Documentation only changes',
+    emoji: '✏️',
+    value: 'docs'
+  },
+  feat: {
+    description: 'A new feature',
+    emoji: '🎸',
+    value: 'feat'
+  },
+  fix: {
+    description: 'A bug fix',
+    emoji: '🐜',
+    value: 'fix'
+  },
+  perf: {
+    description: 'A code change that improves performance',
+    emoji: '⚡️',
+    value: 'perf'
+  },
+  refactor: {
+    description: 'A code change that neither fixes a bug or adds a feature',
+    emoji: '💡',
+    value: 'refactor'
+  },
+  style: {
+    description: 'Markup-only changes (white-space, formatting, missing semi-colons, etc)',
+    emoji: '💄',
+    value: 'style'
+  },
+  test: {
+    description: 'Adding missing tests',
+    emoji: '💍',
+    value: 'test'
+  }
+};
+
+const list = [
+  'test',
+  'feat',
+  'fix',
+  'chore',
+  'docs',
+  'refactor',
+  'style',
+  'ci',
+  'perf'
+];
+
+module.exports = {
+  list,
+  maxMessageLength: 50,
+  minMessageLength: 3,
+  types
+};

src/getConfig.js

@@ -0,0 +1,49 @@
+/* eslint-disable global-require, import/no-dynamic-require */
+const path = require('path');
+const defaults = require('./defaults');
+const signale = require('signale');
+
+const configFiles = [
+  'changelog.config.js',
+  'changelog.config.json'
+];
+
+const findOverrides = () => {
+  const dir = process.cwd();
+
+  for (const file of configFiles) {
+    try {
+      return require(path.join(dir, file));
+    // eslint-disable-next-line no-empty
+    } catch (error) {}
+  }
+
+  try {
+    const changelog = require(path.join(dir, 'package.json')).config.commitizen.changelog;
+
+    if (changelog) {
+      return changelog;
+    }
+  // eslint-disable-next-line no-empty
+  } catch (error) {}
+
+  return {};
+};
+
+const getConfig = () => {
+  const overrides = findOverrides();
+
+  if (typeof overrides !== 'object') {
+    signale.fatal(new TypeError('Expected changelog config to be an object.'));
+
+    // eslint-disable-next-line no-process-exit
+    process.exit(1);
+  }
+
+  return {
+    ...defaults,
+    ...overrides
+  };
+};
+
+module.exports = getConfig;

src/index.js

@@ -1,77 +1,4 @@
-const fs = require('fs');
-const inquirer = require('inquirer');
-const wrap = require('word-wrap');
-const appRoot = require('app-root-path');
-const {
-  makePackagesQuestion,
-  questions
-} = require('./prompt/questions');
-const LimitedInput = require('./prompt/LimitedInput');
-const {
-  getAllPackages,
-  getChangedPackages
-} = require('./lernaUtils');
+const createPrompter = require('./createPrompter');
+const getConfig = require('./getConfig');
 
-const MAX_LINE_WIDTH = 72;
-
-inquirer.registerPrompt('limitedInput', LimitedInput);
-
-const IS_LERNA_PROJECT = fs.existsSync(appRoot.resolve('lerna.json'));
-
-const makeAffectsLine = function (answers) {
-  const selectedPackages = answers.packages;
-
-  if (selectedPackages && selectedPackages.length) {
-    return `\naffects: ${selectedPackages.join(', ')}`;
-  }
-
-  return '';
-};
-
-module.exports = {
-  prompter (cz, commit) {
-    let promptQuestions = questions;
-
-    if (IS_LERNA_PROJECT) {
-      const allPackages = getAllPackages().map((pkg) => pkg.name);
-      const changedPackages = getChangedPackages();
-
-      promptQuestions = promptQuestions.concat(makePackagesQuestion(allPackages, changedPackages));
-    }
-
-    return inquirer.prompt(promptQuestions)
-      .then((answers) => {
-        const wrapOptions = {
-          indent: '',
-          trim: true,
-          width: MAX_LINE_WIDTH
-        };
-
-        const head = answers.type + ': ' + answers.subject;
-        const affectsLine = makeAffectsLine(answers);
-
-        // Wrap these lines at MAX_LINE_WIDTH character
-        const body = wrap(answers.body + affectsLine, wrapOptions);
-        const breaking = wrap(answers.breaking, wrapOptions);
-        const footer = wrap(answers.footer, wrapOptions);
-
-        let msg;
-
-        msg = head;
-
-        if (body) {
-          msg += '\n\n' + body;
-        }
-
-        if (breaking) {
-          msg += '\n\nBREAKING CHANGE: ' + breaking;
-        }
-
-        if (footer) {
-          msg += '\n\nIssues: ' + footer;
-        }
-
-        return commit(msg);
-      });
-  }
-};
+module.exports = createPrompter(getConfig());

src/lernaUtils.js

@@ -1,3 +1,4 @@
+/* eslint-disable global-require */
 const path = require('path');
 
 const getAllPackages = function () {

src/questions.js

@@ -0,0 +1,68 @@
+const pad = require('pad-right');
+
+const typeToListItem = ({description, emoji, value}) => ({
+  name: (emoji || '❔') + '  ' + pad(value + ':', 12, ' ') + description,
+  value
+});
+
+const createQuestions = (config) => {
+  const MIN_SUBJECT_LENGTH_ERROR_MESSAGE = `The subject must have at least ${config.minMessageLength} characters`;
+  const questions = [
+    {
+      choices: config.list.map((type) => typeToListItem(config.types[type])),
+      message: 'Select the type of change that you\'re committing:',
+      name: 'type',
+      type: 'list'
+    },
+    {
+      filter: (input) => {
+        let subject;
+
+        subject = input.trim();
+        while (subject.endsWith('.')) {
+          subject = subject.substr(0, subject.length - 1).trim();
+        }
+
+        return subject;
+      },
+      leadingLabel: (answers) => `${answers.type}:`,
+
+      // Minus 3 chars are for emoji + space.
+      maxLength: config.maxMessageLength - 3,
+      message: 'Write a short, imperative mood description of the change:',
+      name: 'subject',
+      type: 'limitedInput',
+      validate: (input) => input.length >= config.minMessageLength || MIN_SUBJECT_LENGTH_ERROR_MESSAGE
+    },
+    {
+      message: 'Provide a longer description of the change:\n',
+      name: 'body',
+      type: 'input'
+    },
+    {
+      message: 'List any breaking changes:\n BREAKING CHANGE:',
+      name: 'breaking',
+      type: 'input'
+    },
+    {
+      message: 'Reference any task that this commit closes:\n Issues:',
+      name: 'footer',
+      type: 'input'
+    }
+  ];
+
+  return questions;
+};
+
+const createPackagesQuestion = (allPackages, changedPackages) => ({
+  choices: allPackages,
+  default: changedPackages,
+  message: `The packages that this commit has affected (${changedPackages.length} detected)\n`,
+  name: 'packages',
+  type: 'checkbox'
+});
+
+module.exports = {
+  createPackagesQuestion,
+  createQuestions
+};