Changed filename for user config. (#1)

Author: jookyboi

README.md

@@ -119,13 +119,13 @@ this config is copied to the Cacher directory as `~/.cacher/run-server.config.js
 you would like to add a file handler to this config (and let everyone use it), please submit a pull request instead. See 
 the [Contributing](#contributing) section below.
 
-- **`~/.cacher/run-server.user.config.js`** - Edit this file to add or overwrite file extension handlers on your local 
+- **`~/.cacher/run-server.user-config.js`** - Edit this file to add or overwrite file extension handlers on your local 
 machine. Here are some examples of functions you might add to handle new file types:
 
 **Add command for `.awesome` file extension.**
 
 ```javascript
-// ~/.cacher/run-server.user.config.js
+// ~/.cacher/run-server.user-config.js
 
 return {
   rules: [
@@ -141,7 +141,7 @@ return {
 **Compile `.md` (Markdown) file into HTML, then display in default browser.**
 
 ```javascript
-// ~/.cacher/run-server.user.config.js
+// ~/.cacher/run-server.user-config.js
 
 // Requires `npm -g markdown` to be run first.
 return {
@@ -165,7 +165,7 @@ return {
 **Match Javascript files by `.js` extension and file content. Calls `nvm use [version]` before execution.**
 
 ```javascript
-// ~/.cacher/run-server.user.config.js
+// ~/.cacher/run-server.user-config.js
 
 return {
   rules: [

src/config/config.default.js

@@ -1,6 +1,6 @@
 /**
  * DO NOT EDIT THIS FILE! It is here only for reference.
- * Override/append to these rules by editing ~/.cacher/run-server.user.config.js
+ * Override/append to these rules by editing ~/.cacher/run-server.user-config.js
  *
  * See https://github.com/cacherapp/cacher-run-server/README.md for complete documentation.
  */

src/lib/exec-command.ts

@@ -4,7 +4,6 @@ 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';
@@ -14,7 +13,6 @@ 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 {
   /**
@@ -53,15 +51,9 @@ export class ExecCommand {
 
     const defaultConfig = require('../config/config.default.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);
-    _.each(userConfig.rules, (rule: any) => {
+    _.each(args.userConfig.rules, (rule: any) => {
       config.rules.unshift(rule);
     });
 
@@ -97,7 +89,7 @@ export class ExecCommand {
 
     if (!cmd) {
       const userConfigFile =
-        path.resolve(`${os.homedir()}/.cacher/run-server.user.config.js`);
+        path.resolve(`${os.homedir()}/.cacher/run-server.user-config.js`);
       const noCmdMessage =
         `Error: Could not find a rule that matches filename '${this.clientCommand.file.filename}'. Please add one to: ${userConfigFile}.`;
       return spawn(`echo "${noCmdMessage}" && exit 127`, [], { shell: true });

src/lib/server.ts

@@ -3,6 +3,7 @@ import * as express from 'express';
 
 const os = require('os');
 const path = require('path');
+const vm = require('vm');
 
 const shell = require('shelljs');
 const socketio = require('socket.io');
@@ -22,9 +23,11 @@ import { ExecCommand } from './exec-command';
 
 const WORK_DIR = path.resolve(`${os.homedir()}/.cacher/run`);
 const LOGS_DIR = path.resolve(`${os.homedir()}/.cacher/logs`);
-const USER_CONFIG = path.resolve(`${os.homedir()}/.cacher/run-server.user.config.js`);
+const USER_CONFIG_FILE = path.resolve(`${os.homedir()}/.cacher/run-server.user-config.js`);
 const LOG_FILE = path.resolve(`${LOGS_DIR}/run-server.log`);
 
+let USER_CONFIG = { rules: [] };
+
 export class RunServer {
   /**
    * Uses the Socket.io Server to accept WebSocket command requests and execute
@@ -51,9 +54,9 @@ export class RunServer {
     RunServer.setup();
 
     if (editor) {
-      shell.exec(`${editor} ${USER_CONFIG}`);
+      shell.exec(`${editor} ${USER_CONFIG_FILE}`);
     } else {
-      opn(USER_CONFIG);
+      opn(USER_CONFIG_FILE);
     }
   }
 
@@ -115,15 +118,20 @@ export class RunServer {
       }
     }
 
-    if (!fs.existsSync(USER_CONFIG)) {
+    if (!fs.existsSync(USER_CONFIG_FILE)) {
       const configExample =
         path.resolve(`${__dirname}/../config/user-config.example.js`);
-      shell.cp(configExample, USER_CONFIG);
+      shell.cp(configExample, USER_CONFIG_FILE);
 
       if (logger) {
-        logger.info(`Copied user configuration to:\n${chalk.bold(USER_CONFIG)}\n`);
+        logger.info(`Copied user configuration to:\n${chalk.bold(USER_CONFIG_FILE)}\n`);
       }
     }
+
+    USER_CONFIG =
+      vm.runInThisContext(
+        fs.readFileSync(USER_CONFIG_FILE).toString()
+      )(require);
   }
 
   /**
@@ -153,7 +161,7 @@ export class RunServer {
    * Start the Run Server on the provided port.
    */
   public start() {
-    (async() => {
+    (async () => {
       const app = express();
       const server = http.createServer(app);
 
@@ -199,7 +207,8 @@ export class RunServer {
             socket,
             port: this.port,
             token: this.token,
-            logger: this.logger
+            logger: this.logger,
+            userConfig: USER_CONFIG
           });
 
           exec.call();

src/models/exec-command.model.ts

@@ -26,5 +26,10 @@ export interface ExecCommandModel {
   /**
    * The Winston Logger. (https://github.com/winstonjs/winston)
    */
-  logger: Logger
+  logger: Logger,
+
+  /**
+   * User configuration based on `~/.cacher/run-server.user-config.js`.
+   */
+  userConfig: any
 }