highmark-cli 0.0.174 → 0.0.176

package/README.md

@@ -32,13 +32,31 @@ These are the commands and options:
 
 Commands:
 
-  [help]                                     Show this help
+  help                                       Show this help
   
+  version                                    Show the version
+  
+  [publish]                                  Publish the input Markdown file to the output HTML file
+
 Options:
 
   --help|-h                                  Show this help
-
+  
   --version|-v                               Show the version
+
+  --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 being 'default.md'
+
+  --copy-client-files|-c                     Copy the bundled client files next to the output file
+
+  --output-directory-path|-o                 The output directory path. The default is the current directory.
 ```
 
 ## Contact

package/bin/abbreviations.js

@@ -9,10 +9,9 @@ const { HELP_OPTION,
         VERSION_OPTION,
         QUIETLY_OPTION,
         COPY_FONTS_OPTION,
-        COPY_CLIENT_OPTION,
         INPUT_FILE_PATH_OPTION,
-        OUTPUT_FILE_PATH_OPTION,
-        TEMPLATE_FILE_PATH_OPTION } = options;
+        COPY_CLIENT_FILES_OPTION,
+        OUTPUT_DIRECTORY_PATH_OPTION } = options;
 
 const h = HELP_OPTION,
       p = PORT_OPTION,
@@ -21,10 +20,9 @@ const h = HELP_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;
+      c = COPY_CLIENT_FILES_OPTION,
+      o = OUTPUT_DIRECTORY_PATH_OPTION;
 
 module.exports = {
   h,
@@ -34,8 +32,7 @@ module.exports = {
   v,
   q,
   f,
-  c,
   i,
-  o,
-  t
+  c,
+  o
 };

package/bin/action/help.js

@@ -27,11 +27,11 @@ Options:
 
   --copy-fonts|-f                            Copy the fonts to a fonts folder next to the output file
 
-  --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 being 'index.html'
+  --copy-client-files|-c                     Copy the bundled client files next to the output file
+
+  --output-directory-path|-o                 The output directory path. The default is the current directory.
 
 Further information:
 

package/bin/action/publish.js

@@ -4,20 +4,18 @@ const htmlOperation = require("../operation/html"),
       watchOperation = require("../operation/watch"),
       serverOperation = require("../operation/server"),
       copyFontsOperation = require("../operation/copyFonts"),
-      copyClientOperation = require("../operation/copyClient"),
       markdownHTMLOperation = require("../operation/markdownHTML"),
-      copyCheckmarkOperation = require("../operation/copyCheckmark"),
+      copyClientFilesOperation = require("../operation/copyClientFiles"),
       markdownStylesCSSOperation = require("../operation/markdownStylesCSS");
 
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_PUBLISH_MESSAGE, FAILED_PUBLISH_MESSAGE } = require("../messages");
 
-function publishAction(port, watch, server, quietly, copyFonts, copyClient, inputFilePath, outputFilePath, templateFilePath) {
+function publishAction(port, watch, server, quietly, copyFonts, inputFilePath, copyClientFiles, outputDirectoryPath) {
   const operations = [
-          markdownStylesCSSOperation,
           markdownHTMLOperation,
-          copyCheckmarkOperation,
-          copyClientOperation,
+          markdownStylesCSSOperation,
+          copyClientFilesOperation,
           copyFontsOperation,
           htmlOperation,
           serverOperation,
@@ -29,10 +27,9 @@ function publishAction(port, watch, server, quietly, copyFonts, copyClient, inpu
           server,
           quietly,
           copyFonts,
-          copyClient,
           inputFilePath,
-          outputFilePath,
-          templateFilePath
+          copyClientFiles,
+          outputDirectoryPath
         };
 
   executeOperations(operations, (completed) => {

package/bin/action/server.js

@@ -6,7 +6,7 @@ const watchOperation = require("../operation/watch"),
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_SERVER_MESSAGE, FAILED_SERVER_MESSAGE } = require("../messages");
 
-function serverAction(port, watch, server, quietly, outputFilePath) {
+function serverAction(port, watch, server, quietly, outputDirectoryPath) {
   const operations = [
           serverOperation,
           watchOperation
@@ -16,7 +16,7 @@ function serverAction(port, watch, server, quietly, outputFilePath) {
           watch,
           server,
           quietly,
-          outputFilePath
+          outputDirectoryPath
         };
 
   executeOperations(operations, (completed) => {

package/bin/constants.js

@@ -3,35 +3,25 @@
 const FONT = "font",
       ERROR = "error",
       PERIOD = ".",
-      DEFER_DELAY = 100,
       EMPTY_STRING = "",
       HIGHMARK_CLI = "Highmark-CLI",
-      CLIENT_FILE_NAME = "client.js",
       LIVE_RELOAD_PATH = "/live-reload",
-      CHECKMARK_FILE_NAME = "checkmark.svg",
-      LOADING_CSS_FILE_PATH = "css/loading.css",
       CLIENT_SELECTOR_STRING = "body > div.view > div.overlay > div",
       RAW_HTML_SELECTOR_STRING = "body > div",
+      INDEX_TEMPLATE_FILE_PATH = "template/index.html",
       CLIENT_TEMPLATE_FILE_PATH = "template/client.html",
-      DEFAULT_TEMPLATE_FILE_PATH = "template/default.html",
-      LOADING_TEMPLATE_FILE_PATH = "template/loading.html",
       DEFAULT_DIVISION_IDENTIFIER = "default";
 
 module.exports = {
   FONT,
   ERROR,
   PERIOD,
-  DEFER_DELAY,
   EMPTY_STRING,
   HIGHMARK_CLI,
-  CLIENT_FILE_NAME,
   LIVE_RELOAD_PATH,
-  CHECKMARK_FILE_NAME,
-  LOADING_CSS_FILE_PATH,
   CLIENT_SELECTOR_STRING,
   RAW_HTML_SELECTOR_STRING,
+  INDEX_TEMPLATE_FILE_PATH,
   CLIENT_TEMPLATE_FILE_PATH,
-  DEFAULT_TEMPLATE_FILE_PATH,
-  LOADING_TEMPLATE_FILE_PATH,
   DEFAULT_DIVISION_IDENTIFIER
 };

package/bin/defaults.js

@@ -5,10 +5,9 @@ const DEFAULT_PORT = 8888,
       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;
+      DEFAULT_COPY_CLIENT_FILES = false,
+      DEFAULT_OUTPUT_DIRECTORY_PATH = ".";
 
 module.exports = {
   DEFAULT_PORT,
@@ -16,8 +15,7 @@ module.exports = {
   DEFAULT_SERVER,
   DEFAULT_QUIETLY,
   DEFAULT_COPY_FONTS,
-  DEFAULT_COPY_CLIENT,
   DEFAULT_INPUT_FILE_PATH,
-  DEFAULT_OUTPUT_FILE_PATH,
-  DEFAULT_TEMPLATE_FILE_PATH
+  DEFAULT_COPY_CLIENT_FILES,
+  DEFAULT_OUTPUT_DIRECTORY_PATH
 };

package/bin/main.js

@@ -6,16 +6,15 @@ const helpAction = require("./action/help"),
       publishAction = require("./action/publish");
 
 const { HELP_OPTION, SERVER_OPTION, VERSION_OPTION } = require("./options"),
-      { HELP_COMMAND, SERVER_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND } = require("./commands"),
+      { HELP_COMMAND, SERVER_COMMAND, VERSION_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");
+        DEFAULT_COPY_CLIENT_FILES,
+        DEFAULT_OUTPUT_DIRECTORY_PATH } = require("./defaults");
 
 function main(command, argument, options) {
   const commandMissing = (command === null),
@@ -27,10 +26,9 @@ function main(command, argument, options) {
           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;
+          copyClientFiles = DEFAULT_COPY_CLIENT_FILES,
+          outputDirectoryPath = DEFAULT_OUTPUT_DIRECTORY_PATH } = options;
 
   if (false) {
     ///
@@ -56,7 +54,7 @@ function main(command, argument, options) {
     case SERVER_COMMAND: {
       const server = true;
 
-      serverAction(port, watch, server, quietly, outputFilePath);
+      serverAction(port, watch, server, quietly, outputDirectoryPath);
 
       break;
     }
@@ -68,7 +66,7 @@ function main(command, argument, options) {
     }
 
     default: {
-      publishAction(port, watch, server, quietly, copyFonts, copyClient, inputFilePath, outputFilePath, templateFilePath);
+      publishAction(port, watch, server, quietly, copyFonts, inputFilePath, copyClientFiles, outputDirectoryPath);
 
       break;
     }

package/bin/operation/copyClientFiles.js

@@ -0,0 +1,19 @@
+"use strict";
+
+const { copyClientFiles: copyClientFilesAsync } = require("highmark-client");
+
+function copyClientFilesOperation(proceed, abort, context) {
+  const { copyClientFiles } = context;
+
+  if (copyClientFiles) {
+    const { markdownHTML, markdownStylesCSS, outputDirectoryPath } = context,
+          targetDirectoryPath = outputDirectoryPath, ///
+          includeFonts = false;
+
+    copyClientFilesAsync(markdownHTML, markdownStylesCSS, targetDirectoryPath, includeFonts);
+  }
+
+  proceed();
+}
+
+module.exports = copyClientFilesOperation;

package/bin/operation/copyFonts.js

@@ -1,11 +1,9 @@
 "use strict";
 
 const { pathUtilities } = require("necessary"),
-      { getFontDirectoryPath } = require("highmark-fonts");
+      { copyFonts: copyFontsAsync } = require("highmark-client");
 
-const { FONT } = require("../constants"),
-      { copyFile, readDirectory, createDirectory } = require("../utilities/fileSystem"),
-      { fileNameFromFilePath, directoryPathFromFilePath } = require("../utilities/path");
+const { FONT } = require("../constants");
 
 const { concatenatePaths } = pathUtilities;
 
@@ -18,27 +16,10 @@ function copyFontsOperation(proceed, abort, context) {
     return;
   }
 
-  let fontDirectoryPath;
+  const { outputDirectoryPath } = context,
+        fontDirectoryPath = concatenatePaths(outputDirectoryPath, FONT);
 
-  const { outputFilePath } = context,
-        outputDirectoryPath = directoryPathFromFilePath(outputFilePath);
-
-  fontDirectoryPath = concatenatePaths(outputDirectoryPath, FONT);
-
-  createDirectory(fontDirectoryPath);
-
-  fontDirectoryPath = getFontDirectoryPath();
-
-  const recursive = false,
-        targetDirectoryPath = concatenatePaths(outputDirectoryPath, FONT);
-
-  readDirectory(fontDirectoryPath, (filePath) => {
-    const fileName = fileNameFromFilePath(filePath),
-          sourceFilePath = filePath,  ///
-          targetFilePath = concatenatePaths(targetDirectoryPath, fileName); ///
-
-    copyFile(sourceFilePath, targetFilePath);
-  }, recursive);
+  copyFontsAsync(fontDirectoryPath);
 
   proceed();
 }

package/bin/operation/html.js

@@ -1,27 +1,19 @@
 "use strict";
 
-const { liveReloadSnippet } = require("lively-cli"),
-      { pathUtilities, packageUtilities } = require("necessary"),
+const { pathUtilities, packageUtilities } = require("necessary"),
       { computerModernStyle: computerModernStyleCSS } = require("highmark-fonts");
 
-const { readFile } = require("../utilities/fileSystem"),
-      { directoryPathFromFilePath } = require("../utilities/path"),
+const { directoryPathFromFilePath } = require("../utilities/path"),
       { writeFile, parseTemplateFile } = require("../utilities/fileSystem"),
-      { EMPTY_STRING, LOADING_CSS_FILE_PATH, CLIENT_TEMPLATE_FILE_PATH, DEFAULT_TEMPLATE_FILE_PATH, LOADING_TEMPLATE_FILE_PATH } = require("../constants");
+      { INDEX_TEMPLATE_FILE_PATH } = require("../constants");
 
 const { getPackagePath } = packageUtilities,
       { concatenatePaths } = pathUtilities;
 
 function htmlOperation(proceed, abort, context) {
   const { markdownHTML, outputFilePath, markdownStylesCSS } = context,
-        clientHTML = getClientHTML(context),
-        loadingCSS = getLoadingCSS(context),
-        loadingHTML = getLoadingHTML(context),
         templateFilePath = getTemplateFilePath(context),
         args = {
-          clientHTML,
-          loadingCSS,
-          loadingHTML,
           markdownHTML,
           markdownStylesCSS,
           computerModernStyleCSS
@@ -35,64 +27,6 @@ function htmlOperation(proceed, abort, context) {
 
 module.exports = htmlOperation;
 
-function getClientHTML(context) {
-  let clientHTML;
-
-  const { copyClient } = context;
-
-  if (copyClient) {
-    const packagePath = getPackagePath(),
-          templateFilePath = concatenatePaths(packagePath, CLIENT_TEMPLATE_FILE_PATH),
-          args = {
-            liveReloadSnippet
-          },
-          content = parseTemplateFile(templateFilePath, args);
-
-    clientHTML = content; ///
-  } else {
-    clientHTML = EMPTY_STRING;
-  }
-
-  return clientHTML;
-}
-
-function getLoadingCSS(context) {
-  let loadingCSS;
-
-  const { copyClient } = context;
-
-  if (copyClient) {
-    const packagePath = getPackagePath(),
-          filePath = concatenatePaths(packagePath, LOADING_CSS_FILE_PATH),
-          content = readFile(filePath);
-
-    loadingCSS = content; ///
-  } else {
-    loadingCSS = EMPTY_STRING;
-  }
-
-  return loadingCSS;
-}
-
-function getLoadingHTML(context) {
-  let loadingHTML;
-
-  const { copyClient } = context;
-
-  if (copyClient) {
-    const packagePath = getPackagePath(),
-          templateFilePath = concatenatePaths(packagePath, LOADING_TEMPLATE_FILE_PATH),
-          args = {},
-          content = parseTemplateFile(templateFilePath, args);
-
-    loadingHTML = content; ///
-  } else {
-    loadingHTML = EMPTY_STRING;
-  }
-
-  return loadingHTML;
-}
-
 function getTemplateFilePath(context) {
   let templateFilePath;
 
@@ -100,9 +34,9 @@ function getTemplateFilePath(context) {
 
   if (templateFilePath === null) {
     const packagePath = getPackagePath(),
-          defaultTemplateFilePath = templateFilePath = concatenatePaths(packagePath, DEFAULT_TEMPLATE_FILE_PATH);
+          indexTemplateFilePath = concatenatePaths(packagePath, INDEX_TEMPLATE_FILE_PATH);
 
-    templateFilePath = defaultTemplateFilePath; ///
+    templateFilePath = indexTemplateFilePath; ///
   } else {
     const { inputFilePath } = context,
           inputDirectoryPath = directoryPathFromFilePath(inputFilePath);

package/bin/operation/server.js

@@ -3,7 +3,6 @@
 const express = require("express");
 
 const { ERROR } = require("../constants"),
-      { directoryPathFromFilePath } = require("../utilities/path"),
       { UNABLE_TO_START_SERVER_MESSAGE } = require("../messages");
 
 function serverOperation(proceed, abort, context) {
@@ -21,8 +20,7 @@ function serverOperation(proceed, abort, context) {
     server
   });
 
-  const { port, outputFilePath } = context,
-        outputDirectoryPath = directoryPathFromFilePath(outputFilePath),
+  const { port, outputDirectoryPath } = context,
         staticRouter = express.static(outputDirectoryPath);
 
   server.use(staticRouter);

package/bin/operation/watch.js

@@ -2,8 +2,7 @@
 
 const { createLiveReloadHandler } = require("lively-cli");
 
-const { LIVE_RELOAD_PATH } = require("../constants"),
-      { directoryPathFromFilePath } = require("../utilities/path");
+const { LIVE_RELOAD_PATH } = require("../constants");
 
 function watchOperation(proceed, abort, context) {
   const { watch } = context;
@@ -22,8 +21,7 @@ function watchOperation(proceed, abort, context) {
     return;
   }
 
-  const { quietly, outputFilePath } = context,
-        outputDirectoryPath = directoryPathFromFilePath(outputFilePath),
+  const { quietly, outputDirectoryPath } = context,
         watchPattern = outputDirectoryPath, ///
         liveReloadHandler = createLiveReloadHandler(watchPattern, quietly);
 

package/bin/options.js

@@ -7,10 +7,9 @@ const HELP_OPTION = "help",
       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 = "output-file-path";
+      COPY_CLIENT_FILES_OPTION = "copy-client-files",
+      OUTPUT_DIRECTORY_PATH_OPTION = "output-directory-path";
 
 module.exports = {
   HELP_OPTION,
@@ -20,8 +19,7 @@ module.exports = {
   VERSION_OPTION,
   QUIETLY_OPTION,
   COPY_FONTS_OPTION,
-  COPY_CLIENT_OPTION,
   INPUT_FILE_PATH_OPTION,
-  OUTPUT_FILE_PATH_OPTION,
-  TEMPLATE_FILE_PATH_OPTION
+  COPY_CLIENT_FILES_OPTION,
+  OUTPUT_DIRECTORY_PATH_OPTION
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "highmark-cli",
   "author": "James Smith",
-  "version": "0.0.174",
+  "version": "0.0.176",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/highmark-cli",
   "description": "Extensible, styleable Markdown.",
@@ -12,37 +12,13 @@
   "dependencies": {
     "argumentative": "^2.0.28",
     "express": "^4.19.2",
+    "highmark-client": "^0.0.10",
     "highmark-fonts": "^1.0.43",
     "highmark-markdown": "^0.0.245",
     "lively-cli": "^2.0.59",
     "necessary": "^13.6.6",
     "occam-entities": "^1.0.95"
   },
-  "devDependencies": {
-    "@swc/core": "^1.5.6",
-    "easy": "^17.1.3",
-    "easy-layout": "^6.0.153",
-    "easy-mobile": "^1.0.20",
-    "easy-with-style": "^3.0.356",
-    "esbuild": "^0.9.2",
-    "fragmented": "^3.1.7",
-    "juxtapose": "^4.0.85",
-    "sufficient": "^2.0.56",
-    "watchful-cli": "^1.7.44"
-  },
-  "scripts": {
-    "start": "node ./bin/main.js",
-    "clean": "rm -rf ./lib",
-    "watchful": "watchful -m --transpiler=swc --bundler=esbuild --source-directory=./src --lib-directory=./lib --entry-file=client.js --bundle-file=./client.js --wait=100",
-    "batch": "npm run watchful batch --",
-    "batch-debug": "npm run watchful batch -- --debug",
-    "incremental": "npm run watchful incremental --",
-    "incremental-debug": "npm run watchful incremental -- --debug",
-    "build": "npm run clean && npm run batch",
-    "build-debug": "npm run clean && npm run batch-debug",
-    "watch": "npm run clean && npm run batch && npm run incremental",
-    "watch-debug": "npm run clean && npm run batch-debug && npm run incremental-debug"
-  },
   "bin": {
     "highmark": "./highmark.js"
   }

package/.swcrc

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

package/bin/operation/copyCheckmark.js

@@ -1,32 +0,0 @@
-"use strict";
-
-const { pathUtilities, packageUtilities } = require("necessary");
-
-const { copyFile } = require("../utilities/fileSystem"),
-      { CHECKMARK_FILE_NAME } = require("../constants"),
-      { directoryPathFromFilePath } = require("../utilities/path");
-
-const { getPackagePath } = packageUtilities,
-      { concatenatePaths } = pathUtilities;
-
-function copyCheckmarkOperation(proceed, abort, context) {
-  const { copyClient } = context;
-
-  if (!copyClient) {
-    proceed();
-
-    return;
-  }
-
-  const { outputFilePath } = context,
-        packagePath = getPackagePath(),
-        outputDirectoryPath = directoryPathFromFilePath(outputFilePath),
-        sourceFilePath = concatenatePaths(packagePath, CHECKMARK_FILE_NAME),  ///
-        targetFilePath = concatenatePaths(outputDirectoryPath, CHECKMARK_FILE_NAME);  ///
-
-  copyFile(sourceFilePath, targetFilePath);
-
-  proceed();
-}
-
-module.exports = copyCheckmarkOperation;

package/bin/operation/copyClient.js

@@ -1,51 +0,0 @@
-"use strict";
-
-const { watch: watchFile } = require("lively-cli");
-
-const { DEFER_DELAY } = require("../constants"),
-      { copyClientFile: copyClientFileEx, getClientSourceFilePath } = require("../utilities/client");
-
-function copyClientOperation(proceed, abort, context) {
-  const { copyClient } = context;
-
-  if (!copyClient) {
-    proceed();
-
-    return;
-  }
-
-  copyClientFile();
-
-  let { server } = context;
-
-  if (!server) {
-    proceed();
-
-    return;
-  }
-
-  const { quietly } = context,
-        clientSSourceFilePath = getClientSourceFilePath(context),
-        watchPattern = clientSSourceFilePath,  ///
-        registerHandler = watchFile(watchPattern, quietly);
-
-  registerHandler(copyClientFile);
-
-  proceed();
-
-  function copyClientFile() {
-    copyClientFileEx(context);
-
-    defer(() => {
-      registerHandler(copyClientFile);
-    });
-  }
-}
-
-module.exports = copyClientOperation;
-
-function defer(func) {
-  const delay = DEFER_DELAY;
-
-  setTimeout(func, delay);
-}