highmark-cli 1.3.14 → 1.3.16

package/README.md

@@ -75,19 +75,17 @@ Options:
 
   --port|-p                                  The server port, the default being 8888
 
+  --fonts|-f                                 Copy the fonts to a fonts folder next to the output file
+
   --watch|-w                                 Watch for changes to the client file and in the output directory 
 
+  --client|-c                                Copy the bundled client and supporting files next to the output file
+
   --server|-s                                Run a server to view the output file
 
   --quietly|-q                               Run with almost no console logging
 
-  --no-client|-n                             Do not include references to the client files in the output file
-
-  --copy-fonts|-f                            Copy the fonts to a fonts folder next to the output file
-
   --input-file-name|-i                       The input file name, the default being 'default.md'
-
-  --copy-client-files|-c                     Copy the client files next to the output file
 ```
 
 ## Contact

package/bin/abbreviations.js

@@ -4,35 +4,32 @@ const options = require("./options");
 
 const { HELP_OPTION,
         PORT_OPTION,
+        FONTS_OPTION,
         WATCH_OPTION,
+        CLIENT_OPTION,
         SERVER_OPTION,
         VERSION_OPTION,
         QUIETLY_OPTION,
-        NO_CLIENT_OPTION,
-        COPY_FONTS_OPTION,
-        INPUT_FILE_NAME_OPTION,
-        COPY_CLIENT_FILES_OPTION } = options;
+        INPUT_FILE_NAME_OPTION, } = options;
 
 const h = HELP_OPTION,
       p = PORT_OPTION,
+      f = FONTS_OPTION,
       w = WATCH_OPTION,
+      c = CLIENT_OPTION,
       s = SERVER_OPTION,
       v = VERSION_OPTION,
       q = QUIETLY_OPTION,
-      n = NO_CLIENT_OPTION,
-      f = COPY_FONTS_OPTION,
-      i = INPUT_FILE_NAME_OPTION,
-      c = COPY_CLIENT_FILES_OPTION;
+      i = INPUT_FILE_NAME_OPTION;
 
 module.exports = {
   h,
   p,
+  f,
   w,
   v,
   q,
-  n,
-  f,
+  c,
   s,
-  i,
-  c
+  i
 };

package/bin/action/help.js

@@ -27,20 +27,18 @@ Options:
 
   --port|-p                                  The server port, the default being 8888
 
+  --fonts|-f                                 Copy the fonts to a fonts folder next to the output file
+
   --watch|-w                                 Watch for changes to the client file and in the output directory 
 
+  --client|-c                                Copy the bundled client and supporting files next to the output file
+
   --server|-s                                Run a server to view the output file
 
   --quietly|-q                               Run with almost no console logging
 
-  --no-client|-n                             Do not include references to the client files in the output file
-
-  --copy-fonts|-f                            Copy the fonts to a fonts folder next to the output file
-
   --input-file-name|-i                       The input file name, the default being 'default.md'
 
-  --copy-client-files|-c                     Copy the client files next to the output file
-
 Further information:
 
 Please see the readme file on GitHub:

package/bin/action/publish.js

@@ -11,7 +11,7 @@ const indexOptions = require("../indexOptions"),
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_PUBLISH_MESSAGE, FAILED_PUBLISH_MESSAGE } = require("../messages");
 
-function publishAction(port, watch, quietly, noClient, copyFonts, inputFileName, copyClientFiles, projectDirectoryName) {
+function publishAction(port, fonts, watch, client, quietly, inputFileName, projectDirectoryName) {
   const operations = [
           markdownHTMLOperation,
           markdownStylesCSSOperation,
@@ -22,13 +22,12 @@ function publishAction(port, watch, quietly, noClient, copyFonts, inputFileName,
         ],
         context = {
           port,
+          fonts,
           watch,
+          client,
           quietly,
-          noClient,
-          copyFonts,
           indexOptions,
           inputFileName,
-          copyClientFiles,
           projectDirectoryName
         };
 

package/bin/defaults.js

@@ -2,30 +2,28 @@
 
 const DEFAULT_HELP = false,
       DEFAULT_PORT = 8888,
+      DEFAULT_FONTS = false,
       DEFAULT_WATCH = false,
+      DEFAULT_CLIENT = true,
       DEFAULT_SERVER = false,
       DEFAULT_QUIETLY = false,
       DEFAULT_VERSION = false,
-      DEFAULT_NO_CLIENT = false,
-      DEFAULT_COPY_FONTS = false,
       DEFAULT_LINES_PER_PAGE = Infinity,
       DEFAULT_CONTENTS_DEPTH = 2,
       DEFAULT_INPUT_FILE_NAME = "default.md",
-      DEFAULT_COPY_CLIENT_FILES = false,
       DEFAULT_CHARACTERS_PER_LINE = 75;
 
 module.exports = {
   DEFAULT_HELP,
   DEFAULT_PORT,
+  DEFAULT_FONTS,
   DEFAULT_WATCH,
+  DEFAULT_CLIENT,
   DEFAULT_SERVER,
   DEFAULT_QUIETLY,
   DEFAULT_VERSION,
-  DEFAULT_NO_CLIENT,
-  DEFAULT_COPY_FONTS,
   DEFAULT_LINES_PER_PAGE,
   DEFAULT_CONTENTS_DEPTH,
   DEFAULT_INPUT_FILE_NAME,
-  DEFAULT_COPY_CLIENT_FILES,
   DEFAULT_CHARACTERS_PER_LINE
 };

package/bin/main.js

@@ -10,21 +10,19 @@ const helpAction = require("./action/help"),
 const { NO_COMMAND_GIVEN_MESSAGE, COMMAND_NOT_RECOGNISED_MESSAGE } = require("./messages"),
       { HELP_COMMAND, SERVER_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND, INITIALISE_COMMAND, SET_OPTIONS_COMMAND } = require("./commands"),
       { DEFAULT_PORT,
+        DEFAULT_FONTS,
         DEFAULT_WATCH,
+        DEFAULT_CLIENT,
         DEFAULT_QUIETLY,
-        DEFAULT_NO_CLIENT,
-        DEFAULT_COPY_FONTS,
-        DEFAULT_INPUT_FILE_NAME,
-        DEFAULT_COPY_CLIENT_FILES } = require("./defaults");
+        DEFAULT_INPUT_FILE_NAME } = require("./defaults");
 
 function main(command, argument, options) {
   const { port = DEFAULT_PORT,
+          fonts = DEFAULT_FONTS,
           watch = DEFAULT_WATCH,
+          client = DEFAULT_CLIENT,
           quietly = DEFAULT_QUIETLY,
-          noClient = DEFAULT_NO_CLIENT,
-          copyFonts = DEFAULT_COPY_FONTS,
-          inputFileName = DEFAULT_INPUT_FILE_NAME,
-          copyClientFiles = DEFAULT_COPY_CLIENT_FILES } = options;
+          inputFileName = DEFAULT_INPUT_FILE_NAME } = options;
 
   switch (command) {
     case null: {
@@ -56,7 +54,7 @@ function main(command, argument, options) {
     case PUBLISH_COMMAND: {
       const projectDirectoryName = argument;  ///
 
-      publishAction(port, watch, quietly, noClient, copyFonts, inputFileName, copyClientFiles, projectDirectoryName);
+      publishAction(port, fonts, watch, client, quietly, inputFileName, projectDirectoryName);
 
       break;
     }

package/bin/operation/copyClientFiles.js

@@ -1,15 +1,15 @@
 "use strict";
 
-const { copyFiles } = require("highmark-client");
+const { copyFiles: copyClientFiles } = require("highmark-client");
 
 function copyClientFilesOperation(proceed, abort, context) {
-  const { copyClientFiles } = context;
+  const { client } = context;
 
-  if (copyClientFiles) {
+  if (client) {
     const { projectDirectoryName } = context,
           targetDirectoryPath = projectDirectoryName; ///
 
-    copyFiles(targetDirectoryPath);
+    copyClientFiles(targetDirectoryPath);
   }
 
   proceed();

package/bin/operation/copyFonts.js

@@ -1,16 +1,16 @@
 "use strict";
 
-const { pathUtilities } = require("necessary"),
-      { copyFonts: copyFontsAsync } = require("highmark-client");
+const { copyFonts } = require("highmark-client"),
+      { pathUtilities } = require("necessary");
 
 const { FONT } = require("../constants");
 
 const { concatenatePaths } = pathUtilities;
 
 function copyFontsOperation(proceed, abort, context) {
-  const { copyFonts } = context;
+  const { fonts } = context;
 
-  if (!copyFonts) {
+  if (!fonts) {
     proceed();
 
     return;
@@ -19,7 +19,7 @@ function copyFontsOperation(proceed, abort, context) {
   const { projectDirectoryPath } = context,
         fontDirectoryPath = concatenatePaths(projectDirectoryPath, FONT);
 
-  copyFontsAsync(fontDirectoryPath);
+  copyFonts(fontDirectoryPath);
 
   proceed();
 }

package/bin/operation/createClientHTML.js

@@ -9,8 +9,8 @@ const { concatenatePaths } = pathUtilities,
       { INDEX_HTML_FILE_NAME } = constants;
 
 function createClientHTMLOperation(proceed, abort, context) {
-  const { noClient, markdownHTML, markdownStylesCSS, projectDirectoryName } = context,
-        html = createHTML(markdownHTML, markdownStylesCSS, noClient),
+  const { client, markdownHTML, markdownStylesCSS, projectDirectoryName } = context,
+        html = createHTML(markdownHTML, markdownStylesCSS, client),
         content = html, ///
         filePath = concatenatePaths(projectDirectoryName, INDEX_HTML_FILE_NAME);
 

package/bin/operation/markdownStylesCSS.js

@@ -13,7 +13,7 @@ const { DIVS_SELECTOR_STRING: CLIENT_DIVS_SELECTOR_STRING } = constants,
       { isFilePathMarkdownStyleFilePath, isFilePathDefaultMarkdownStyleFilePath } = filePathUtilities;
 
 function markdownStylesCSSOperation(proceed, abort, context) {
-  const { copyClientFiles, projectDirectoryName } = context,
+  const { client, projectDirectoryName } = context,
         projectDirectoryPath = projectDirectoryName,  ///
         markdownStyleFilePaths = [];
 
@@ -30,7 +30,7 @@ function markdownStylesCSSOperation(proceed, abort, context) {
     }
   });
 
-  const selectorString = copyClientFiles ?
+  const selectorString = client ?
                            CLIENT_DIVS_SELECTOR_STRING :
                              DIVS_SELECTOR_STRING,
         markdownStyle = defaultMarkdownStyle, ///
@@ -39,7 +39,7 @@ function markdownStylesCSSOperation(proceed, abort, context) {
   let markdownStylesCSS = defaultCSS; ///
 
   markdownStyleFilePaths.forEach((markdownStyleFilePath) => {
-    const selectorString = selectorStringFromMarkdownStyleFilePathAndCopyClientFiles(markdownStyleFilePath, copyClientFiles),
+    const selectorString = selectorStringFromMarkdownStyleFilePathAndClient(markdownStyleFilePath, client),
           markdownStyle = markdownStyleFromMarkdownStyleFilePath(markdownStyleFilePath),
           css = cssFromMarkdownStyleAndSelectorString(markdownStyle, selectorString, markdownStylesCSS);  ///
 
@@ -63,8 +63,8 @@ function markdownStyleFromMarkdownStyleFilePath(markdownStyleFilePath) {
   return markdownStyle;
 }
 
-function selectorStringFromMarkdownStyleFilePathAndCopyClientFiles(markdownStyleFilePath, copyClientFiles) {
-  let selectorString = copyClientFiles ?
+function selectorStringFromMarkdownStyleFilePathAndClient(markdownStyleFilePath, client) {
+  let selectorString = client ?
                          CLIENT_DIVS_SELECTOR_STRING :
                            DIVS_SELECTOR_STRING;
 

package/bin/options.js

@@ -2,24 +2,22 @@
 
 const HELP_OPTION = "help",
       PORT_OPTION = "port",
+      FONTS_OPTION = "fonts",
       WATCH_OPTION = "watch",
+      CLIENT_OPTION = "client",
       SERVER_OPTION = "server",
       VERSION_OPTION = "version",
       QUIETLY_OPTION = "quietly",
-      NO_CLIENT_OPTION = "no-client",
-      COPY_FONTS_OPTION = "copy-fonts",
-      INPUT_FILE_NAME_OPTION = "input-file-name",
-      COPY_CLIENT_FILES_OPTION = "copy-client-files";
+      INPUT_FILE_NAME_OPTION = "input-file-name";
 
 module.exports = {
   HELP_OPTION,
   PORT_OPTION,
+  FONTS_OPTION,
   WATCH_OPTION,
+  CLIENT_OPTION,
   SERVER_OPTION,
   VERSION_OPTION,
   QUIETLY_OPTION,
-  NO_CLIENT_OPTION,
-  COPY_FONTS_OPTION,
-  INPUT_FILE_NAME_OPTION,
-  COPY_CLIENT_FILES_OPTION
+  INPUT_FILE_NAME_OPTION
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "highmark-cli",
   "author": "James Smith",
-  "version": "1.3.14",
+  "version": "1.3.16",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/highmark-cli",
   "description": "Highmark's LIC tool.",
@@ -12,8 +12,8 @@
   "dependencies": {
     "argumentative": "^2.0.28",
     "express": "^4.19.2",
-    "highmark-client": "^0.0.98",
-    "highmark-markdown": "^0.0.446",
+    "highmark-client": "^0.0.104",
+    "highmark-markdown": "^0.0.447",
     "lively-cli": "^2.0.65",
     "necessary": "^14.0.1",
     "occam-entities": "^1.0.123"