Custom templating (#34)

* Introduce custom templating * Remove console.logs and remove unused chalk * Indent js lines * Get the options from a different gren.json * Add the Templating system * Remove extra variable for config file * Simplify label templating * Use deep assign to merge the config file for templating * Add deep-assign to package.json * Update the readme file based on the templating system
github-tools · Mar 10, 2017 · 5d50346 · 5d50346
1 parent a4cca14
commit 5d50346
Show file tree

Hide file tree

Showing 5 changed files with 136 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -69,6 +69,56 @@ Following the options for the module:
 - `--include-messages=merges|commits|all` used to filter the messages added to the release notes. Default: `commits`
 - `--override=true|false` Override the release notes if existing. Default: `false`
 
+### Config file
+
+You can create a `.gren.json` file where the task will be ran, where to specify your options.
+The options in the file would be camelCase *e.g*:
+
+```json
+{
+    "action": "release",
+    "timeWrap": "history",
+    "dataSource": "commits"
+}
+```
+
+### Templates
+
+With **gren** you can decide how you want to output the informations, using the templates.
+
+The default configuration is the following:
+
+```json
+{
+    "...": "...",
+    "template": {
+        "commit": "- {{message}}",
+        "issue": "- {{labels}} {{name}} {{link}}",
+        "issueInfo": {
+            "labels": "{{labels}}",
+            "label": "[**{{label}}**]",
+            "name": "{{name}}",
+            "link": "[{{text}}]({{url}})"
+        },
+        "release": "## {{release}} {{date}}",
+        "releaseInfo": {
+            "release": "{{release}}",
+            "date": "({{date}})"
+        }
+    }
+}
+```
+
+To customise the templates you need to change the `.gren.json` config file. You only need to specify what you want to change *e.g.*
+
+```json
+{
+    "template": {
+        "issue": "- {{name}}"
+    }
+}
+```
+
 ## Examples
 
 The ways to use **gren** are various.

diff --git a/package.json b/package.json
@@ -34,9 +34,9 @@
   "dependencies": {
     "chalk": "^1.1.3",
     "connectivity": "^1.0.0",
+    "deep-assign": "^2.0.0",
     "es6-promise": "^3.2.1",
     "github-api": "^3.0.0",
-    "object-assign": "^4.1.0"
   },
   "devDependencies": {
     "eslint": "^3.6.0",

diff --git a/src/gren.js b/src/gren.js
@@ -2,12 +2,15 @@
 
 var utils = require('./utils');
 var githubInfo = require('./github-info');
+var template = require('./template');
 var Github = require('github-api');
 var fs = require('fs');
 var chalk = require('chalk');
 var Promise = Promise || require('es6-promise').Promise;
 var connectivity = require('connectivity');
-var ObjectAssign = require('object-assign');
+var templateConfig = require('./templates.json');
+var ObjectAssign = require('deep-assign');
+var configFile = fs.existsSync(process.cwd() + '/.gren.json') ? require(process.cwd() + '/.gren.json') : {};
 
 var defaults = {
     tags: false,
@@ -20,11 +23,12 @@ var defaults = {
     includeMessages: 'commits', // || merges || all
     prerelease: false,
     dateZero: new Date(0),
-    override: false
+    override: false,
+    template: templateConfig
 };
 
 /**
- * Edit arelease from a given tag (in the options)
+ * Edit a release from a given tag (in the options)
  *
  * @since 0.5.0
  * @private
@@ -289,8 +293,10 @@ function getLastTwoReleases(gren) {
  *
  * @return {string}
  */
-function templateCommits(message) {
-    return '- ' + message;
+function templateCommits(gren, message) {
+    return template.generate({
+        message: message
+    }, gren.options.template.commit);
 }
 
 /**
@@ -303,11 +309,16 @@ function templateCommits(message) {
  *
  * @return {string}
  */
-function templateLabels(issue) {
-    return issue.labels ? issue.labels.map(function(label) {
-        return '[**' + label.name + '**] ';
-    })
-    .join('') : '[closed]';
+function templateLabels(gren, issue) {
+    if (!issue.labels.length) {
+        issue.labels.push({name: 'closed'});
+    }
+
+    return issue.labels.map(function(label) {
+        return template.generate({
+            label: label.name
+        }, gren.options.template.issueInfo.label);
+    }).join('');
 }
 
 /**
@@ -320,11 +331,14 @@ function templateLabels(issue) {
  *
  * @return {string}
  */
-function templateBlock(block) {
+function templateBlock(gren, block) {
     var date = new Date(block.date);
+    var releaseTemplate = template.generate({
+        release: block.name,
+        date: utils.formatDate(date)
+    }, template.generate(gren.options.template.releaseInfo, gren.options.template.release));
 
-    return '## ' + block.name + ' (' + utils.formatDate(date) + ')' + '\n\n' +
-        block.body;
+    return releaseTemplate + '\n\n' + block.body;
 }
 
 /**
@@ -337,8 +351,18 @@ function templateBlock(block) {
  *
  * @return {string}
  */
-function templateIssue(issue) {
-    return '- ' + templateLabels(issue) + issue.title + ' [#' + issue.number + '](' + issue.html_url + ')';
+function templateIssue(gren, issue) {
+    var issueTemplate = template.generate(gren.options.template.issueInfo, gren.options.template.issue);
+    var nameTemplate = template.generate({
+        name: issue.title
+    }, gren.options.template.issueInfo.name);
+
+    return template.generate({
+        labels: templateLabels(gren, issue),
+        name: nameTemplate,
+        text: '#' + issue.number,
+        url: issue.html_url
+    }, issueTemplate);
 }
 
 /**
@@ -351,10 +375,10 @@ function templateIssue(issue) {
  *
  * @return {string}
  */
-function templateChangelog(blocks) {
+function templateChangelog(gren, blocks) {
     return '# Changelog\n\n' +
         blocks
-            .map(templateBlock)
+            .map(templateBlock.bind(null, gren))
             .join('\n\n --- \n\n');
 }
 
@@ -405,7 +429,7 @@ function generateCommitsBody(gren, messages) {
 
             return filterMap.commits(message);
         })
-        .map(templateCommits)
+        .map(templateCommits.bind(null, gren))
         .join('\n');
 }
 
@@ -498,19 +522,19 @@ function getClosedIssues(gren, releaseRanges) {
 
     return gren.issues.listIssues({
         state: 'closed',
-        since: releaseRanges[0][1].date
+        since: releaseRanges[releaseRanges.length - 1][1].date
     })
-        .then(function(response) {
-            loaded();
+    .then(function(response) {
+        loaded();
 
-            var filteredIssues = response.data.filter(function(issue) {
-                return !issue.pull_request;
-            });
+        var filteredIssues = response.data.filter(function(issue) {
+            return !issue.pull_request;
+        });
 
-            process.stdout.write(filteredIssues.length + ' issues found\n');
+        process.stdout.write(filteredIssues.length + ' issues found\n');
 
-            return filteredIssues;
-        });
+        return filteredIssues;
+    });
 }
 
 /**
@@ -539,7 +563,7 @@ function getIssueBlocks(gren, releaseRanges) {
                                 Date.parse(range[0].date)
                             );
                         })
-                        .map(templateIssue);
+                        .map(templateIssue.bind(null, gren));
 
                     return {
                         id: range[0].id,
@@ -564,7 +588,7 @@ function getIssueBlocks(gren, releaseRanges) {
  */
 function sortReleasesByDate(releaseDates) {
     return releaseDates.sort(function(release1, release2) {
-        return new Date(release1.date) < new Date(release2.date) ? 1 : -1;
+        return new Date(release2.date) - new Date(release1.date);
     });
 }
 
@@ -627,7 +651,7 @@ function generateReleaseDatesChangelogBody(gren) {
             return dataSource[gren.options.dataSource](gren, releaseRanges);
         })
         .then(function(blocks) {
-            return templateChangelog(blocks);
+            return templateChangelog(gren, blocks);
         });
 }
 
@@ -733,7 +757,8 @@ function hasNetwork() {
  * @constructor
  */
 function GithubReleaseNotes(options) {
-    this.options = ObjectAssign({}, defaults, options || utils.getBashOptions(process.argv));
+    this.options = ObjectAssign({}, defaults, configFile, options || utils.getBashOptions(process.argv));
+    console.log(this.options.template);
     this.options.tags = this.options.tags && this.options.tags.split(',');
     this.repo = null;
     this.issues = null;

diff --git a/src/template.js b/src/template.js
@@ -0,0 +1,14 @@
+'use strict';
+
+function generate(placeholders, string) {
+    return Object.keys(placeholders)
+        .reduce(function(carry, placeholder) {
+            var placeholderRegExp = new RegExp('{{' + placeholder + '}}', 'g');
+
+            return carry.replace(placeholderRegExp, placeholders[placeholder]);
+        }, string);
+}
+
+module.exports = {
+    generate: generate
+};
diff --git a/src/templates.json b/src/templates.json
@@ -0,0 +1,15 @@
+{
+    "commit": "- {{message}}",
+    "issue": "- {{labels}} {{name}} {{link}}",
+    "issueInfo": {
+        "labels": "{{labels}}",
+        "label": "[**{{label}}**]",
+        "name": "{{name}}",
+        "link": "[{{text}}]({{url}})"
+    },
+    "release": "## {{release}} {{date}}",
+    "releaseInfo": {
+        "release": "{{release}}",
+        "date": "({{date}})"
+    }
+}