feat(context): expose finalizeContext to modify context at last

README.md

@@ -194,6 +194,28 @@ When the upstream finishes pouring the commits it will generate a block of logs
 
 If this value is a `string`, it checks the existence of the field. Set to other type to disable it.
 
+##### finalizeContext
+
+Type: `function` Default: pass through
+
+###### finalizeContext(context, options, commits, keyCommit)
+
+####### context
+
+The generated context based on original input `context` and `options`.
+
+####### options
+
+Normalized options.
+
+####### commits
+
+Filtered commits from your git metadata.
+
+####### keyCommit
+
+The commit that triggers to generate the log.
+
 ##### reverse
 
 Type: `boolean` Default: `false`
@@ -251,7 +273,7 @@ Variables in upstream are commit specific and should be used per commit. Eg: *co
 
 context should be module specific and can be used across the whole log. Thus these variables should not be related to any single commit and should be generic information of the module or all commits. Eg: *repository url* and *author names*, etc. You can think of them as "global" or "root" variables.
 
-Basically you can make your own templates and define all your template variables. This module can iterate the commits and compile them. For more details, please checkout [handlebars](http://handlebarsjs.com) and the source code of this module.
+Basically you can make your own templates and define all your template context. Extra context are based on commits from upstream and `options`. For more details, please checkout [handlebars](http://handlebarsjs.com) and the source code of this module.
 
 
 ## CLI

index.js

@@ -33,6 +33,9 @@ function conventionalChangelogWriter(context, options) {
     generateOn: function(commit) {
       return semverValid(commit.version);
     },
+    finalizeContext: function(context) {
+      return context;
+    },
     reverse: false,
     includeDetails: false,
     ignoreReverted: true,

lib/util.js

@@ -166,6 +166,8 @@ function generate(options, commits, context, keyCommit) {
     context.isPatch = context.isPatch || semver.patch(context.version) !== 0;
   }
 
+  context = options.finalizeContext(context, options, commits, keyCommit);
+
   return compiled(context);
 }
 

test/util.spec.js

@@ -545,7 +545,10 @@ describe('util', function() {
   describe('generate', function() {
     it('should merge with the key commit', function() {
       var log = util.generate({
-        mainTemplate: '{{whatever}}'
+        mainTemplate: '{{whatever}}',
+        finalizeContext: function(context) {
+          return context;
+        }
       }, [], {
         whatever: 'a'
       }, {
@@ -557,7 +560,10 @@ describe('util', function() {
 
     it('should not html escape any content', function() {
       var log = util.generate({
-        mainTemplate: '{{whatever}}'
+        mainTemplate: '{{whatever}}',
+        finalizeContext: function(context) {
+          return context;
+        }
       }, [], [], {
         whatever: '`a`'
       });
@@ -568,7 +574,10 @@ describe('util', function() {
     it('should ignore a reverted commit', function() {
       var log = util.generate({
         mainTemplate: '{{#each commitGroups}}{{commits.length}}{{#each commits}}{{header}}{{/each}}{{/each}}{{#each noteGroups}}{{title}}{{#each notes}}{{this}}{{/each}}{{/each}}',
-        ignoreReverted: true
+        ignoreReverted: true,
+        finalizeContext: function(context) {
+          return context;
+        }
       }, [{
         header: 'revert: feat(): amazing new module\n',
         body: 'This reverts commit 56185b7356766d2b30cfa2406b257080272e0b7a.\n',
@@ -631,5 +640,19 @@ describe('util', function() {
       expect(log).to.not.include('revert');
       expect(log).to.not.include('breaking change');
     });
+
+    it('should finalize context', function() {
+      var log = util.generate({
+        mainTemplate: '{{whatever}} {{somethingExtra}}',
+        finalizeContext: function(context) {
+          context.somethingExtra = 'oh';
+          return context;
+        }
+      }, [], [], {
+        whatever: '`a`'
+      });
+
+      expect(log).to.equal('`a` oh');
+    });
   });
 });