Merge pull request #25 from kyleholzinger/master

Add prefix to examples

body-template.md.hbs

@@ -26,14 +26,14 @@
 ##### Examples
 
 {{#each rule.optionExamples }}
-{{{json . false}}}
+{{{json . false ../rule.ruleName }}}
 {{/each}}
 {{/if}}
 
 {{#if rule.options }}
 ##### Schema
 
-{{{json rule.options true }}}
+{{{json rule.options true '' }}}
 {{/if}}
 
-For more information see [this page](https://palantir.github.io/tslint/rules/{{{rule.ruleName}}}).
+For more information see [this page](https://palantir.github.io/tslint/rules/{{{rule.ruleName}}}).

package.json

@@ -64,7 +64,9 @@
     "lodash": "^4.17.4",
     "rxjs": "^5.3.0",
     "tslint": "5.0.0",
+    "tslint-config-airbnb": "^5.0.0",
     "tslint-config-standard": "^5.0.2",
-    "tslint-eslint-rules": "^4.0.0"
+    "tslint-eslint-rules": "^4.0.0",
+    "tslint-react": "^3.0.0"
   }
 }

src/contentRenderer.ts

@@ -4,14 +4,16 @@ import * as path from 'path';
 import * as fs from 'fs';
 import * as handlebars from 'handlebars';
 import {IRuleMetadata} from 'tslint';
+import * as _ from 'lodash';
 const autobind: any = require('autobind-decorator');
 
 handlebars.registerHelper('notesHeader', (rule: IRuleMetadata) => {
   return (rule.typescriptOnly || rule.hasFix || rule.requiresTypeInfo) ? `\n##### Notes\n` : '';
 });
-handlebars.registerHelper('json', (obj: any, escape: boolean = false) => {
+handlebars.registerHelper('json', (obj: any, escape: boolean = false, prefix: string) => {
   const json = escape ? JSON.stringify(obj, null, 2) : obj;
-  return '```json\n' + json + '\n```';
+  const prefixString = !_.isEmpty(prefix) ? '"' + prefix + '": ' : '';
+  return '```json\n' + prefixString + json + '\n```';
 });
 
 @autobind

src/test/contentRenderer.spec.ts

@@ -30,7 +30,7 @@ describe('ContentRenderer', () => {
         requiresTypeInfo: true,
         typescriptOnly: true
       };
-      const optionExamples = rule.optionExamples.map(o => '```json\n' + o + '\n```').join('\n');
+      const optionExamples = rule.optionExamples.map(o => '```json\n' + '"' + rule.ruleName + '": ' + o + '\n```').join('\n');
       const options = '```json\n' + JSON.stringify(rule.options, null, 2) + '\n```';
       const expected = `# Rule: ${rule.ruleName}
 
@@ -60,7 +60,8 @@ ${optionExamples}
 
 ${options}
 
-For more information see [this page](https://palantir.github.io/tslint/rules/${rule.ruleName}).`;
+For more information see [this page](https://palantir.github.io/tslint/rules/${rule.ruleName}).
+`;
       // When
       const actual = renderer.render(rule);
       // Then