Add ability to choose template engines - fixes #2

RobLoach · Dec 2, 2013 · 90e1c46 · 90e1c46
1 parent 977fa08
commit 90e1c46
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -34,10 +34,14 @@ $ npm start
 
 ## Features
 
-* Base DocPad application structure
-* [Bower](http://github.com/robloach/docpad-plugin-bower)
-* [Grunt](http://github.com/robloach/docpad-plugin-grunt)
-* [Marked](http://docpad.org/plugin/marked)
+* Set up the DocPad application structure
+* Select [Renderers](http://docpad.org/docs/plugins#renderers)
+  * [Eco](http://docpad.org/plugin/eco)
+  * [Marked](http://docpad.org/plugin/marked)
+* Select [Helpers](http://docpad.org/docs/plugins#helpers)
+  * [Bower](http://github.com/robloach/docpad-plugin-bower)
+  * [Grunt](http://github.com/robloach/docpad-plugin-grunt)
+  * [Live Reload](http://docpad.org/plugin/livereload)
 
 
 ## License

diff --git a/app/index.js b/app/index.js
@@ -65,8 +65,25 @@ DocPadGenerator.prototype.askFor = function askFor() {
     },
     {
       type: 'checkbox',
-      name: 'features',
-      message: 'Features',
+      name: 'renderers',
+      message: 'Renderers',
+      choices: [
+        {
+          name: 'Eco: Supports Eco to anything',
+          value: 'eco',
+          checked: true
+        },
+        {
+          name: 'Marked: Supports Markdown to HTML',
+          value: 'marked',
+          checked: false
+        }
+      ]
+    },
+    {
+      type: 'checkbox',
+      name: 'helpers',
+      message: 'Helpers',
       choices: [
         {
           name: 'Bower: Package Manager',
@@ -79,29 +96,37 @@ DocPadGenerator.prototype.askFor = function askFor() {
           checked: false
         },
         {
-          name: 'Marked: Supports Markdown to HTML',
-          value: 'marked',
-          checked: false
+          name: 'Live Reload: Automatically reloads the page when regenerating',
+          value: 'livereload',
+          checked: true
         }
       ]
     }
   ];
 
   this.prompt(prompts, function (answers) {
     // Construct the user options.
-    function hasFeature(feat) { return answers.features.indexOf(feat) !== -1; }
+    function hasRenderer(feat) { return answers.renderers.indexOf(feat) !== -1; }
+    function hasHelper(feat) { return answers.helpers.indexOf(feat) !== -1; }
     this.options = {
       appname: answers.appname,
       docpadFile: answers.docpadFile,
       license: answers.license,
-      bower: hasFeature('bower'),
-      marked: hasFeature('marked'),
-      grunt: hasFeature('grunt')
+      bower: hasHelper('bower'),
+      marked: hasRenderer('marked'),
+      eco: hasRenderer('eco'),
+      grunt: hasHelper('grunt'),
+      livereload: hasHelper('livereload')
     };
 
     // Override any of the internal variables.
     this.appname = this.options.appname;
 
+    // Ensure the base requirements are met.
+    if (!this.options.eco) {
+      this.options.eco = true;
+    }
+
     cb();
   }.bind(this));
 };
@@ -155,6 +180,13 @@ DocPadGenerator.prototype.marked = function marked() {
   }
 };
 
+DocPadGenerator.prototype.eco = function eco() {
+  if (this.options.eco) {
+    this.copy('docpad/layouts/default.html.eco', 'src/layouts/default.html.eco');
+    this.copy('docpad/documents/eco.html.eco', 'src/documents/eco.html.eco');
+  }
+};
+
 DocPadGenerator.prototype.docpadFiles = function docpadFiles() {
   // All the DocPad source files.
   var files = [
@@ -165,7 +197,6 @@ DocPadGenerator.prototype.docpadFiles = function docpadFiles() {
   }
 
   var files = [
-    "layouts/default.html.eco",
     "files/main.css",
     "files/main.js"
   ];

diff --git a/app/templates/_package.json b/app/templates/_package.json
@@ -5,13 +5,13 @@
     "node": ">=0.8.0"
   },
   "dependencies": {
-    "docpad": "~6.56.0",
-    "docpad-plugin-eco": "~2.0.2"<% if (options.grunt) { %>,
+    "docpad": "~6.56.0"<% if (options.eco) { %>,
+    "docpad-plugin-eco": "~2.0.2"<% } %><% if (options.grunt) { %>,
     "docpad-plugin-grunt": "~2.0.5"<% } %><% if (options.marked) { %>,
     "docpad-plugin-marked": "~2.1.2"<% } %>
   },
-  "devDependencies": {
-    "docpad-plugin-livereload": "~2.5.3"<% if (options.bower) { %>,
+  "devDependencies": {<% if (options.livereload) { %>
+    "docpad-plugin-livereload": "~2.5.3"<% } %><% if (options.bower) { %>,
     "bower": "~1.2.7"<% } %><% if (options.grunt) { %>,
     "grunt": "~0.4.2"<% } %>
   },

diff --git a/app/templates/docpad/documents/eco.html.eco b/app/templates/docpad/documents/eco.html.eco
@@ -0,0 +1,8 @@
+---
+layout: "default"
+title: "Eco Example"
+---
+
+<p>This example of <%= appname %> makes use of the <a href="https://github.com/docpad/docpad-plugin-eco/">Eco DocPad Plugin</a>.</p>
+
+<ul><li><a href="index.html">Home</a></li></ul>
diff --git a/app/templates/docpad/documents/index.html b/app/templates/docpad/documents/index.html
@@ -8,4 +8,5 @@
 <h2>Examples</h2>
 <ul>
   <% if (options.marked) { %><li><a href="marked.html">Marked</a></li><% } %>
+  <% if (options.eco) { %><li><a href="eco.html">Eco</a></li><% } %>
 </ul>
diff --git a/test/test-creation.js b/test/test-creation.js
@@ -30,18 +30,24 @@ describe('docpad generator', function () {
             'docpad.cson',
             'src/documents/index.html',
             'LICENSE.md',
-            'src/documents/marked.html.md'
+            'src/documents/marked.html.md',
+            'src/documents/eco.html.eco',
+            'src/layouts/default.html.eco'
         ];
 
         // Mock the answer prompts.
         helpers.mockPrompt(this.app, {
             'appname': 'DocPad test',
             'docpadFile': 'docpad.cson',
             'license': 'Apache-2.0',
-            features: [
-              'grunt',
+            renderers: [
               'marked',
-              'bower'
+              'eco'
+            ],
+            helpers: [
+              'grunt',
+              'bower',
+              'livereload'
             ]
         });
         this.app.options['skip-install'] = true;