Merge pull request #14 from firebase/support-template-subdir-definition

Support template subdirectory definition

Author: Chris Raynor

lib/app.js

@@ -14,12 +14,15 @@ var request = require('request'),
     api = require('./api'),
     util = require('util'),
     chalk = require('chalk'),
+    temp = require('temp'),
     _when = require('when');
 
 var defaultSettings = {
   'public': '.'
 };
 
+temp.track();
+
 function getPrompt(schema, onComplete, idx, results) {
   if (!Array.isArray(schema)) {
     console.log(chalk.red('An error occurred'));
@@ -159,7 +162,7 @@ module.exports = {
       }
 
       // Firebase names always a subset of ^[0-9a-z-]*$ so safe to regex
-      var templateList = Object.keys(supportedTemplates);
+      var templateList = Object.keys(supportedTemplates).sort();
       var firebasePattern = new RegExp('^(' + res.firebases.join('|') + ')$');
       var templatePattern = new RegExp('^(' + templateList.join('|') + ')$');
       if (!argv.firebase || (typeof(argv.firebase) !== 'string') || !argv.firebase.match(firebasePattern)) {
@@ -199,13 +202,15 @@ module.exports = {
         var firebase = results.firebase;
         var dir = firebase;
         var projectDir = path.resolve(dir);
+        var tempDir = temp.mkdirSync();
         if (fs.existsSync(projectDir)) {
           var i = 1;
           do {
             dir = firebase + '_' + i++;
             projectDir = path.resolve(dir);
           } while (fs.existsSync(projectDir));
         }
+
         results.directory = dir;
         console.log('Bootstrapping into directory \'' + dir + '\'...');
         try {
@@ -216,47 +221,81 @@ module.exports = {
           process.exit(1);
         }
 
+        // Load the project root if defined, and gracefully handle missing '/'
+        var templateRoot = supportedTemplates[results.template].templateRoot || '/';
+        if (templateRoot && templateRoot[0] !== '/') {
+          templateRoot = '/' + templateRoot;
+        }
+
         console.log('Downloading and unpacking template...');
         var gunzip = zlib.createGunzip();
         var untar = tar.Extract({
-          path: projectDir,
-          strip: 1
+          path: tempDir,
+          strip: 1,
+          filter: function(entry) {
+            if (!templateRoot) {
+              return true;
+            } else {
+              return (entry.path === tempDir) || (entry.path.indexOf(tempDir + templateRoot) === 0);
+            }
+          }
         });
+
         try {
-          request(supportedTemplates[results.template].url).pipe(gunzip).pipe(untar);
+          request(supportedTemplates[results.template].tarball).pipe(gunzip).pipe(untar);
         } catch (err) {
           console.log(chalk.red('Download Error') + ' - Could not download ' +
                         'template');
           process.exit(1);
         }
+
+        var caughtFinishedEvent = false;
         untar.on('end', function() {
-          var config = path.join(
-                         projectDir,
-                         supportedTemplates[results.template].config
-                       );
+          if (caughtFinishedEvent) return;
+          caughtFinishedEvent = true;
+
           try {
-            var data = fs.readFileSync(config, 'utf8'),
-                realtimeHost = api.realtimeUrl.replace(/\/\//, '//' + firebase + '.');
-            var replaced = data.replace(
-                             new RegExp(supportedTemplates[results.template].configRegex),
-                             realtimeHost
-                           );
-            fs.writeFileSync(config, replaced);
+            fs.renameSync(tempDir + templateRoot, projectDir);
           } catch (err) {
-            console.log(chalk.red('Initialization Error') + ' - Couldn\'t update template with project settings');
+            console.log(chalk.red('Installation Error') + ' - Couldn\'t relocate project assets');
             process.exit(1);
           }
 
+          var configFiles = supportedTemplates[results.template].configFiles || [];
+          for (var i = 0; i < configFiles.length; i++) {
+            var config = path.join(
+                           projectDir,
+                           configFiles[i]
+                         );
+            try {
+              var data = fs.readFileSync(config, 'utf8'),
+                  realtimeHost = api.realtimeUrl.replace(/\/\//, '//' + firebase + '.');
+              var replaced = data.replace(
+                               new RegExp(supportedTemplates[results.template].configRegex, 'g'),
+                               realtimeHost
+                             );
+              fs.writeFileSync(config, replaced);
+            } catch (err) {
+              console.log(chalk.red('Initialization Error') + ' - Couldn\'t update template with project settings');
+              process.exit(1);
+            }
+          }
+
           console.log('Writing firebase.json settings file...');
-          var publicPath = supportedTemplates[results.template]
-                          .settings['public'].replace(/\//g, path.sep),
-              rulesPath = supportedTemplates[results.template]
-                          .settings['rules'].replace(/\//g, path.sep);
           var settings = {
             'firebase': firebase,
-            'public': publicPath,
-            'rules': rulesPath
+            'public': '.'
           };
+
+          if (supportedTemplates[results.template].settings) {
+            if (supportedTemplates[results.template].settings['public']) {
+              settings.public = supportedTemplates[results.template].settings['public'].replace(/\//g, path.sep)
+            }
+            if (supportedTemplates[results.template].settings['rules']) {
+              settings.rules = supportedTemplates[results.template].settings['rules'].replace(/\//g, path.sep);
+            }
+          }
+
           var settingsJSON = JSON.stringify(settings, null, 2) + "\n";
           var settingsFile = path.join(projectDir, 'firebase.json');
           try {
@@ -444,7 +483,13 @@ module.exports = {
         }
 
         try {
-          resolve(JSON.parse(body));
+          var templates = JSON.parse(body);
+          for (var key in templates) {
+            if (!templates[key].enabled) {
+              delete templates[key];
+            }
+          }
+          resolve(templates);
         } catch (e) {
           error.type = 'PARSE-TEMPLATES';
           return reject(error);

lib/help.js

@@ -93,10 +93,12 @@ module.exports = {
         app.getTemplates()
           .done(function(templates) {
             var helpTemplates = '\n                      The currently available templates are:\n';
-            for (var key in templates) {
-              var template = templates[key];
-              helpTemplates += '\n                        ' + key;
-              helpTemplates += (template.repoUrl) ? ' - ' + template.repoUrl + '\n' : '\n';
+            var templateList = Object.keys(templates).sort();
+            for (var i = 0; i < templateList.length; i++) {
+              var key = templateList[i],
+                  template = templates[key];
+              helpTemplates += '\n                        ' + chalk.yellow(key);
+              helpTemplates += (template.repository) ? ' - ' + template.repository + '\n' : '\n';
               if (template.description) {
                 helpTemplates += '                          ' + template.description;
               }

package.json

@@ -7,10 +7,12 @@
     "firebase"
   ],
   "author": "Firebase <[email protected]>",
-  "contributors": [{
-    "name": "Chris Raynor",
-    "email": "[email protected]"
-  }],
+  "contributors": [
+    {
+      "name": "Chris Raynor",
+      "email": "[email protected]"
+    }
+  ],
   "repository": "https://github.com/firebase/firebase-tools.git",
   "homepage": "https://github.com/firebase/firebase-tools",
   "dependencies": {