Run external user config file in context.

Author: rjiang-bb

src/config/user-config.example.js

@@ -7,59 +7,61 @@
  * for complete documentation.
  */
 
-// Use any standard Node library, along with opn (https://www.npmjs.com/package/opn) and
-// any globally-installed Node packages.
-const path = require('path');
-const childProcess = require('child_process');
-const opn = require('opn');
-const os = require('os');
+((require) => {
+  // Use any standard Node library, along with opn (https://www.npmjs.com/package/opn) and
+  // any globally-installed Node packages.
+  const path = require('path');
+  const childProcess = require('child_process');
+  const opn = require('opn');
+  const os = require('os');
 
-module.exports = {
-  rules: [
-    /* EXAMPLES:
+  return {
+    rules: [
+      /*
 
-    // Run script for new file extension
-    {
-      pattern: '\.awesome$',
-      run: (command, filepath) => `awesome-compiler "${filepath}"`
-    },
+      // Run script for new file extension
+      {
+        pattern: '\.awesome$',
+        run: (command, filepath) => `awesome-compiler "${filepath}"`
+      },
 
-    // ------------------------------------------------------
+      // ------------------------------------------------------
 
-    // Rule to compile .md (Markdown) file into HTML, then display in default browser.
-    // Requires first running `npm -g markdown` (https://github.com/evilstreak/markdown-js)
-    {
-      pattern: '\.md$',
-      run: (command, filepath, args) => {
-        const outputHtmlFile = `${args.runDir}/${args.baseFilename}.html`;
-        childProcess.execSync(`md2html ${filepath} > ${outputHtmlFile}`);
-        opn(outputHtmlFile);
+      // Rule to compile .md (Markdown) file into HTML, then display in default browser.
+      // Requires first running `npm -g markdown` (https://github.com/evilstreak/markdown-js)
+      {
+        pattern: '\.md$',
+        run: (command, filepath, args) => {
+          const outputHtmlFile = `${args.runDir}/${args.baseFilename}.html`;
+          childProcess.execSync(`md2html ${filepath} > ${outputHtmlFile}`);
+          opn(outputHtmlFile);
 
-        // Must return a shell command
-        return `echo "Generated '${outputHtmlFile}'" and opened in default browser`;
-      }
-    },
+          // Must return a shell command
+          return `echo "Generated '${outputHtmlFile}'" and opened in default browser`;
+        }
+      },
 
-    // ------------------------------------------------------
+      // ------------------------------------------------------
 
-    // Filter file by both filename and content. Run pre-execution command.
-    // Put "//nvm: v6.10.1" at top of snippet file to use a specific Node version for execution
-    {
-      pattern: (command) => {
-        return /\.js$/.test(command.file.filename)
-          && command.file.content.indexOf('//nvm:') >= 0;
-      },
-      run: (command, filepath) => {
-        let nvmVersion = command.file.content.match(/(\/\/nvm: v(.+))/)[0]
-          .replace('//nvm: ', '');
+      // Filter file by both filename and content. Run pre-execution command.
+      // Put "//nvm: v6.10.1" at top of snippet file to use a specific Node version for execution
+      {
+        pattern: (command) => {
+          return /\.js$/.test(command.file.filename)
+            && command.file.content.indexOf('//nvm:') >= 0;
+        },
+        run: (command, filepath) => {
+          let nvmVersion = command.file.content.match(/(\/\/nvm: v(.+))/)[0]
+            .replace('//nvm: ', '');
 
-        return `export NVM_DIR=~/.nvm ` +
-          `&& source ~/.nvm/nvm.sh` +
-          `&& nvm use ${nvmVersion} ` +
-          `&& node "${filepath}"`;
+          return `export NVM_DIR=~/.nvm ` +
+            `&& source ~/.nvm/nvm.sh` +
+            `&& nvm use ${nvmVersion} ` +
+            `&& node "${filepath}"`;
+        }
       }
-    }
 
-    */
-  ]
-};
+      */
+    ]
+  };
+});

src/lib/exec-command.ts

@@ -4,6 +4,7 @@ import { ChildProcess, spawn } from 'child_process';
 
 const fs = require('fs');
 const path = require('path');
+const vm = require('vm');
 
 import * as _ from 'lodash';
 import * as os from 'os';
@@ -13,6 +14,7 @@ import chalk from 'chalk'
 const pretty = require('js-object-pretty-print').pretty;
 
 const WORK_DIR = path.resolve(`${os.homedir()}/.cacher/run`);
+const USER_CONFIG = path.resolve(`${os.homedir()}/.cacher/run-server.user.config.js`);
 
 export class ExecCommand {
   /**
@@ -50,7 +52,12 @@ export class ExecCommand {
     this.logger = args.logger;
 
     const defaultConfig = require('../config/config.default.js');
-    const userConfig = require('../config/config.user.js');
+
+    // Read userConfig from external file
+    const configUserScript = fs.readFileSync(USER_CONFIG).toString();
+    const userConfig = vm.runInThisContext(
+      configUserScript
+    )(require);
 
     // Prepend user config rules to default config
     const config = Object.assign({}, defaultConfig);

src/lib/server.ts

@@ -3,6 +3,7 @@ import * as express from 'express';
 
 const os = require('os');
 const path = require('path');
+
 const shell = require('shelljs');
 const socketio = require('socket.io');
 const opn = require('opn');
@@ -123,10 +124,6 @@ export class RunServer {
         logger.info(`Copied user configuration to:\n${chalk.bold(USER_CONFIG)}\n`);
       }
     }
-
-    // Copy user config into this dir
-    const configUser = path.resolve(`${__dirname}/../config/config.user.js`);
-    shell.cp(USER_CONFIG, configUser);
   }
 
   /**