highmark-cli 1.1.20 → 1.2.1

package/README.md

@@ -59,6 +59,10 @@ Commands:
   
   version                                    Show the version
   
+  server                                     Run a server to view the output file
+
+  initialise                                 Create a configuration file
+
   [publish]                                  Publish the input Markdown file to the output HTML file
 
 Options:
@@ -71,17 +75,17 @@ Options:
 
   --watch|-w                                 Watch for changes to the client file and in the output directory 
 
-  --quietly|-q                               Run with almost no console logging
+  --server|-s                                Run a server to view the output file
 
-  --copy-fonts|-f                            Copy the fonts to a fonts folder next to the output file
+  --quietly|-q                               Run with almost no console logging
 
-  --start-server|-s                          Start a server to view the output file
+  --no-client|-n                             Do not include references to the client files in the output file
 
-  --input-file-path|-i                       The input file path, the default being 'default.md'
+  --copy-fonts|-f                            Copy the fonts to a fonts folder next to the output file
 
-  --copy-client-files|-c                     Copy the bundled client files next to the output file
+  --input-file-name|-i                       The input file name, the default being 'default.md'
 
-  --output-directory-path|-o                 The output directory path. The default is the current directory
+  --copy-client-files|-c                     Copy the client files next to the output file
 ```
 
 ## Contact

package/bin/abbreviations.js

@@ -8,6 +8,7 @@ const { HELP_OPTION,
         SERVER_OPTION,
         VERSION_OPTION,
         QUIETLY_OPTION,
+        NO_CLIENT_OPTION,
         COPY_FONTS_OPTION,
         INPUT_FILE_NAME_OPTION,
         COPY_CLIENT_FILES_OPTION } = options;
@@ -18,6 +19,7 @@ const h = HELP_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;
@@ -28,6 +30,7 @@ module.exports = {
   w,
   v,
   q,
+  n,
   f,
   s,
   i,

package/bin/action/help.js

@@ -31,11 +31,13 @@ Options:
 
   --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 bundled client files next to the output file
+  --copy-client-files|-c                     Copy the client files next to the output file
 
 Further information:
 

package/bin/action/publish.js

@@ -10,7 +10,7 @@ const watchOperation = require("../operation/watch"),
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_PUBLISH_MESSAGE, FAILED_PUBLISH_MESSAGE } = require("../messages");
 
-function publishAction(port, watch, quietly, copyFonts, inputFileName, copyClientFiles, projectDirectoryName) {
+function publishAction(port, watch, quietly, noClient, copyFonts, inputFileName, copyClientFiles, projectDirectoryName) {
   const operations = [
           markdownHTMLOperation,
           markdownStylesCSSOperation,
@@ -23,6 +23,7 @@ function publishAction(port, watch, quietly, copyFonts, inputFileName, copyClien
           port,
           watch,
           quietly,
+          noClient,
           copyFonts,
           inputFileName,
           copyClientFiles,

package/bin/configuration/version_1_1.js

@@ -4,17 +4,6 @@ const { VERSION_1_1 } = require("../versions");
 
 const { DEFAULT_CONTENTS_DEPTH } = require("../defaults");
 
-function createConfiguration() {
-  const version = VERSION_1_1,
-        contentsDepth = DEFAULT_CONTENTS_DEPTH,
-        configuration = {
-          version,
-          contentsDepth
-        };
-
-  return configuration;
-}
-
 function migrateToVersion1_1(json) {
   const version = VERSION_1_1,
         contentsDepth = DEFAULT_CONTENTS_DEPTH;
@@ -27,6 +16,5 @@ function migrateToVersion1_1(json) {
   return json;
 }
 module.exports = {
-  createConfiguration,
   migrateToVersion1_1
 };

package/bin/configuration/version_1_2.js

@@ -0,0 +1,38 @@
+"use strict";
+
+const { VERSION_1_2 } = require("../versions");
+
+const { DEFAULT_CONTENTS_DEPTH, DEFAULT_LINES_PER_PAGE, DEFAULT_CHARACTERS_PER_LINE } = require("../defaults");
+
+function createConfiguration() {
+  const version = VERSION_1_2,
+        linesPerPage = DEFAULT_LINES_PER_PAGE,
+        contentsDepth = DEFAULT_CONTENTS_DEPTH,
+        charactersPerLine = DEFAULT_CHARACTERS_PER_LINE,
+        configuration = {
+          version,
+          linesPerPage,
+          contentsDepth,
+          charactersPerLine
+        };
+
+  return configuration;
+}
+
+function migrateToVersion1_2(json) {
+  const version = VERSION_1_2,
+        linesPerPage = DEFAULT_LINES_PER_PAGE,
+        charactersPerLine = DEFAULT_CHARACTERS_PER_LINE;
+
+  json = Object.assign({}, json, {
+    version,
+    linesPerPage,
+    charactersPerLine
+  });
+
+  return json;
+}
+module.exports = {
+  createConfiguration,
+  migrateToVersion1_2
+};

package/bin/configuration.js

@@ -3,8 +3,9 @@
 const { versionUtilities, configurationUtilities } = require("necessary");
 
 const { HIGHMARK } = require("./constants"),
-      { VERSION_1_0, VERSION_1_1 } = require("./versions"),
-      { createConfiguration, migrateToVersion1_1 } = require("./configuration/version_1_1"),
+      { VERSION_1_0, VERSION_1_1, VERSION_1_2 } = require("./versions"),
+      { migrateToVersion1_1 } = require("./configuration/version_1_1"),
+      { createConfiguration, migrateToVersion1_2 } = require("./configuration/version_1_2"),
       { CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE } = require("./messages");
 
 const { rc } = configurationUtilities,
@@ -15,6 +16,13 @@ const rcBaseExtension = HIGHMARK; ///
 
 setRCBaseExtension(rcBaseExtension);
 
+function getLinesPerPage() {
+  const configuration = readConfigurationFile(),
+        { linesPerPage } = configuration;
+
+  return linesPerPage;
+}
+
 function getContentsDepth() {
   const configuration = readConfigurationFile(),
         { contentsDepth } = configuration;
@@ -22,6 +30,13 @@ function getContentsDepth() {
   return contentsDepth;
 }
 
+function getCharactersPerLine() {
+  const configuration = readConfigurationFile(),
+        { charactersPerLine } = configuration;
+
+  return charactersPerLine;
+}
+
 function createConfigurationFile() {
   const configuration = createConfiguration(),
         json = configuration; ///
@@ -35,9 +50,10 @@ function migrateConfigurationFile() {
   let json = readRCFile();
 
   const migrationMap = {
-          [VERSION_1_0]: migrateToVersion1_1
+          [VERSION_1_0]: migrateToVersion1_1,
+          [VERSION_1_1]: migrateToVersion1_2
         },
-        latestVersion = VERSION_1_1;
+        latestVersion = VERSION_1_2;
 
   json = migrate(json, migrationMap, latestVersion);
 
@@ -62,7 +78,9 @@ function assertConfigurationFileExists() {
 }
 
 module.exports = {
+  getLinesPerPage,
   getContentsDepth,
+  getCharactersPerLine,
   createConfigurationFile,
   migrateConfigurationFile,
   checkConfigurationFileExists,

package/bin/defaults.js

@@ -6,10 +6,13 @@ const DEFAULT_HELP = false,
       DEFAULT_SERVER = false,
       DEFAULT_QUIETLY = false,
       DEFAULT_VERSION = false,
+      DEFAULT_NO_CLIENT = false,
       DEFAULT_COPY_FONTS = false,
+      DEFAULT_LINES_PER_PAGE = 50,
       DEFAULT_CONTENTS_DEPTH = 2,
       DEFAULT_INPUT_FILE_NAME = "default.md",
-      DEFAULT_COPY_CLIENT_FILES = false;
+      DEFAULT_COPY_CLIENT_FILES = false,
+      DEFAULT_CHARACTERS_PER_LINE = 90;
 
 module.exports = {
   DEFAULT_HELP,
@@ -18,8 +21,11 @@ module.exports = {
   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_COPY_CLIENT_FILES,
+  DEFAULT_CHARACTERS_PER_LINE
 };

package/bin/main.js

@@ -11,6 +11,7 @@ const { NO_COMMAND_GIVEN_MESSAGE, COMMAND_NOT_RECOGNISED_MESSAGE } = require("./
       { DEFAULT_PORT,
         DEFAULT_WATCH,
         DEFAULT_QUIETLY,
+        DEFAULT_NO_CLIENT,
         DEFAULT_COPY_FONTS,
         DEFAULT_INPUT_FILE_NAME,
         DEFAULT_COPY_CLIENT_FILES } = require("./defaults");
@@ -19,6 +20,7 @@ function main(command, argument, options) {
   const { port = DEFAULT_PORT,
           watch = DEFAULT_WATCH,
           quietly = DEFAULT_QUIETLY,
+          noClient = DEFAULT_NO_CLIENT,
           copyFonts = DEFAULT_COPY_FONTS,
           inputFileName = DEFAULT_INPUT_FILE_NAME,
           copyClientFiles = DEFAULT_COPY_CLIENT_FILES } = options;
@@ -53,7 +55,7 @@ function main(command, argument, options) {
     case PUBLISH_COMMAND: {
       const projectDirectoryName = argument;  ///
 
-      publishAction(port, watch, quietly, copyFonts, inputFileName, copyClientFiles, projectDirectoryName);
+      publishAction(port, watch, quietly, noClient, copyFonts, inputFileName, copyClientFiles, projectDirectoryName);
 
       break;
     }

package/bin/operation/createClientHTML.js

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

package/bin/operation/markdownHTML.js

@@ -1,17 +1,17 @@
 "use strict";
 
 const { pathUtilities } = require("necessary");
-const { markdownUtilities } = require("highmark-markdown");
+const { processingUtilities } = require("highmark-markdown");
 
 const importer = require("../importer");
 
 const { readFile } = require("../utilities/fileSystem"),
-      { getContentsDepth } = require("../configuration"),
       { classNameFromFilePath } = require("../utilities/division"),
       { nodeFromTokens, tokensFromContent } = require("../utilities/markdown"),
-      { UNABLE_TO_CONVERT_MARKDOWN_TO_HTML_MESSAGE } = require("../messages");
+      { UNABLE_TO_CONVERT_MARKDOWN_TO_HTML_MESSAGE } = require("../messages"),
+      { getLinesPerPage, getContentsDepth, getCharactersPerLine } = require("../configuration");
 
-const { postprocess } = markdownUtilities,
+const { postprocess } = processingUtilities,
       { concatenatePaths } = pathUtilities;
 
 function markdownHTMLOperation(proceed, abort, context) {
@@ -44,25 +44,23 @@ function markdownHTMLOperation(proceed, abort, context) {
     return;
   }
 
-  const contentsDepth = getContentsDepth(),
+  const linesPerPage = getLinesPerPage(),
+        contentsDepth = getContentsDepth(),
+        charactersPerLine = getCharactersPerLine(),
         divisionClassName = className,  ///
         divisionMarkdownNode = node;  ///
 
   Object.assign(context, {
     tokens,
     importer,
+    linesPerPage,
     contentsDepth,
+    charactersPerLine,
     divisionClassName
   });
 
   const divisionMarkdownNodes = postprocess(divisionMarkdownNode, context),
-        markdownHTML = divisionMarkdownNodes.reduce((markdownHTML, divisionMarkdownNode, index) => {
-          const pageNumber = index + 1;
-
-          Object.assign(context, {
-            pageNumber
-          });
-
+        markdownHTML = divisionMarkdownNodes.reduce((markdownHTML, divisionMarkdownNode) => {
           const html = divisionMarkdownNode.asHTML(context);
 
           markdownHTML = (markdownHTML === null) ?

package/bin/operation/markdownStylesCSS.js

@@ -42,7 +42,7 @@ function markdownStylesCSSOperation(proceed, abort, context) {
   let markdownStylesCSS = defaultCSS; ///
 
   markdownStyleFilePaths.forEach((markdownStyleFilePath) => {
-    const selectorString = selectorStringFromMarkdownStyleFilePathAndCopyClient(markdownStyleFilePath, copyClientFiles),
+    const selectorString = selectorStringFromMarkdownStyleFilePathAndCopyClientFiles(markdownStyleFilePath, copyClientFiles),
           markdownStyle = markdownStyleFromMarkdownStyleFilePath(markdownStyleFilePath),
           css = cssFromMarkdownStyleMediaTypeNameAndSelectorString(markdownStyle, mediaTypeName, selectorString, markdownStylesCSS);  ///
 
@@ -66,7 +66,7 @@ function markdownStyleFromMarkdownStyleFilePath(markdownStyleFilePath) {
   return markdownStyle;
 }
 
-function selectorStringFromMarkdownStyleFilePathAndCopyClient(markdownStyleFilePath, copyClientFiles) {
+function selectorStringFromMarkdownStyleFilePathAndCopyClientFiles(markdownStyleFilePath, copyClientFiles) {
   let selectorString = copyClientFiles ?
                          CLIENT_DIVS_SELECTOR_STRING :
                            DIVS_SELECTOR_STRING;

package/bin/options.js

@@ -6,6 +6,7 @@ const HELP_OPTION = "help",
       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";
@@ -17,6 +18,7 @@ module.exports = {
   SERVER_OPTION,
   VERSION_OPTION,
   QUIETLY_OPTION,
+  NO_CLIENT_OPTION,
   COPY_FONTS_OPTION,
   INPUT_FILE_NAME_OPTION,
   COPY_CLIENT_FILES_OPTION

package/bin/versions.js

@@ -1,9 +1,11 @@
 "use strict";
 
 const VERSION_1_0 = "1.0",
-      VERSION_1_1 = "1.1";
+      VERSION_1_1 = "1.1",
+      VERSION_1_2 = "1.2";
 
 module.exports = {
   VERSION_1_0,
-  VERSION_1_1
+  VERSION_1_1,
+  VERSION_1_2
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "highmark-cli",
   "author": "James Smith",
-  "version": "1.1.20",
+  "version": "1.2.1",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/highmark-cli",
   "description": "Highmark's LIC tool.",
@@ -13,7 +13,7 @@
     "argumentative": "^2.0.28",
     "express": "^4.19.2",
     "highmark-client": "^0.0.98",
-    "highmark-markdown": "^0.0.401",
+    "highmark-markdown": "^0.0.406",
     "lively-cli": "^2.0.65",
     "necessary": "^14.0.1",
     "occam-entities": "^1.0.106"