Implement ability to specify more than one file extension

closes #2

Author: bmuenzenmeyer

dist/js/plugin-node-tab.js

@@ -1,21 +1,9 @@
-/* global Panels */
-
 var PluginTab = {
 
   init: function () {
 
-    Panels.add({
-      'id': 'sg-panel-scss',
-      'name': 'SCSS',
-      'default': false,
-      'templateID': 'pl-panel-template-code',
-      'httpRequest': true,
-      'httpRequestReplace': '.scss',
-      'httpRequestCompleted': false,
-      'prismHighlight': true,
-      'language': 'markup',
-      'keyCombo': 'ctrl+shift+z'
-    });
+    //placeholder that will be replaced during configuation
+    /*SNIPPETS*/
 
   }
 };

index.js

@@ -2,9 +2,10 @@
 
 const pluginName = 'plugin-node-tab';
 
-var fs = require('fs-extra'),
+const fs = require('fs-extra'),
   glob = require('glob'),
   path = require('path'),
+  EOL = require('os').EOL,
   tab_loader = require('./src/tab-loader');
 
 function onPatternIterate(patternlab, pattern) {
@@ -46,6 +47,8 @@ function pluginInit(patternlab) {
     process.exit(1);
   }
 
+  let fileTypes = require('./package.json').fileTypes;
+
   //write the plugin json to public/patternlab-components
   var pluginConfig = getPluginFrontendConfig();
   var pluginConfigPathName = path.resolve(patternlab.config.paths.public.root, 'patternlab-components', 'packages');
@@ -66,13 +69,31 @@ function pluginInit(patternlab) {
   var pluginFiles = glob.sync(__dirname + '/dist/**/*');
 
   if (pluginFiles && pluginFiles.length > 0) {
+
+    let tab_frontend_snippet = fs.readFileSync(path.resolve(__dirname + '/src/snippet.js'), 'utf8');
+
     for (let i = 0; i < pluginFiles.length; i++) {
       try {
         var fileStat = fs.statSync(pluginFiles[i]);
         if (fileStat.isFile()) {
           var relativePath = path.relative(__dirname, pluginFiles[i]).replace('dist', ''); //dist is dropped
           var writePath = path.join(patternlab.config.paths.public.root, 'patternlab-components', 'pattern-lab', pluginName, relativePath);
-          fs.copySync(pluginFiles[i], writePath);
+
+          //a message to future plugin authors:
+          //depending on your plugin's job - you might need to alter the dist file instead of copying.
+          //if you are simply copying dist files, you can probably do the below:
+          //fs.copySync(pluginFiles[i], writePath);
+
+          //in this case, we need to alter the dist file to loop through our tabs to load as defined in the package.json
+          //we are also being a bit lazy here, since we only expect one file
+          let tabJSFileContents = fs.readFileSync(pluginFiles[i], 'utf8');
+          var snippetString = '';
+          for (let j = 0; j < fileTypes.length; j++) {
+            let tabSnippetLocal = tab_frontend_snippet.replace(/<<type>>/g, fileTypes[j]).replace(/<<typeUC>>/g, fileTypes[j].toUpperCase());
+            snippetString += tabSnippetLocal + EOL;
+          }
+          tabJSFileContents = tabJSFileContents.replace('/*SNIPPETS*/', snippetString);
+          fs.outputFileSync(writePath, tabJSFileContents);
         }
       } catch (ex) {
         console.trace('plugin-node-tab: Error occurred while copying pluginFile', pluginFiles[i]);

postinstall.js

@@ -27,8 +27,8 @@ inquirer
     }
 
     for (let i = 0; i < fileTypes.length; i++) {
-      if (fileTypes[i].charAt(0) !== '.') {
-        fileTypes[i] = '.' + fileTypes[i];
+      if (fileTypes[i].charAt(0) === '.') {
+        fileTypes[i] = fileTypes[i].slice(1);
       }
     }
 

src/snippet.js

@@ -0,0 +1,14 @@
+/* global Panels */
+
+Panels.add({
+  'id': 'sg-panel-<<type>>',
+  'name': '<<typeUC>>',
+  'default': false,
+  'templateID': 'pl-panel-template-code',
+  'httpRequest': true,
+  'httpRequestReplace': '.<<type>>',
+  'httpRequestCompleted': false,
+  'prismHighlight': true,
+  'language': 'markup',
+  'keyCombo': 'ctrl+shift+z'
+});

src/tab-loader.js

@@ -1,7 +1,8 @@
 "use strict";
 
-var fs = require('fs-extra'),
-  path = require('path');
+const fs = require('fs-extra'),
+  path = require('path'),
+  fileTypes = require('./../package.json').fileTypes;
 
 function findTab(patternlab, pattern) {
 
@@ -17,30 +18,42 @@ function findTab(patternlab, pattern) {
 
   //derive the custom filetype paths from the pattern relPath
   var customFileTypePath = path.join(patternlab.config.paths.source.patterns, pattern.relPath);
-  customFileTypePath = customFileTypePath.substr(0, customFileTypePath.lastIndexOf(".")) + ".scss";
-  var customFileTypeOutputPath = patternlab.config.paths.public.patterns + pattern.getPatternLink(patternlab, 'custom', '.scss');
 
-  //look for a custom filetype for this template
-  try {
-    var tabFileName = path.resolve(customFileTypePath);
+  for (let i = 0; i < fileTypes.length; i++) {
+
+    customFileTypePath = customFileTypePath.substr(0, customFileTypePath.lastIndexOf(".")) + '.' + fileTypes[i];
+    var customFileTypeOutputPath = patternlab.config.paths.public.patterns + pattern.getPatternLink(patternlab, 'custom', '.' + fileTypes[i]);
+
+    //look for a custom filetype for this template
     try {
-      var tabFileNameStats = fs.statSync(tabFileName);
-    } catch (err) {
-      //not a file
-    }
-    if (tabFileNameStats && tabFileNameStats.isFile()) {
-      if (patternlab.config.debug) {
-        console.log('plugin-node-tab: copied pattern-specific custom file for ' + pattern.patternPartial);
+      var tabFileName = path.resolve(customFileTypePath);
+      try {
+        var tabFileNameStats = fs.statSync(tabFileName);
+      } catch (err) {
+        //not a file
+      }
+      if (tabFileNameStats && tabFileNameStats.isFile()) {
+        if (patternlab.config.debug) {
+          console.log('plugin-node-tab: copied pattern-specific custom file for ' + pattern.patternPartial);
+        }
+        fs.copySync(tabFileName, customFileTypeOutputPath);
+      } else {
+        fs.outputFileSync(customFileTypeOutputPath, '');
       }
-      fs.copySync(tabFileName, customFileTypeOutputPath);
-    } else {
-      fs.outputFileSync(customFileTypeOutputPath, '');
     }
+    catch (err) {
+      console.log('plugin-node-tab:There was an error parsing sibling JSON for ' + pattern.relPath);
+      console.log(err);
+    }
+
+
+
+
   }
-  catch (err) {
-    console.log('plugin-node-tab:There was an error parsing sibling JSON for ' + pattern.relPath);
-    console.log(err);
-  }
+
+
+
+
 }
 
 module.exports = findTab;