Merge pull request mozilla#346 from kumar303/commit-msg

chore: Added linting of changelog style commit messages

Author: kumar303

.conventional-changelog-lintrc

@@ -0,0 +1,10 @@
+{
+  "extends": ["angular"],
+  "rules": {
+    "body-tense": [0, "never"],
+    "subject-tense": [0, "never"],
+    "footer-tense": [0, "never"],
+    "subject-case": [0, "never"],
+    "subject-full-stop": [0, "never"]
+  }
+}

.travis.yml

@@ -5,7 +5,7 @@ node_js:
 - '4'
 before_install:
 - npm install -g npm
-script: COVERAGE=y npm test
+script: COVERAGE=y npm test && npm run lint-commit-msg
 after_script: npm run publish-coverage
 notifications:
   irc:

CONTRIBUTING.md

@@ -83,6 +83,13 @@ Examples:
 If you want to use scopes then it would look more like:
 `feat(dysfunctioner): Added --quiet option`.
 
+### Check for commit message lint
+
+You can test that your commit message is formatted in a way that will support
+our changelog generator like this:
+
+    npm run lint-commit-msg
+
 ## Squashing commits
 
 When fixing up a pull request based on code review comments,

Gruntfile.js

@@ -1,6 +1,7 @@
 /*eslint prefer-template: 0*/
 var path = require('path');
 var spawn = require('child_process').spawn;
+var semver = require('semver');
 
 module.exports = function(grunt) {
 
@@ -47,13 +48,40 @@ module.exports = function(grunt) {
   grunt.registerTask('lint', 'checks for syntax errors', function() {
     if (process.env.SKIP_LINT) {
       grunt.log.writeln('lint task skipped because of $SKIP_LINT');
+    } else if (semver.satisfies(process.version, '< 4.0.0')) {
+      // eslint now requires a new-ish Node.
+      grunt.log.writeln('task skipped because this version of Node is too old');
     } else {
       grunt.task.run([
         'newer:eslint',
       ]);
     }
   });
 
+  grunt.registerTask(
+    'lint-commit-msg', 'checks for commit message lint', function() {
+      var done = this.async();
+      if (semver.satisfies(process.version, '>= 4.0.0')) {
+
+        var proc = spawn('conventional-changelog-lint', ['--from', 'master']);
+        proc.stderr.on('data', function(data) {
+          grunt.log.write(data);
+        });
+        proc.stdout.on('data', function(data) {
+          grunt.log.write(data);
+        });
+        proc.on('close', function(code) {
+          var succeeded = code === 0;
+          done(succeeded);
+        });
+
+      } else {
+        grunt.log.writeln(
+          'task skipped because this version of Node is too old');
+        done(true);
+      }
+    });
+
   grunt.registerTask(
     'check-for-smoke',
     'checks to see if web-ext is completely broken', function() {

package.json

@@ -16,6 +16,7 @@
     "start": "node -e \"require('grunt').cli()\" null develop",
     "flow-check": "node -e \"require('grunt').cli()\" null flowbin:check",
     "lint": "node -e \"require('grunt').cli()\" null lint",
+    "lint-commit-msg": "node -e \"require('grunt').cli()\" null lint-commit-msg",
     "test": "node -e \"require('grunt').cli()\" null test",
     "publish-coverage": "node -e \"require('grunt').cli()\" null coveralls"
   },
@@ -70,6 +71,7 @@
     "babel-preset-es2015": "6.9.0",
     "babel-preset-stage-2": "6.11.0",
     "chai": "3.5.0",
+    "conventional-changelog-lint": "1.0.0",
     "copy-dir": "0.3.0",
     "coveralls": "2.11.9",
     "deepcopy": "0.6.3",
@@ -89,6 +91,7 @@
     "load-grunt-tasks": "3.5.0",
     "mocha": "2.5.3",
     "mocha-multi": "0.9.0",
+    "semver": "5.2.0",
     "shelljs": "0.7.0",
     "sinon": "1.17.4",
     "webpack": "1.13.1",