highmark-cli 0.0.124 → 0.0.127

package/.swcrc

@@ -0,0 +1,11 @@
+{
+    "jsc": {
+        "parser": {
+            "syntax": "ecmascript",
+            "jsx": true
+        }
+    },
+    "module": {
+        "type": "commonjs"
+    }
+}

package/bin/abbreviations.js

@@ -4,18 +4,24 @@ const options = require("./options");
 
 const { HELP_OPTION,
         PORT_OPTION,
+        WATCH_OPTION,
         SERVER_OPTION,
         VERSION_OPTION,
+        QUIETLY_OPTION,
         COPY_FONTS_OPTION,
+        COPY_CLIENT_OPTION,
         INPUT_FILE_PATH_OPTION,
         OUTPUT_FILE_PATH_OPTION,
         TEMPLATE_FILE_PATH_OPTION } = options;
 
 const h = HELP_OPTION,
       p = PORT_OPTION,
+      w = WATCH_OPTION,
       s = SERVER_OPTION,
       v = VERSION_OPTION,
+      q = QUIETLY_OPTION,
       f = COPY_FONTS_OPTION,
+      c = COPY_CLIENT_OPTION,
       i = INPUT_FILE_PATH_OPTION,
       o = OUTPUT_FILE_PATH_OPTION,
       t = TEMPLATE_FILE_PATH_OPTION;
@@ -23,9 +29,12 @@ const h = HELP_OPTION,
 module.exports = {
   h,
   p,
+  w,
   s,
   v,
+  q,
   f,
+  c,
   i,
   o,
   t

package/bin/action/help.js

@@ -11,7 +11,7 @@ Commands:
   
   version                                    Show the version
   
-  [publish]                                  Publish the input Markdown file to the output HTML file.
+  [publish]                                  Publish the input Markdown file to the output HTML file
 
 Options:
 
@@ -19,15 +19,19 @@ Options:
   
   --version|-v                               Show the version
 
-  --port|-p                                  The server port. The default is 8888.
+  --port|-p                                  The server port, the default being 8888
+
+  --watch|-w                                 Watch for changes to the client file and in the output directory 
 
   --server|-s                                Start a server to view the output file
 
   --copy-fonts|-f                            Copy the fonts to a fonts folder next to the output file
 
-  --input-file-path|-i                       The input file path. The default is 'default.md'.
+  --copy-client|-c                           Copy the bundled client file next to the output file
+
+  --input-file-path|-i                       The input file path, the default being 'default.md'
 
-  --output-file-path|-o                      The output file path. The default is 'index.html'.
+  --output-file-path|-o                      The output file path, the default being 'index.html'
 
 Further information:
 

package/bin/action/publish.js

@@ -3,24 +3,29 @@
 const htmlOperation = require("../operation/html"),
       serverOperation = require("../operation/server"),
       copyFontsOperation = require("../operation/copyFonts"),
+      copyClientOperation = require("../operation/copyClient"),
       markdownHTMLOperation = require("../operation/markdownHTML"),
       markdownStylesCSSOperation = require("../operation/markdownStylesCSS");
 
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_PUBLISH_MESSAGE, FAILED_PUBLISH_MESSAGE } = require("../messages");
 
-function publishAction(port, server, copyFonts, inputFilePath, outputFilePath, templateFilePath) {
+function publishAction(port, watch, server, quietly, copyFonts, copyClient, inputFilePath, outputFilePath, templateFilePath) {
   const operations = [
           markdownStylesCSSOperation,
           markdownHTMLOperation,
+          copyClientOperation,
           copyFontsOperation,
           htmlOperation,
           serverOperation
         ],
         context = {
           port,
+          watch,
           server,
+          quietly,
           copyFonts,
+          copyClient,
           inputFilePath,
           outputFilePath,
           templateFilePath

package/bin/action/server.js

@@ -5,13 +5,15 @@ const serverOperation = require("../operation/server");
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_SERVER_MESSAGE, FAILED_SERVER_MESSAGE } = require("../messages");
 
-function serverAction(port, server, outputFilePath) {
+function serverAction(port, watch, server, quietly, outputFilePath) {
   const operations = [
           serverOperation
         ],
         context = {
           port,
+          watch,
           server,
+          quietly,
           outputFilePath
         };
 

package/bin/constants.js

@@ -3,19 +3,27 @@
 const FONT = "font",
       ERROR = "error",
       PERIOD = ".",
+      DEFER_DELAY = 100,
       EMPTY_STRING = "",
       HIGHMARK_CLI = "Highmark-CLI",
-      TEMPLATE_FILE_PATH = "template/default.html",
+      CLIENT_FILE_NAME = "client.js",
+      LIVE_RELOAD_PATH = "/live-reload",
       DEFAULT_SELECTOR_STRING = "div",
+      CLIENT_TEMPLATE_FILE_PATH = "template/client.html",
+      DEFAULT_TEMPLATE_FILE_PATH = "template/default.html",
       DEFAULT_DIVISION_IDENTIFIER = "default";
 
 module.exports = {
   FONT,
   ERROR,
   PERIOD,
+  DEFER_DELAY,
   EMPTY_STRING,
   HIGHMARK_CLI,
-  TEMPLATE_FILE_PATH,
+  CLIENT_FILE_NAME,
+  LIVE_RELOAD_PATH,
   DEFAULT_SELECTOR_STRING,
+  CLIENT_TEMPLATE_FILE_PATH,
+  DEFAULT_TEMPLATE_FILE_PATH,
   DEFAULT_DIVISION_IDENTIFIER
 };

package/bin/defaults.js

@@ -1,16 +1,22 @@
 "use strict";
 
 const DEFAULT_PORT = 8888,
+      DEFAULT_WATCH = false,
       DEFAULT_SERVER = false,
+      DEFAULT_QUIETLY = false,
       DEFAULT_COPY_FONTS = false,
+      DEFAULT_COPY_CLIENT = false,
       DEFAULT_INPUT_FILE_PATH = "default.md",
       DEFAULT_OUTPUT_FILE_PATH = "index.html",
       DEFAULT_TEMPLATE_FILE_PATH = null;
 
 module.exports = {
   DEFAULT_PORT,
+  DEFAULT_WATCH,
   DEFAULT_SERVER,
+  DEFAULT_QUIETLY,
   DEFAULT_COPY_FONTS,
+  DEFAULT_COPY_CLIENT,
   DEFAULT_INPUT_FILE_PATH,
   DEFAULT_OUTPUT_FILE_PATH,
   DEFAULT_TEMPLATE_FILE_PATH

package/bin/main.js

@@ -5,11 +5,14 @@ const helpAction = require("./action/help"),
       versionAction = require("./action/version"),
       publishAction = require("./action/publish");
 
-const { HELP_COMMAND, SERVER_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND } = require("./commands"),
-      { HELP_OPTION, SERVER_OPTION, VERSION_OPTION, TEMPLATE_FILE_PATH_OPTION } = require("./options"),
+const { HELP_OPTION, SERVER_OPTION, VERSION_OPTION } = require("./options"),
+      { HELP_COMMAND, SERVER_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND } = require("./commands"),
       { DEFAULT_PORT,
+        DEFAULT_WATCH,
         DEFAULT_SERVER,
+        DEFAULT_QUIETLY,
         DEFAULT_COPY_FONTS,
+        DEFAULT_COPY_CLIENT,
         DEFAULT_INPUT_FILE_PATH,
         DEFAULT_OUTPUT_FILE_PATH,
         DEFAULT_TEMPLATE_FILE_PATH } = require("./defaults");
@@ -20,8 +23,11 @@ function main(command, argument, options) {
         serverOptionPresent = options.hasOwnProperty(SERVER_OPTION),
         versionOptionPresent = options.hasOwnProperty(VERSION_OPTION),
         { port = DEFAULT_PORT,
+          watch = DEFAULT_WATCH,
           server = DEFAULT_SERVER,
+          quietly = DEFAULT_QUIETLY,
           copyFonts = DEFAULT_COPY_FONTS,
+          copyClient = DEFAULT_COPY_CLIENT,
           inputFilePath = DEFAULT_INPUT_FILE_PATH,
           outputFilePath = DEFAULT_OUTPUT_FILE_PATH,
           templateFilePath = DEFAULT_TEMPLATE_FILE_PATH } = options;
@@ -42,12 +48,12 @@ function main(command, argument, options) {
 
   switch (command) {
     case HELP_COMMAND: helpAction(); break;
-    case SERVER_COMMAND: serverAction(port, server, outputFilePath); break;
+    case SERVER_COMMAND: serverAction(port, watch, server, quietly, outputFilePath); break;
     case VERSION_COMMAND: versionAction(); break;
-    case PUBLISH_COMMAND: publishAction(port, server, copyFonts, inputFilePath, outputFilePath, templateFilePath); break;
+    case PUBLISH_COMMAND: publishAction(port, watch, server, quietly, copyFonts, copyClient, inputFilePath, outputFilePath, templateFilePath); break;
 
     default :
-      publishAction(port, server, copyFonts, inputFilePath, outputFilePath, templateFilePath);
+      publishAction(port, watch, server, quietly, copyFonts, copyClient, inputFilePath, outputFilePath, templateFilePath);
 
       break;
   }

package/bin/operation/copyClient.js

@@ -0,0 +1,60 @@
+"use strict";
+
+const { watch: watchFile } = require("lively-cli"),
+      { pathUtilities, packageUtilities } = require("necessary");
+
+const { copyFile } = require("../utilities/fileSystem"),
+      { directoryPathFromFilePath } = require("../utilities/path"),
+      { DEFER_DELAY, CLIENT_FILE_NAME } = require("../constants");
+
+const { getPackagePath } = packageUtilities,
+      { concatenatePaths } = pathUtilities;
+
+function copyClientOperation(proceed, abort, context) {
+  const { copyClient } = context;
+
+  if (!copyClient) {
+    proceed();
+
+    return;
+  }
+
+  const { outputFilePath } = context,
+        packagePath = getPackagePath(),
+        outputDirectoryPath = directoryPathFromFilePath(outputFilePath),
+        sourceClientFilePath = concatenatePaths(packagePath, CLIENT_FILE_NAME),
+        targetClientFilePath = concatenatePaths(outputDirectoryPath, CLIENT_FILE_NAME);
+
+  copyFile(sourceClientFilePath, targetClientFilePath);
+
+  const { watch } = context;
+
+  if (!watch) {
+    proceed();
+
+    return;
+  }
+
+  const watchPattern = sourceClientFilePath,  ///
+        registerHandler = watchFile(watchPattern);
+
+  registerHandler(copyClientFile);
+
+  proceed();
+
+  function copyClientFile() {
+    copyFile(sourceClientFilePath, targetClientFilePath);
+
+    defer(() => {
+      registerHandler(copyClientFile);
+    });
+  }
+}
+
+module.exports = copyClientOperation;
+
+function defer(func) {
+  const delay = DEFER_DELAY;
+
+  setTimeout(func, delay);
+}

package/bin/operation/html.js

@@ -1,21 +1,22 @@
 "use strict";
 
-const { pathUtilities, packageUtilities } = require("necessary"),
+const { liveReloadSnippet } = require("lively-cli"),
+      { pathUtilities, packageUtilities } = require("necessary"),
       { computerModernStyle: computerModernStyleCSS } = require("highmark-fonts");
 
 const { directoryPathFromFilePath } = require("../utilities/path"),
       { writeFile, parseTemplateFile } = require("../utilities/fileSystem"),
-      { EMPTY_STRING, TEMPLATE_FILE_PATH } = require("../constants");
+      { CLIENT_TEMPLATE_FILE_PATH, DEFAULT_TEMPLATE_FILE_PATH, EMPTY_STRING } = require("../constants");
 
 const { getPackagePath } = packageUtilities,
       { concatenatePaths } = pathUtilities;
 
 function htmlOperation(proceed, abort, context) {
-  const { title, markdownHTML, outputFilePath, markdownStylesCSS } = context,
-        titleHTML = titleHTMLFromTitle(title),
+  const { markdownHTML, outputFilePath, markdownStylesCSS } = context,
+        clientHTML = getClientHTML(context),
         templateFilePath = getTemplateFilePath(context),
         args = {
-          titleHTML,
+          clientHTML,
           markdownHTML,
           markdownStylesCSS,
           computerModernStyleCSS
@@ -29,12 +30,25 @@ function htmlOperation(proceed, abort, context) {
 
 module.exports = htmlOperation;
 
-function titleHTMLFromTitle(title) {
-  const titleHTML = (title === null) ?
-                      EMPTY_STRING :
-                        `<title>${title}</title>`;
+function getClientHTML(context) {
+  let clientHTML;
 
-  return titleHTML;
+  const { copyClient } = context;
+
+  if (copyClient) {
+    const packagePath = getPackagePath(),
+          clientTemplateFilePath = concatenatePaths(packagePath, CLIENT_TEMPLATE_FILE_PATH),
+          args = {
+            liveReloadSnippet
+          },
+          clientContent = parseTemplateFile(clientTemplateFilePath, args);
+
+    clientHTML = clientContent; ///
+  } else {
+    clientHTML = EMPTY_STRING;
+  }
+
+  return clientHTML;
 }
 
 function getTemplateFilePath(context) {
@@ -43,9 +57,10 @@ function getTemplateFilePath(context) {
   ({templateFilePath} = context);
 
   if (templateFilePath === null) {
-    const packagePath = getPackagePath();
+    const packagePath = getPackagePath(),
+          defaultTemplateFilePath = templateFilePath = concatenatePaths(packagePath, DEFAULT_TEMPLATE_FILE_PATH);
 
-    templateFilePath = concatenatePaths(packagePath, TEMPLATE_FILE_PATH);
+    templateFilePath = defaultTemplateFilePath; ///
   } else {
     const { inputFilePath } = context,
           inputDirectoryPath = directoryPathFromFilePath(inputFilePath);

package/bin/operation/server.js

@@ -4,8 +4,7 @@ const express = require("express");
 
 const { createLiveReloadHandler } = require("lively-cli");
 
-const { ERROR } = require("../constants"),
-      { LIVE_RELOAD_PATH } = require("../paths"),
+const { ERROR, LIVE_RELOAD_PATH } = require("../constants"),
       { directoryPathFromFilePath } = require("../utilities/path"),
       { UNABLE_TO_START_SERVER_MESSAGE } = require("../messages");
 
@@ -18,17 +17,20 @@ function serverOperation(proceed, abort, context) {
     return;
   }
 
-  const { port, outputFilePath } = context,
+  const { port, watch, quietly, outputFilePath } = context,
         outputDirectoryPath = directoryPathFromFilePath(outputFilePath),
-        watchPattern = `./${outputFilePath}`,
-        staticRouter = express.static(outputDirectoryPath),
-        liveReloadHandler = createLiveReloadHandler(watchPattern);
+        staticRouter = express.static(outputDirectoryPath);
 
   server = express(); ///
 
   server.use(staticRouter);
 
-  server.get(LIVE_RELOAD_PATH, liveReloadHandler);
+  if (watch) {
+    const watchPattern = outputDirectoryPath, ///
+          liveReloadHandler = createLiveReloadHandler(watchPattern, quietly);
+
+    server.get(LIVE_RELOAD_PATH, liveReloadHandler);
+  }
 
   const listener = server.listen(port, () => {
     console.log(`Server listening on port ${port}...`);

package/bin/options.js

@@ -2,19 +2,25 @@
 
 const HELP_OPTION = "help",
       PORT_OPTION = "port",
+      WATCH_OPTION = "watch",
       SERVER_OPTION = "server",
       VERSION_OPTION = "version",
+      QUIETLY_OPTION = "quietly",
       COPY_FONTS_OPTION = "copy-fonts",
+      COPY_CLIENT_OPTION = "copy-client",
       INPUT_FILE_PATH_OPTION = "input-file-path",
       OUTPUT_FILE_PATH_OPTION = "output-file-path",
-      TEMPLATE_FILE_PATH_OPTION = "template-file-path";
+      TEMPLATE_FILE_PATH_OPTION = "output-file-path";
 
 module.exports = {
   HELP_OPTION,
   PORT_OPTION,
+  WATCH_OPTION,
   SERVER_OPTION,
   VERSION_OPTION,
+  QUIETLY_OPTION,
   COPY_FONTS_OPTION,
+  COPY_CLIENT_OPTION,
   INPUT_FILE_PATH_OPTION,
   OUTPUT_FILE_PATH_OPTION,
   TEMPLATE_FILE_PATH_OPTION