highmark-cli 1.3.186 → 1.3.188

package/{bin → src}/prepare.js

@@ -1,16 +1,16 @@
 "use strict";
 
-const changeDirectory = require("./changeDirectory");
+import changeDirectory from "./changeDirectory";
 
-const { DEFAULT_HELP, DEFAULT_VERSION, DEFAULT_SERVER } = require("./defaults"),
-      { HELP_COMMAND,
-        SERVER_COMMAND,
-        VERSION_COMMAND,
-        PUBLISH_COMMAND,
-        INITIALISE_COMMAND,
-        SET_OPTIONS_COMMAND } = require("./commands");
+import { DEFAULT_HELP, DEFAULT_VERSION, DEFAULT_SERVER } from "./defaults";
+import { HELP_COMMAND,
+         SERVER_COMMAND,
+         VERSION_COMMAND,
+         PUBLISH_COMMAND,
+         INITIALISE_COMMAND,
+         SET_OPTIONS_COMMAND } from "./commands";
 
-function prepare(command, argument, options, main) {
+export default function prepare(command, argument, options, main) {
   const { help = DEFAULT_HELP, version = DEFAULT_VERSION } = options;
 
   if (false) {
@@ -56,5 +56,3 @@ function prepare(command, argument, options, main) {
 
   main(command, argument, options);
 }
-
-module.exports = prepare;

package/{bin → src}/utilities/division.js

@@ -1,13 +1,13 @@
 "use strict";
 
-const { pathUtilities, arrayUtilities } = require("necessary");
+import { pathUtilities, arrayUtilities } from "necessary";
 
-const { DEFAULT_DIVISION_IDENTIFIER } = require("../constants");
+import { DEFAULT_DIVISION_IDENTIFIER } from "../constants";
 
 const { second } = arrayUtilities,
       { isPathName, bottommostNameFromPath } = pathUtilities;
 
-function classNameFromFilePath(filePath) {
+export default function classNameFromFilePath(filePath) {
   const path = filePath,
         pathName = isPathName(path),
         name = pathName ?
@@ -21,7 +21,3 @@ function classNameFromFilePath(filePath) {
 
   return className;
 }
-
-module.exports = {
-  classNameFromFilePath
-}

package/{bin → src}/utilities/filePath.js

@@ -6,11 +6,6 @@ const markdownStyleFilePathPattern = "^(?:[^\\/]+\\/){1,}[^\\.]+\\.mds$",
 const markdownStyleFilePathRegularExpression = new RegExp(markdownStyleFilePathPattern),
       defaultMarkdownStyleFilePathRegularExpression = new RegExp(defaultMarkdownStyleFilePathPattern);
 
-function isFilePathMarkdownStyleFilePath(filePath) { return markdownStyleFilePathRegularExpression.test(filePath); }
+export function isFilePathMarkdownStyleFilePath(filePath) { return markdownStyleFilePathRegularExpression.test(filePath); }
 
-function isFilePathDefaultMarkdownStyleFilePath(filePath) { return defaultMarkdownStyleFilePathRegularExpression.test(filePath); }
-
-module.exports = {
-  isFilePathMarkdownStyleFilePath,
-  isFilePathDefaultMarkdownStyleFilePath
-};
+export function isFilePathDefaultMarkdownStyleFilePath(filePath) { return defaultMarkdownStyleFilePathRegularExpression.test(filePath); }

package/{bin → src}/utilities/fileSystem.js

@@ -1,13 +1,13 @@
 "use strict";
 
-const { pathUtilities, fileSystemUtilities } = require("necessary");
+import { pathUtilities, fileSystemUtilities } from "necessary";
 
-const { isEntryNameHiddenName } = require("../utilities/path"),
-      { UNABLE_TO_COPY_FILE_MESSAGE,
+import { isEntryNameHiddenName } from "../utilities/path";
+import { 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 } from "../messages";
 
 const { concatenatePaths } = pathUtilities,
       { isEntryFile,
@@ -18,7 +18,7 @@ const { concatenatePaths } = pathUtilities,
         readDirectory: readDirectoryAsync,
         createDirectory: createDirectoryAsync } = fileSystemUtilities;
 
-function copyFile(sourceFilePath, targetFilePath) {
+export function copyFile(sourceFilePath, targetFilePath) {
   let content = null;
 
   try {
@@ -40,7 +40,7 @@ function copyFile(sourceFilePath, targetFilePath) {
   return content;
 }
 
-function readFile(filePath) {
+export function readFile(filePath) {
   let content = null;
 
   try {
@@ -62,7 +62,7 @@ function readFile(filePath) {
   return content;
 }
 
-function writeFile(filePath, content) {
+export function writeFile(filePath, content) {
   try {
     writeFileAsync(filePath, content);
 
@@ -80,7 +80,7 @@ function writeFile(filePath, content) {
   }
 }
 
-function readDirectory(directoryPath, callback, recursive = true) {
+export function readDirectory(directoryPath, callback, recursive = true) {
   try {
     const entryNames = readDirectoryAsync(directoryPath);
 
@@ -117,7 +117,7 @@ function readDirectory(directoryPath, callback, recursive = true) {
   }
 }
 
-function createDirectory(directoryPath) {
+export function createDirectory(directoryPath) {
   const entryPath = directoryPath,  ///
         entryExists = checkEntryExists(entryPath);
 
@@ -141,11 +141,3 @@ function createDirectory(directoryPath) {
     console.log(message);
   }
 }
-
-module.exports = {
-  copyFile,
-  readFile,
-  writeFile,
-  readDirectory,
-  createDirectory
-};

package/{bin → src}/utilities/json.js

@@ -1,10 +1,10 @@
 "use strict";
 
-const { typeOf } = require("../utilities/type"),
-      { INFINITY } = require("../constants"),
-      { ARRAY_JSON_TYPE, OBJECT_JSON_TYPE, PRIMITIVE_JSON_TYPE } = require("../jsonTypes");
+import { typeOf } from "../utilities/type";
+import { INFINITY } from "../constants";
+import { ARRAY_JSON_TYPE, OBJECT_JSON_TYPE, PRIMITIVE_JSON_TYPE } from "../jsonTypes";
 
-function serialiseJSON(json) {
+export function serialiseJSON(json) {
   const type = typeOf(json);
 
   switch (type) {
@@ -42,7 +42,7 @@ function serialiseJSON(json) {
   return json;
 }
 
-function unserialiseJSON(json) {
+export function unserialiseJSON(json) {
   const type = typeOf(json);
 
   switch (type) {
@@ -80,11 +80,6 @@ function unserialiseJSON(json) {
   return json;
 }
 
-module.exports = {
-  serialiseJSON,
-  unserialiseJSON
-};
-
 function serialiseArray(array) {
   array = array.map((json) => {
     json = serialiseJSON(json);  ///

package/{bin → src}/utilities/markdown.js

@@ -1,19 +1,19 @@
 "use strict";
 
-const { MarkdownLexer, MarkdownParser } = require("highmark-markdown");
+import { MarkdownLexer, MarkdownParser } from "highmark-markdown";
 
-const { UNABLE_TO_PARSE_MARKDOWN_FILE_MESSAGE } = require("../messages");
+import { UNABLE_TO_PARSE_MARKDOWN_FILE_MESSAGE } from "../messages";
 
 const markdownLexer = MarkdownLexer.fromNothing(),
       markdownParser = MarkdownParser.fromNothing();
 
-function tokensFromContent(content) {
+export function tokensFromContent(content) {
   const tokens = markdownLexer.tokenise(content);
 
   return tokens;
 }
 
-function nodeFromTokens(tokens, startRuleName = null) {
+export function nodeFromTokens(tokens, startRuleName = null) {
   const ruleMap = markdownParser.getRuleMap(),
         startRule = (startRuleName !== null) ?
                       ruleMap[startRuleName] :
@@ -29,8 +29,3 @@ function nodeFromTokens(tokens, startRuleName = null) {
 
   return node;
 }
-
-module.exports = {
-  tokensFromContent,
-  nodeFromTokens
-};

package/{bin → src}/utilities/operation.js

@@ -1,10 +1,10 @@
 "use strict";
 
-const { asynchronousUtilities } = require("necessary");
+import { asynchronousUtilities } from "necessary";
 
 const { whilst } = asynchronousUtilities;
 
-function executeOperations(operations, callback, context) {
+export function executeOperations(operations, callback, context) {
   const completed = true;
 
   Object.assign(context, {
@@ -23,10 +23,6 @@ function executeOperations(operations, callback, context) {
   }, context);
 }
 
-module.exports = {
-	executeOperations
-};
-
 function executeOperation(next, done, context, index) {
   const { operations } = context,
         operationsLength = operations.length,

package/{bin → src}/utilities/path.js

@@ -1,11 +1,7 @@
 "use strict";
 
-function isEntryNameHiddenName(entryName) {
+export function isEntryNameHiddenName(entryName) {
   const nameHiddenName = /^\..+/.test(entryName);
 
   return nameHiddenName;
 }
-
-module.exports = {
-  isEntryNameHiddenName
-};

package/{bin → src}/utilities/type.js

@@ -1,9 +1,9 @@
 "use strict";
 
-const { STRING, NUMBER, BOOLEAN } = require("../constants"),
-      { NULL_JSON_TYPE, ARRAY_JSON_TYPE, OBJECT_JSON_TYPE, PRIMITIVE_JSON_TYPE } = require("../jsonTypes");
+import { STRING, NUMBER, BOOLEAN } from "../constants";
+import { NULL_JSON_TYPE, ARRAY_JSON_TYPE, OBJECT_JSON_TYPE, PRIMITIVE_JSON_TYPE } from "../jsonTypes";
 
-function typeOf(json) {
+export function typeOf(json) {
   let type;
 
   const _null = isNull(json),
@@ -30,10 +30,6 @@ function typeOf(json) {
   return type;
 }
 
-module.exports = {
-  typeOf
-};
-
 function isNull(json) {
   const _null = (json === null);
 

package/src/utilities/validate.js

@@ -0,0 +1,7 @@
+"use strict";
+
+export function validateLinesPerPage(linesPerPage) { return /^\d*$/.test(linesPerPage); }
+
+export function validateContentsDepth(contentsDepth) { return /^1|2|3|4$/.test(contentsDepth); }
+
+export function validateCharactersPerLine(charactersPerLine) { return /^\d+$/.test(charactersPerLine); }

package/src/versions.js

@@ -0,0 +1,6 @@
+"use strict";
+
+export const VERSION_1_0 = "1.0";
+export const VERSION_1_1 = "1.1";
+export const VERSION_1_2 = "1.2";
+export const VERSION_1_3 = "1.3";

package/bin/action/publish.js

@@ -1,44 +0,0 @@
-"use strict";
-
-const watchOperation = require("../operation/watch"),
-      copyFontsOperation = require("../operation/copyFonts"),
-      indexOptionsOperation = require("../operation/indexOptions"),
-      markdownHTMLOperation = require("../operation/markdownHTML"),
-      copyClientFilesOperation = require("../operation/copyClientFiles"),
-      createClientHTMLOperation = require("../operation/createClientHTML"),
-      markdownStylesCSSOperation = require("../operation/markdownStylesCSS");
-
-const { executeOperations } = require("../utilities/operation"),
-      { SUCCESSFUL_PUBLISH_MESSAGE, FAILED_PUBLISH_MESSAGE } = require("../messages");
-
-function publishAction(port, fonts, watch, client, quietly, inputFileName, projectDirectoryName) {
-  const operations = [
-          indexOptionsOperation,
-          markdownHTMLOperation,
-          markdownStylesCSSOperation,
-          createClientHTMLOperation,
-          copyClientFilesOperation,
-          copyFontsOperation,
-          watchOperation
-        ],
-        context = {
-          port,
-          fonts,
-          watch,
-          client,
-          quietly,
-          inputFileName,
-          projectDirectoryName
-        };
-
-  executeOperations(operations, (completed) => {
-    const success = completed,  ///
-          message = success ?
-                      SUCCESSFUL_PUBLISH_MESSAGE :
-                        FAILED_PUBLISH_MESSAGE;
-
-    console.log(message);
-  }, context);
-}
-
-module.exports = publishAction;

package/bin/action/version.js

@@ -1,15 +0,0 @@
-"use strict";
-
-const { packageUtilities } = require("necessary");
-
-const { HIGHMARK_CLI } = require("../constants");
-
-const { getVersion } = packageUtilities;
-
-function versionAction() {
-  const version = getVersion(); ///
-
-  console.log(`${HIGHMARK_CLI} version ${version}`);
-}
-
-module.exports = versionAction;

package/bin/commands.js

@@ -1,17 +0,0 @@
-"use strict";
-
-const HELP_COMMAND = "help",
-      SERVER_COMMAND = "server",
-      VERSION_COMMAND = "version",
-      PUBLISH_COMMAND = 'publish',
-      INITIALISE_COMMAND = 'initialise',
-      SET_OPTIONS_COMMAND = "set-options";
-
-module.exports = {
-  HELP_COMMAND,
-  SERVER_COMMAND,
-  VERSION_COMMAND,
-  PUBLISH_COMMAND,
-  INITIALISE_COMMAND,
-  SET_OPTIONS_COMMAND
-};

package/bin/configuration/version_1_1.js

@@ -1,20 +0,0 @@
-"use strict";
-
-const { VERSION_1_1 } = require("../versions");
-
-const { DEFAULT_CONTENTS_DEPTH } = require("../defaults");
-
-function migrateToVersion1_1(json) {
-  const version = VERSION_1_1,
-        contentsDepth = DEFAULT_CONTENTS_DEPTH;
-
-  json = Object.assign({}, json, {
-    version,
-    contentsDepth
-  });
-
-  return json;
-}
-module.exports = {
-  migrateToVersion1_1
-};

package/bin/constants.js

@@ -1,35 +0,0 @@
-"use strict";
-
-const ERROR = "error",
-      STRING = "string",
-      NUMBER = "number",
-      BOOLEAN = "boolean",
-      HIGHMARK = "highmark",
-      INFINITY = "Infinity",
-      DOUBLE_DOTS = "..",
-      EMPTY_STRING = "",
-      DOUBLE_SPACE = "  ",
-      HIGHMARK_CLI = "Highmark-CLI",
-      LIVE_RELOAD_PATH = "/live-reload",
-      FONT_DIRECTORY_NAME = "font",
-      DIVS_SELECTOR_STRING = "body > div",
-      INDEX_JSON_FILE_NAME = "index.json",
-      DEFAULT_DIVISION_IDENTIFIER = "default";
-
-module.exports = {
-  ERROR,
-  STRING,
-  NUMBER,
-  BOOLEAN,
-  HIGHMARK,
-  INFINITY,
-  DOUBLE_DOTS,
-  EMPTY_STRING,
-  DOUBLE_SPACE,
-  HIGHMARK_CLI,
-  LIVE_RELOAD_PATH,
-  FONT_DIRECTORY_NAME,
-  DIVS_SELECTOR_STRING,
-  INDEX_JSON_FILE_NAME,
-  DEFAULT_DIVISION_IDENTIFIER
-};

package/bin/defaults.js

@@ -1,29 +0,0 @@
-"use strict";
-
-const DEFAULT_HELP = false,
-      DEFAULT_PORT = 8888,
-      DEFAULT_FONTS = false,
-      DEFAULT_WATCH = false,
-      DEFAULT_CLIENT = false,
-      DEFAULT_SERVER = false,
-      DEFAULT_QUIETLY = false,
-      DEFAULT_VERSION = false,
-      DEFAULT_LINES_PER_PAGE = Infinity,
-      DEFAULT_CONTENTS_DEPTH = 2,
-      DEFAULT_INPUT_FILE_NAME = "default.md",
-      DEFAULT_CHARACTERS_PER_LINE = 75;
-
-module.exports = {
-  DEFAULT_HELP,
-  DEFAULT_PORT,
-  DEFAULT_FONTS,
-  DEFAULT_WATCH,
-  DEFAULT_CLIENT,
-  DEFAULT_SERVER,
-  DEFAULT_QUIETLY,
-  DEFAULT_VERSION,
-  DEFAULT_LINES_PER_PAGE,
-  DEFAULT_CONTENTS_DEPTH,
-  DEFAULT_INPUT_FILE_NAME,
-  DEFAULT_CHARACTERS_PER_LINE
-};

package/bin/descriptions.js

@@ -1,11 +0,0 @@
-"use strict";
-
-const LINES_PER_PAGE_DESCRIPTION = "Lines per page (leave blank for default of Infinity): ",
-      CONTENTS_DEPTH_DESCRIPTION = "Contents depth (from 1 to 4): ",
-      CHARACTERS_PER_LINE_DESCRIPTION = "Characters per line: "
-
-module.exports = {
-  LINES_PER_PAGE_DESCRIPTION,
-  CONTENTS_DEPTH_DESCRIPTION,
-  CHARACTERS_PER_LINE_DESCRIPTION
-};

package/bin/jsonTypes.js

@@ -1,13 +0,0 @@
-"use strict";
-
-const NULL_JSON_TYPE = "null",
-      ARRAY_JSON_TYPE = "array",
-      OBJECT_JSON_TYPE = "object",
-      PRIMITIVE_JSON_TYPE = "primitive";
-
-module.exports = {
-  NULL_JSON_TYPE,
-  ARRAY_JSON_TYPE,
-  OBJECT_JSON_TYPE,
-  PRIMITIVE_JSON_TYPE
-};

package/bin/messages.js

@@ -1,51 +0,0 @@
-"use strict";
-
-const NO_ARGUMENT_GIVEN_MESSAGE = "No argument has been given.",
-      COMMAND_NOT_RECOGNISED_MESSAGE = "The command is not recognised.",
-      INVALID_LINES_PER_PAGE_MESSAGE = "The lines per page must either be a number or left blank for the default of Infinity, which effectively suppresses pagination.",
-      INVALID_CONTENTS_DEPTH_MESSAGE = "The contents depth must be a number between 1 and 4 inclusive, with 1 being primary headings only, 4 down to quaternary headings.",
-      INVALID_CHARACTERS_PER_LINE_MESSAGE = "The characters per line must a number.",
-      FAILED_SERVER_MESSAGE = "Failed to serve.",
-      FAILED_PUBLISH_MESSAGE = "Failed to publish.",
-      FAILED_INITIALISE_MESSAGE = "Failed to create a configuration file because one is already present.",
-      FAILED_SET_OPTIONS_MESSAGE = "Failed to set the options.",
-      SUCCESSFUL_SERVER_MESSAGE = "Served successfully.",
-      SUCCESSFUL_PUBLISH_MESSAGE = "Published successfully.",
-      SUCCESSFUL_INITIALISE_MESSAGE = "The configuration file has been created successfully.",
-      SUCCESSFUL_SET_OPTIONS_MESSAGE = "The options have been set successfully.",
-      UNABLE_TO_COPY_FILE_MESSAGE = "Unable to copy the file.",
-      UNABLE_TO_READ_FILE_MESSAGE = "Unable to read the file.",
-      UNABLE_TO_WRITE_FILE_MESSAGE = "Unable to write the file.",
-      UNABLE_TO_START_SERVER_MESSAGE = "Unable to start the server",
-      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.",
-      CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE = "There is no configuration file. Run 'highmark initialise' to create one.",
-      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.";
-
-module.exports = {
-  NO_ARGUMENT_GIVEN_MESSAGE,
-  COMMAND_NOT_RECOGNISED_MESSAGE,
-  INVALID_LINES_PER_PAGE_MESSAGE,
-  INVALID_CONTENTS_DEPTH_MESSAGE,
-  INVALID_CHARACTERS_PER_LINE_MESSAGE,
-  FAILED_SERVER_MESSAGE,
-  FAILED_PUBLISH_MESSAGE,
-  FAILED_INITIALISE_MESSAGE,
-  FAILED_SET_OPTIONS_MESSAGE,
-  SUCCESSFUL_SERVER_MESSAGE,
-  SUCCESSFUL_PUBLISH_MESSAGE,
-  SUCCESSFUL_INITIALISE_MESSAGE,
-  SUCCESSFUL_SET_OPTIONS_MESSAGE,
-  UNABLE_TO_COPY_FILE_MESSAGE,
-  UNABLE_TO_READ_FILE_MESSAGE,
-  UNABLE_TO_WRITE_FILE_MESSAGE,
-  UNABLE_TO_START_SERVER_MESSAGE,
-  UNABLE_TO_READ_DIRECTORY_MESSAGE,
-  UNABLE_TO_CREATE_DIRECTORY_MESSAGE,
-  UNABLE_TO_PARSE_MARKDOWN_FILE_MESSAGE,
-  CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE,
-  UNABLE_TO_CONVERT_MARKDOWN_TO_HTML_MESSAGE,
-  UNABLE_TO_CONVERT_MARKDOWN_STYLES_TO_CSS_MESSAGE
-};

package/bin/options.js

@@ -1,23 +0,0 @@
-"use strict";
-
-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",
-      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,
-  INPUT_FILE_NAME_OPTION
-};

package/bin/utilities/validate.js

@@ -1,13 +0,0 @@
-"use strict";
-
-function validateLinesPerPage(linesPerPage) { return /^\d*$/.test(linesPerPage); }
-
-function validateContentsDepth(contentsDepth) { return /^1|2|3|4$/.test(contentsDepth); }
-
-function validateCharactersPerLine(charactersPerLine) { return /^\d+$/.test(charactersPerLine); }
-
-module.exports = {
-  validateLinesPerPage,
-  validateContentsDepth,
-  validateCharactersPerLine
-};

package/bin/versions.js

@@ -1,13 +0,0 @@
-"use strict";
-
-const VERSION_1_0 = "1.0",
-      VERSION_1_1 = "1.1",
-      VERSION_1_2 = "1.2",
-      VERSION_1_3 = "1.3";
-
-module.exports = {
-  VERSION_1_0,
-  VERSION_1_1,
-  VERSION_1_2,
-  VERSION_1_3
-};