highmark-cli 0.0.96 → 0.0.98

package/bin/abbreviations.js

@@ -8,7 +8,8 @@ const { HELP_OPTION,
         VERSION_OPTION,
         COPY_FONTS_OPTION,
         INPUT_FILE_PATH_OPTION,
-        OUTPUT_FILE_PATH_OPTION } = options;
+        OUTPUT_FILE_PATH_OPTION,
+        TEMPLATE_FILE_PATH_OPTION } = options;
 
 const h = HELP_OPTION,
       p = PORT_OPTION,
@@ -16,7 +17,8 @@ const h = HELP_OPTION,
       v = VERSION_OPTION,
       f = COPY_FONTS_OPTION,
       i = INPUT_FILE_PATH_OPTION,
-      o = OUTPUT_FILE_PATH_OPTION;
+      o = OUTPUT_FILE_PATH_OPTION,
+      t = TEMPLATE_FILE_PATH_OPTION;
 
 module.exports = {
   h,
@@ -25,5 +27,6 @@ module.exports = {
   v,
   f,
   i,
-  o
+  o,
+  t
 };

package/bin/action/help.js

@@ -7,14 +7,28 @@ function helpAction() {
 
 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 is 8888.
+
+  --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'.
+
+  --output-file-path|-o                      The output file path. The default is 'index.html'.
+
 Further information:
 
 Please see the readme file on GitHub:

package/bin/action/publish.js

@@ -9,7 +9,7 @@ const htmlOperation = require("../operation/html"),
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_PUBLISH_MESSAGE, FAILED_PUBLISH_MESSAGE } = require("../messages");
 
-function publishAction(port, server, copyFonts, inputFilePath, outputFilePath) {
+function publishAction(port, server, copyFonts, inputFilePath, outputFilePath, templateFilePath) {
   const operations = [
           markdownStylesCSSOperation,
           markdownHTMLOperation,
@@ -22,7 +22,8 @@ function publishAction(port, server, copyFonts, inputFilePath, outputFilePath) {
           server,
           copyFonts,
           inputFilePath,
-          outputFilePath
+          outputFilePath,
+          templateFilePath
         };
 
   executeOperations(operations, (completed) => {

package/bin/defaults.js

@@ -4,12 +4,14 @@ const DEFAULT_PORT = 8888,
       DEFAULT_SERVER = false,
       DEFAULT_COPY_FONTS = false,
       DEFAULT_INPUT_FILE_PATH = "default.md",
-      DEFAULT_OUTPUT_FILE_PATH = "index.html";
+      DEFAULT_OUTPUT_FILE_PATH = "index.html",
+      DEFAULT_TEMPLATE_FILE_PATH = "template/default.html";
 
 module.exports = {
   DEFAULT_PORT,
   DEFAULT_SERVER,
   DEFAULT_COPY_FONTS,
   DEFAULT_INPUT_FILE_PATH,
-  DEFAULT_OUTPUT_FILE_PATH
+  DEFAULT_OUTPUT_FILE_PATH,
+  DEFAULT_TEMPLATE_FILE_PATH
 };

package/bin/main.js

@@ -5,13 +5,14 @@ const helpAction = require("./action/help"),
       versionAction = require("./action/version"),
       publishAction = require("./action/publish");
 
-const { HELP_OPTION, SERVER_OPTION, VERSION_OPTION } = require("./options"),
-      { HELP_COMMAND, SERVER_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND } = require("./commands"),
+const { HELP_COMMAND, SERVER_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND } = require("./commands"),
+      { HELP_OPTION, SERVER_OPTION, VERSION_OPTION, TEMPLATE_FILE_PATH_OPTION } = require("./options"),
       { DEFAULT_PORT,
         DEFAULT_SERVER,
         DEFAULT_COPY_FONTS,
         DEFAULT_INPUT_FILE_PATH,
-        DEFAULT_OUTPUT_FILE_PATH } = require("./defaults");
+        DEFAULT_OUTPUT_FILE_PATH,
+        DEFAULT_TEMPLATE_FILE_PATH } = require("./defaults");
 
 function main(command, argument, options) {
   const commandMissing = (command === null),
@@ -22,7 +23,8 @@ function main(command, argument, options) {
           server = DEFAULT_SERVER,
           copyFonts = DEFAULT_COPY_FONTS,
           inputFilePath = DEFAULT_INPUT_FILE_PATH,
-          outputFilePath = DEFAULT_OUTPUT_FILE_PATH } = options;
+          outputFilePath = DEFAULT_OUTPUT_FILE_PATH,
+          templateFilePath = DEFAULT_TEMPLATE_FILE_PATH } = options;
 
   if (false) {
     ///
@@ -42,12 +44,10 @@ function main(command, argument, options) {
     case HELP_COMMAND: helpAction(); break;
     case SERVER_COMMAND: serverAction(port, server, outputFilePath); break;
     case VERSION_COMMAND: versionAction(); break;
-    case PUBLISH_COMMAND: publishAction(port, server, copyFonts, inputFilePath, outputFilePath); break;
+    case PUBLISH_COMMAND: publishAction(port, server, copyFonts, inputFilePath, outputFilePath, templateFilePath); break;
 
     default :
-      argument = command;  ///
-
-      publishAction(port, server, copyFonts, inputFilePath, outputFilePath);
+      publishAction(port, server, copyFonts, inputFilePath, outputFilePath, templateFilePath);
 
       break;
   }

package/bin/messages.js

@@ -11,6 +11,7 @@ const FAILED_SERVER_MESSAGE = "Failed to serve.",
       UNABLE_TO_READ_DIRECTORY_MESSAGE = "Unable to read the directory.",
       UNABLE_TO_CREATE_DIRECTORY_MESSAGE = "Unable to create the directory.",
       UNABLE_TO_PARSE_MARKDOWN_FILE_MESSAGE = "Unable to parse the markdown file.",
+      UNABLE_TO_PARSE_TEMPLATE_FILE_MESSAGE = "Unable to parse the template file.",
       UNABLE_TO_CONVERT_MARKDOWN_TO_HTML_MESSAGE = "Unable to convert Markdown to HTML.",
       UNABLE_TO_CONVERT_MARKDOWN_STYLES_TO_CSS_MESSAGE = "Unable to convert Markdown styles to CSS.";
 
@@ -26,6 +27,7 @@ module.exports = {
   UNABLE_TO_READ_DIRECTORY_MESSAGE,
   UNABLE_TO_CREATE_DIRECTORY_MESSAGE,
   UNABLE_TO_PARSE_MARKDOWN_FILE_MESSAGE,
+  UNABLE_TO_PARSE_TEMPLATE_FILE_MESSAGE,
   UNABLE_TO_CONVERT_MARKDOWN_TO_HTML_MESSAGE,
   UNABLE_TO_CONVERT_MARKDOWN_STYLES_TO_CSS_MESSAGE
 };

package/bin/operation/html.js

@@ -1,75 +1,22 @@
 "use strict";
 
-const { computerModernStyle } = require("highmark-fonts");
+const { computerModernStyle: computerModernStyleCSS } = require("highmark-fonts");
 
-const { writeFile } = require("../utilities/fileSystem"),
-      { EMPTY_STRING } = require("../constants");
+const { EMPTY_STRING } = require("../constants"),
+      { writeFile, parseTemplateFile } = require("../utilities/fileSystem");
 
 function htmlOperation(proceed, abort, context) {
-  const { title, markdownHTML, outputFilePath, markdownStylesCSS } = context,
+  const { title, markdownHTML, outputFilePath, markdownStylesCSS, templateFilePath } = context,
         titleHTML = titleHTMLFromTitle(title),
-        filePath = outputFilePath,  ///
-        content = `<!DOCTYPE html>
-<html>
-  <head>
-  
-    ${titleHTML}
-    
-    <meta charset="utf-8" />
-
-    <link rel="preload" href="font/cmunbbx.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunbi.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunbmo.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunbmr.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunbx.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunbxo.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunit.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunobi.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunobx.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunorm.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunoti.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunrm.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunsi.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunso.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunss.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunsx.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmuntb.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmunti.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmuntt.woff2" as="font" type="font/woff2" crossorigin />
-    <link rel="preload" href="font/cmuntx.woff2" as="font" type="font/woff2" crossorigin />
-
-    <style>
-
-      *,
-      *::after,
-      *::before {
-        border: 0;
-        margin: 0;
-        padding: 0;
-        box-sizing: border-box;
-      }
-    
-    </style>
-    <style>
-    
-${computerModernStyle}    
-    
-    </style>
-    <style>
-
-${markdownStylesCSS}
-
-    </style>
-  </head>
-  <body>
-
-${markdownHTML}
-
-  </body>
-</html>
-`;
-
-  writeFile(filePath, content);
+        args = {
+          titleHTML,
+          markdownHTML,
+          markdownStylesCSS,
+          computerModernStyleCSS
+        },
+        content = parseTemplateFile(templateFilePath, args);
+
+  writeFile(outputFilePath, content);
 
   proceed();
 }

package/bin/options.js

@@ -6,7 +6,8 @@ const HELP_OPTION = "help",
       VERSION_OPTION = "version",
       COPY_FONTS_OPTION = "copy-fonts",
       INPUT_FILE_PATH_OPTION = "input-file-path",
-      OUTPUT_FILE_PATH_OPTION = "output-file-path";
+      OUTPUT_FILE_PATH_OPTION = "output-file-path",
+      TEMPLATE_FILE_PATH_OPTION = "template-file-path";
 
 module.exports = {
   HELP_OPTION,
@@ -15,5 +16,6 @@ module.exports = {
   VERSION_OPTION,
   COPY_FONTS_OPTION,
   INPUT_FILE_PATH_OPTION,
-  OUTPUT_FILE_PATH_OPTION
+  OUTPUT_FILE_PATH_OPTION,
+  TEMPLATE_FILE_PATH_OPTION
 };

package/bin/template/default.html

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+
+    ${titleHTML}
+
+    <meta charset="utf-8" />
+
+    <link rel="preload" href="font/cmunbbx.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunbi.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunbmo.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunbmr.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunbx.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunbxo.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunit.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunobi.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunobx.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunorm.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunoti.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunrm.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunsi.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunso.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunss.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunsx.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmuntb.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmunti.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmuntt.woff2" as="font" type="font/woff2" crossorigin />
+    <link rel="preload" href="font/cmuntx.woff2" as="font" type="font/woff2" crossorigin />
+
+    <style>
+
+        *,
+        *::after,
+        *::before {
+            border: 0;
+            margin: 0;
+            padding: 0;
+            box-sizing: border-box;
+        }
+
+    </style>
+    <style>
+
+        ${computerModernStyle}
+
+    </style>
+    <style>
+
+        ${markdownStylesCSS}
+
+    </style>
+</head>
+<body>
+
+${markdownHTML}
+
+</body>
+</html>

package/bin/utilities/fileSystem.js

@@ -1,15 +1,17 @@
 "use strict";
 
-const { pathUtilities, fileSystemUtilities } = require("necessary");
+const { pathUtilities, templateUtilities, fileSystemUtilities } = require("necessary");
 
 const { isEntryNameHiddenName } = require("../utilities/path"),
       { UNABLE_TO_COPY_FILE_MESSAGE,
         UNABLE_TO_READ_FILE_MESSAGE,
         UNABLE_TO_WRITE_FILE_MESSAGE,
         UNABLE_TO_READ_DIRECTORY_MESSAGE,
-        UNABLE_TO_CREATE_DIRECTORY_MESSAGE } = require("../messages");
+        UNABLE_TO_CREATE_DIRECTORY_MESSAGE,
+        UNABLE_TO_PARSE_TEMPLATE_FILE_MESSAGE } = require("../messages");
 
-const { concatenatePaths } = pathUtilities,
+const { parseFile } = templateUtilities,
+      { concatenatePaths } = pathUtilities,
       { isEntryFile,
         checkEntryExists,
         copyFile: copyFileAsync,
@@ -142,10 +144,35 @@ function createDirectory(directoryPath) {
   }
 }
 
+function parseTemplateFile(templateFilePath, args) {
+  let content = null;
+
+  try {
+    const filePath = templateFilePath;  ///
+
+    content = parseFile(filePath, args);
+
+    console.log(`Parse template file '${filePath}'.`);
+  } catch (error) {
+    let message;
+
+    message = UNABLE_TO_PARSE_TEMPLATE_FILE_MESSAGE;
+
+    console.log(message);
+
+    ({ message } = error);
+
+    console.log(message);
+  }
+
+  return content;
+}
+
 module.exports = {
   copyFile,
   readFile,
   writeFile,
   readDirectory,
-  createDirectory
+  createDirectory,
+  parseTemplateFile
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "highmark-cli",
   "author": "James Smith",
-  "version": "0.0.96",
+  "version": "0.0.98",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/highmark-cli",
   "description": "Extensible, styleable Markdown.",
@@ -12,12 +12,12 @@
   "dependencies": {
     "argumentative": "^2.0.28",
     "express": "^4.19.2",
-    "highmark-fonts": "^1.0.30",
-    "highmark-markdown": "^0.0.153",
-    "highmark-markdown-style": "^0.0.189",
+    "highmark-fonts": "^1.0.31",
+    "highmark-markdown": "^0.0.154",
+    "highmark-markdown-style": "^0.0.190",
     "lively-cli": "^2.0.55",
-    "necessary": "^13.5.5",
-    "occam-entities": "^1.0.84"
+    "necessary": "^13.6.1",
+    "occam-entities": "^1.0.85"
   },
   "scripts": {},
   "bin": {