Updating the theme descriptors

- Changed name to commandName
- Changed description to mainDescription

Author: agnivade

config.json

@@ -3,39 +3,39 @@
   "url": "http://tldr-pages.github.io/assets/tldr.zip",
   "themes": {
     "simple": {
-      "name": "bold,underline",
-      "description": "bold",
+      "commandName": "bold, underline",
+      "mainDescription": "bold",
       "exampleDescription": "",
       "exampleCode": "",
       "exampleToken": "underline"
     },
     "base16": {
-      "name": "bold",
-      "description": "",
+      "commandName": "bold",
+      "mainDescription": "",
       "exampleDescription": "green",
       "exampleCode": "red",
       "exampleToken": "cyan"
     },
     "ocean": {
-      "name": "bold,cyan",
-      "description": "",
+      "commandName": "bold, cyan",
+      "mainDescription": "",
       "exampleDescription": "green",
       "exampleCode": "cyan",
       "exampleToken": "dim"
     },
     "inverse": {
-      "name": "bold,inverse",
-      "description": "inverse",
+      "commandName": "bold, inverse",
+      "mainDescription": "inverse",
       "exampleDescription": "black",
       "exampleCode": "inverse",
-      "exampleToken": "green,bgBlack,inverse"
+      "exampleToken": "green, bgBlack, inverse"
     },
     "matrix": {
-      "name": "bold",
-      "description": "underline",
-      "exampleDescription": "green,bgBlack",
-      "exampleCode": "green,bgBlack",
-      "exampleToken": "green,bold,bgBlack"
+      "commandName": "bold",
+      "mainDescription": "underline",
+      "exampleDescription": "green, bgBlack",
+      "exampleCode": "green, bgBlack",
+      "exampleToken": "green, bold, bgBlack"
     }
   },
   "theme": "simple"

lib/config.js

@@ -83,10 +83,10 @@ function validateThemeItem(field, key) {
                     ];
   for (var item in field) {
     if (field.hasOwnProperty(item)) {
-      var tokens = field[item].split(',');
+      var tokens = field[item].replace(/\s+/g,'').split(',');
       for (var i=0; i < tokens.length; i++) {
         if (validValues.indexOf(tokens[i]) < 0) {
-          return 'Invalid ANSI color : ' + tokens[i] + ' in ' + key + ' theme';
+          return 'Invalid theme value : ' + tokens[i] + ' in ' + key + ' theme';
         }
       }
     }

lib/render.js

@@ -19,9 +19,9 @@ exports.toANSI = function(page) {
 
   var output = [];
 
-  output.push('  ' + theme.renderName(page.name));
+  output.push('  ' + theme.renderCommandName(page.name));
   output.push('');
-  output.push('  ' + theme.renderDescription(page.description.replace(/\n/g, '\n  ')));
+  output.push('  ' + theme.renderMainDescription(page.description.replace(/\n/g, '\n  ')));
   output.push('');
 
   page.examples.forEach(function(example) {

lib/theme.js

@@ -30,8 +30,8 @@ var Theme = function(options) {
   };
 
   return {
-    renderName: renderPartMemoized('name'),
-    renderDescription: renderPartMemoized('description'),
+    renderCommandName: renderPartMemoized('commandName'),
+    renderMainDescription: renderPartMemoized('mainDescription'),
     renderExampleDescription: renderPartMemoized('exampleDescription'),
     renderExampleCode: renderPartMemoized('exampleCode'),
     renderExampleToken: renderPartMemoized('exampleToken')

test/config.spec.js

@@ -18,8 +18,8 @@ describe('Config', function() {
     '{' +
     '"themes": {' +
     '  "simple": {' +
-    '    "name": "bold,underline",' +
-    '    "description": "#876992",' +
+    '    "commandName": "bold,underline",' +
+    '    "mainDescription": "#876992",' +
     '    "exampleDescription": "",' +
     '    "exampleCode": "",' +
     '    "exampleToken": "underline"' +
@@ -52,7 +52,7 @@ describe('Config', function() {
   it('should validate the custom config format', function() {
     fs.readFileSync.onCall(0).returns(DEFAULT);
     fs.readFileSync.onCall(1).returns(CUSTOM_INVALID);
-    config.get.should.throw(/Invalid ANSI color/);
+    config.get.should.throw(/Invalid theme value/);
   });
 
 });

test/theme.spec.js

@@ -6,21 +6,21 @@ describe('Theme', function() {
   describe('Rendering', function() {
 
     var theme = new Theme({
-      name: 'green, bold',
-      description: 'red, underline',
+      commandName: 'green, bold',
+      mainDescription: 'red, underline',
       exampleDescription: 'blue',
       exampleCode: 'bold',
       exampleToken: 'yellow,dim,underline'
     });
 
     it('should render name with green and bold', function () {
-      theme.renderName('text')
+      theme.renderCommandName('text')
         .should.equal(
           chalk.green.bold('text'));
     });
 
     it('should render description with red and underline', function () {
-      theme.renderDescription('text')
+      theme.renderMainDescription('text')
         .should.equal(
           chalk.red.underline('text'));
     });