conventional-changelog 0.0.7 → 0.0.11

package/README.md

@@ -5,17 +5,23 @@ conventional-changelog
 $ npm install conventional-changelog
 ```
 
-Generate a changelog from git metadata, using [these commit conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).  
+Generate a changelog from git metadata, using the AngularJS commit conventions.
 
-View [CONVENTIONS.md](https://github.com/ajoslin/conventional-changelog/blob/master/CONVENTIONS.md) for a synposis of the conventions with commit examples.
+- [Synopsis of Conventions in CONVENTIONS.md](https://github.com/ajoslin/conventional-changelog/blob/master/CONVENTIONS.md)
+- [Full Convention Spec on Google Docs](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/)
 
-Adapted from code originally written by @vojtajina, from grunt-conventional-changelog.
+Adapted from code originally written by @vojtajina and @btford in [grunt-conventional-changelog](https://github.com/btford/grunt-conventional-changelog).
 
 ## Example output
+
 - https://github.com/ajoslin/conventional-changelog/blob/master/CHANGELOG.md
 - https://github.com/karma-runner/karma/blob/master/CHANGELOG.md
 
-Recommended usage: use in your workflow with [https://github.com/btford/grunt-conventional-changelog](grunt-conventional-changelog).
+## Roadmap
+
+- Make it return a stream
+- Add a proper command line interface
+- Add configurable subjects & sections
 
 ## Documentation
 
@@ -38,25 +44,34 @@ By default, calls the callback with a string containing a changelog from the pre
 
 `options` is the first parameter, an object.  The following fields are available:
 
+##### The Most Important Options
+
 * `version` `{string}` - The version to be written to the changelog. For example, `{version: require('./package.json').version}`
 
-* `codename` `{string}` - The codename to display after the version in the changelog. For example, it will show '## 1.0.0 "Super Version"' if codename 'Super Version' is given. By default, it's blank.
+* `subtitle` `{string}` - A string to display after the version title in the changelog. For example, it will show '## 1.0.0 "Super Version"' if codename '"Super Version"' is given. By default, it's blank.
 
 * `repository` `{string}` - If this is provided, allows issues and commit hashes to be linked to the actual commit.  Usually used with github repositories.  For example, `{repository: 'http://github.com/joyent/node'}`
 
-* `commitLink` `{function(commitHash)}` - If repository is provided, this function will be used to link to commits. By default, returns a github commit link based on options.repository: `opts.repository + '/commit/' + hash`
-
-* `issueLink` `{function(issueId)}` - If repository is provided, this function will be used to link to issues.  By default, returns a github issue link based on options.repository: `opts.repository + '/issues/' + id`
-
 * `from` `{string}` - Which commit the changelog should start at. By default, uses previous tag, or if no previous tag the first commit.
 
 * `to` `{string}` - Which commit the changelog should end at.  By default, uses HEAD.
 
-* `file` `{string}` - Which file to read the current changelog from and prepend the new changelog's contents to.  By default, uses `'CHANGELOG.md'`.
+* `file` `{string}` - Which file to read the current changelog from and prepend the new changelog's contents to.  By default, uses `'CHANGELOG.md'`
+
+##### The "I really want to get crazy" Options
+
+* `versionText` `{function(version, subtitle)}` - What to use for the title of a major version in the changelog. Defaults to `'## ' + version + ' ' + subtitle`.
+
+* `patchVersionText` `{function(version, subtitle)}` - What to use for the title of a patch version in the changelog. Defaults to `'### ' + version + ' ' + subtitle`.
+
+* `commitLink` `{function(commitHash)}` - If repository is provided, this function will be used to link to commits. By default, returns a github commit link based on options.repository: `opts.repository + '/commit/' + hash`
+
+* `issueLink` `{function(issueId)}` - If repository is provided, this function will be used to link to issues.  By default, returns a github issue link based on options.repository: `opts.repository + '/issues/' + id`
 
 * `log` `{function()}` - What logging function to use. For example, `{log: grunt.log.ok}`. By default, uses `console.log`.
 
 * `warn` `{function()}` - What warn function to use. For example, `{warn: grunt.log.writeln}`. By default, uses `console.warn`.
 
 ## License
+
 BSD

package/index.js

@@ -11,7 +11,7 @@ function generate(options, done) {
     version: null,
     to: 'HEAD',
     file: 'CHANGELOG.md',
-    codename: '',
+    subtitle: '',
     log: console.log.bind(console),
   }, options || {});
 

package/lib/git.js

@@ -49,7 +49,7 @@ function getCommits(options, done) {
     cmd, 
     options.grep,
     options.format, 
-    options.from ? options.from+'..'+options.to : ''
+    options.from ? '"' + options.from + '..' + options.to + '"' : ''
   );
 
   return es.child(cp.exec(cmd))
@@ -62,7 +62,7 @@ function getCommits(options, done) {
     .pipe(es.writeArray(done));
 }
 
-var COMMIT_PATTERN = /^(\w*)(\(([\w\$\.\-\*]*)\))?\: (.*)$/;
+var COMMIT_PATTERN = /^(\w*)(\(([\w\$\.\-\* ]*)\))?\: (.*)$/;
 var MAX_SUBJECT_LENGTH = 80;
 function parseRawCommit(raw, options) {
   if (!raw) {
@@ -77,24 +77,25 @@ function parseRawCommit(raw, options) {
   msg.closes = [];
   msg.breaks = [];
 
-  msg.subject = msg.subject.replace(/\s*(?:Closes|Fixes)\s#(\d+)/, function(_, i) {
+  msg.subject = msg.subject.replace(/\s*(?:Closes|Fixes|Resolves)\s#(\d+)/ig, function(_, i) {
     msg.closes.push(parseInt(i, 10));
     return '';
   });
 
   lines.forEach(function(line) {
-    match = line.match(/(?:Closes|Fixes)\s((?:#\d+(?:\,\s)?)+)/);
+    match = line.match(/(?:Closes|Fixes|Resolves)\s((?:#\d+(?:\,\s)?)+)/ig);
 
-    if (match) {
-      match[1].replace(/[\s#]/g, '').split(',').forEach(function(i) {
-        msg.closes.push(parseInt(i, 10));
+    match && match.forEach(function(m) {
+      m && m.split(',').forEach(function(i) {
+        var issue = i.match(/\d+/);
+        issue && msg.closes.push(parseInt(issue[0], 10));
       });
-    }
+    });
   });
 
   match = raw.match(/BREAKING CHANGE:\s([\s\S]*)/);
   if (match) {
-    msg.breaks.push(match[1]);
+    msg.breaks.push(match[1] + '\n');
   }
 
   msg.body = lines.join('\n');

package/lib/writer.js

@@ -2,6 +2,8 @@ var es = require('event-stream');
 var util = require('util');
 var extend = require('lodash.assign');
 
+var VERSION = '## %s%s';
+var PATCH_VERSION = '### %s%s';
 var LINK_ISSUE = '[#%s](%s/issues/%s)';
 var ISSUE = '(#%s)';
 var LINK_COMMIT = '[%s](%s/commit/%s)';
@@ -12,6 +14,14 @@ module.exports = {
   Writer: Writer
 };
 
+function getVersion (version, subtitle) {
+  subtitle = subtitle ? ' ' + subtitle : '';
+  return util.format(VERSION, version, subtitle);
+}
+function getPatchVersion (version, subtitle) {
+  subtitle = subtitle ? ' ' + subtitle : '';
+  return util.format(PATCH_VERSION, version, subtitle);
+}
 function getIssueLink(repository, issue) {
   return repository ?
     util.format(LINK_ISSUE, issue, repository, issue) :
@@ -25,10 +35,6 @@ function getCommitLink(repository, hash) {
 }
 
 function writeLog(commits, options, done) {
-  options = extend({
-    issueLink: getIssueLink.bind(null, options.repository),
-    commitLink: getCommitLink.bind(null, options.repository)
-  }, options || {});
   
   var log = '';
   var stream = es.through(function(data) {
@@ -71,15 +77,29 @@ function writeLog(commits, options, done) {
   writer.end();
 }
 
-var PATCH_HEADER_TPL = '<a name="%s"></a>\n### %s %s (%s)\n\n';
-var MINOR_HEADER_TPL = '<a name="%s"></a>\n## %s %s (%s)\n\n';
+var LINK_HEADER_TPL = '%s (%s)\n\n';
+var PLAIN_HEADER_TPL = '<a name="%s"></a>\n%s (%s)\n\n';
 var EMPTY_COMPONENT = '$$';
-function Writer(stream, options) {
 
+function Writer(stream, options) {
+  options = extend({
+    versionText: getVersion,
+    patchVersionText: getPatchVersion,
+    issueLink: getIssueLink.bind(null, options.repository),
+    commitLink: getCommitLink.bind(null, options.repository)
+  }, options || {});
+  
   this.header = function(version) {
-    var codename = options.codename ? '"' + options.codename + '"' : '';
-    var header = version.split('.')[2] === '0' ? MINOR_HEADER_TPL : PATCH_HEADER_TPL;
-    stream.write(util.format(header, version, version, codename, currentDate()));
+    var subtitle = options.subtitle || '';
+    var versionText = version.split('.')[2] === '0' ? 
+      options.versionText(version, subtitle) :
+      options.patchVersionText(version, subtitle);
+
+    if (options.repository) {
+      stream.write(util.format(LINK_HEADER_TPL, versionText, currentDate()));
+    } else {
+      stream.write(util.format(PLAIN_HEADER_TPL, version, versionText, currentDate()));
+    }
   };
 
   this.section = function(title, section) {
@@ -122,7 +142,7 @@ function Writer(stream, options) {
   this.end = function() {
     stream.end();
   };
-};
+}
 
 function currentDate() {
   var now = new Date();

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "conventional-changelog",
-  "codename": "delta",
-  "version": "0.0.7",
+  "codename": "reorder",
+  "version": "0.0.11",
   "description": "Generate a markdown changelog from git commit metadata",
   "main": "index.js",
   "scripts": {
-    "test": "mocha test/*.js index.js lib/*.js"
+    "test": "mocha test/*.js index.js lib/*.js --no-colors"
   },
   "files": [
     "index.js",
@@ -28,7 +28,7 @@
       "name": "Vojta Jína"
     },
     {
-      "name": "Andy Joslin"
+      "name": "Andrew Joslin"
     }
   ],
   "dependencies": {

package/test/git.spec.js

@@ -36,46 +36,72 @@ describe('git', function() {
         'bla bla bla\n\n' +
         'BREAKING CHANGE: some breaking change\n'
       );
-      expect(msg.breaks).to.deep.equal(['some breaking change\n']);
+      expect(msg.breaks).to.deep.equal(['some breaking change\n\n']);
     });
-    it('should parse Closes in the subject (and remove it)', function() {
-      var msg = git.parseRawCommit(
-        '13f31602f396bc269076ab4d389cfd8ca94b20ba\n' +
-        'feat(xxx): Whatever Closes #24\n' +
-        'bla bla bla\n\n' +
-        'What not ?\n'
-      );
-      expect(msg.closes).to.deep.equal([24]);
-      expect(msg.subject).to.equal('Whatever');
+    ['Closes', 'Fixes', 'Resolves'].forEach(function(closeWord) {
+      it('should parse ' + closeWord + ' in the subject (and remove it)', function() {
+        var msg = git.parseRawCommit(
+          '13f31602f396bc269076ab4d389cfd8ca94b20ba\n' +
+          'feat(xxx): Whatever ' + closeWord + ' #24\n' +
+          'bla bla bla\n\n' +
+          'What not ?\n'
+        );
+        expect(msg.closes).to.deep.equal([24]);
+        expect(msg.subject).to.equal('Whatever');
+      });
+      it('should work with lowercase ' + closeWord + ' in the subject', function() {
+        var msg = git.parseRawCommit(
+          '13f31602f396bc269076ab4d389cfd8ca94b20ba\n' +
+          'feat(xxx): Whatever ' + closeWord.toLowerCase() + ' #24\n' +
+          'bla bla bla\n\n' +
+          'What not ?\n'
+        );
+        expect(msg.closes).to.deep.equal([24]);
+        expect(msg.subject).to.equal('Whatever');
+      });
+      it('should parse multiple comma-separated issues closed with ' + closeWord + ' #1, #2', function() {
+        var msg = git.parseRawCommit(
+          '13f31602f396bc269076ab4d389cfd8ca94b20ba\n' +
+          'fix(yyy): Very cool commit\n' +
+          'bla bla bla\n\n' + 
+          closeWord + ' #1, #22, #33\n' +
+          'What not ?\n'
+        );
+        expect(msg.closes).to.deep.equal([1, 22, 33]);
+        expect(msg.subject).to.equal('Very cool commit');
+      });
     });
-    it('should parse Fixes in the subject (and remove it)', function() {
+    it('should parse multiple period-separated issues closed with all closed words', function() {
       var msg = git.parseRawCommit(
         '13f31602f396bc269076ab4d389cfd8ca94b20ba\n' +
-        'feat(xxx): Whatever Fixes #25\n' +
-        'bla bla bla\n\n' +
+        'fix(zzz): Very cool commit\n' +
+        'bla bla bla\n\n' + 
+        'Closes #2, #3. Resolves #4. Fixes #5. Fixes #6.\n' +
         'What not ?\n'
       );
-      expect(msg.closes).to.deep.equal([25]);
-      expect(msg.subject).to.equal('Whatever');
+      expect(msg.closes).to.deep.equal([2,3,4,5,6]);
+      expect(msg.subject).to.equal('Very cool commit');
     });
-    it('should parse multiple issues closed with Closes #1, #2', function() {
+    it('should parse a msg without scope', function() {
       var msg = git.parseRawCommit(
         '13f31602f396bc269076ab4d389cfd8ca94b20ba\n' +
-        'feat(xxx): Very cool commit\n' +
+        'chore: some chore\n' +
         'bla bla bla\n\n' + 
-        'Closes #1, #22, #33\n' +
-        'What not ?\n'
+        'BREAKING CHANGE: some breaking change\n'
       );
-      expect(msg.closes).to.deep.equal([1, 22, 33]);
+      expect(msg.type).to.equal('chore');
+      expect(msg.subject).to.equal('some chore');
     });
-    it('should parse a msg without scope', function() {
+    it('should parse a scope with spaces', function() {
       var msg = git.parseRawCommit(
         '13f31602f396bc269076ab4d389cfd8ca94b20ba\n' +
-        'chore: some chore bullshit\n' +
-        'bla bla bla\n\n' + 
+        'chore(scope with spaces): some chore\n' +
+        'bla bla bla\n\n' +
         'BREAKING CHANGE: some breaking change\n'
       );
       expect(msg.type).to.equal('chore');
+      expect(msg.subject).to.equal('some chore');
+      expect(msg.component).to.equal('scope with spaces');
     });
   });
 });

package/test/writer.spec.js

@@ -18,6 +18,8 @@ describe("Writer", function() {
     log = '';
     var stream = es.through(concat, concat.bind(null,'END'));
     return new writer.Writer(stream, {
+      subtitle: 'subby',
+      repository: 'github.com/user/repo',
       issueLink: function(id) {
         return id;
       },
@@ -31,12 +33,12 @@ describe("Writer", function() {
     it('minor version', function() {
       var writer = setup();
       writer.header('0.1.0');
-      expect(log.indexOf('<a name="0.1.0"></a>\n## 0.1.0')).to.equal(0);
+      expect(log).to.contain('## 0.1.0 subby');
     });
     it('patch version', function() {
       var writer = setup();
-      writer.header('0.0.1');
-      expect(log.indexOf('<a name="0.0.1"></a>\n### 0.0.1')).to.equal(0);
+      writer.header('0.0.3');
+      expect(log).to.contain('### 0.0.3 subby');
     });
   });