highmark-cli 0.0.258 → 0.0.260

package/README.md

@@ -51,7 +51,7 @@ Depending on your setup you may need to prepend `sudo` to the above.
 These are the commands and options:
 
 ```
-  highmark [<command>] [<argument>]          
+  highmark [<options>] [<command>] [<argument>]
 
 Commands:
 
@@ -71,6 +71,8 @@ Options:
 
   --watch|-w                                 Watch for changes to the client file and in the output directory 
 
+  --quietly|-q                               Run with almost no console logging
+
   --copy-fonts|-f                            Copy the fonts to a fonts folder next to the output file
 
   --start-server|-s                          Start a server to view the output file

package/bin/action/help.js

@@ -3,7 +3,7 @@
 function helpAction() {
   console.log(`Usage: 
   
-  highmark [<command>] [<argument>]          
+  highmark [<options>] [<command>] [<argument>]
 
 Commands:
 
@@ -23,6 +23,8 @@ Options:
 
   --watch|-w                                 Watch for changes to the client file and in the output directory 
 
+  --quietly|-q                               Run with almost no console logging
+
   --copy-fonts|-f                            Copy the fonts to a fonts folder next to the output file
 
   --start-server|-s                          Start a server to view the output file

package/bin/configuration/version_1_0.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const { VERSION_1_0 } = require("../versions");
+
+function createConfiguration() {
+  const version = VERSION_1_0,
+        configuration = {
+          version
+        };
+
+  return configuration;
+}

package/bin/configuration.js

@@ -0,0 +1,86 @@
+"use strict";
+
+const { versionUtilities, configurationUtilities } = require("necessary");
+
+const { HIGHMARK } = require("./constants"),
+      { VERSION_1_0 } = require("./versions"),
+      { createConfiguration } = require("./configuration/version_1_0"),
+      { CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE } = require("./messages");
+
+const { rc } = configurationUtilities,
+      { migrate } = versionUtilities,
+      { setRCBaseExtension, checkRCFileExists, updateRCFile, writeRCFile, readRCFile } = rc;
+
+const rcBaseExtension = HIGHMARK; ///
+
+setRCBaseExtension(rcBaseExtension);
+
+function createConfigurationFile() {
+  const configuration = createConfiguration(),
+        json = configuration; ///
+
+  writeRCFile(json);
+}
+
+function migrateConfigurationFile() {
+  assertConfigurationFileExists();
+
+  let json = readRCFile();
+
+  const migrationMap = {},
+        latestVersion = VERSION_1_0;
+
+  json = migrate(json, migrationMap, latestVersion);
+
+  writeRCFile(json);
+}
+
+function checkConfigurationFileExists() {
+  const rcFileExists = checkRCFileExists(),
+        configurationFileExists = rcFileExists; ///
+
+  return configurationFileExists;
+}
+
+function assertConfigurationFileExists() {
+  const configurationFileExists = checkConfigurationFileExists();
+
+  if (!configurationFileExists) {
+    console.log(CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE);
+
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  createConfigurationFile,
+  migrateConfigurationFile,
+  checkConfigurationFileExists,
+  assertConfigurationFileExists
+};
+
+function readConfigurationFile() {
+  assertConfigurationFileExists();
+
+  const json = readRCFile(),
+        configuration = json; ///
+
+  return configuration;
+}
+
+function writeConfigurationFile(configuration) {
+  assertConfigurationFileExists();
+
+  const json = configuration; ///
+
+  writeRCFile(json);
+}
+
+function updateConfigurationFile(addedConfiguration, ...deleteConfigurationNames) {
+  assertConfigurationFileExists();
+
+  const addedProperties = addedConfiguration, ///
+        deletedPropertyNames = deleteConfigurationNames;  ///
+
+  updateRCFile(addedProperties, ...deletedPropertyNames);
+}

package/bin/configure.js

@@ -0,0 +1,58 @@
+"use strict";
+
+const { pathUtilities } = require("necessary");
+
+const { DOUBLE_DOTS } = require("./constants"),
+      { DEFAULT_HELP, DEFAULT_VERSION } = require("./defaults"),
+      { HELP_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND } = require("./commands"),
+      { migrateConfigurationFile, checkConfigurationFileExists } = require("./configuration");
+
+const { bottommostNameFromPath } = pathUtilities;
+
+function configure(command, argument, options, main) {
+  let configurationFileExists;
+
+  const { help = DEFAULT_HELP, version = DEFAULT_VERSION } = options;
+
+  if (false) {
+    ///
+  } else if (help) {
+    command = HELP_COMMAND;
+  } else if (version) {
+    command = VERSION_COMMAND;
+  }
+
+  if ((command === HELP_COMMAND) || (command === VERSION_COMMAND)) {
+    main(command, argument, options);
+
+    return;
+  }
+
+  configurationFileExists = checkConfigurationFileExists();
+
+  if (command === null) {
+    if (!configurationFileExists) {
+      const currentWorkingDirectoryPath = process.cwd(); ///
+
+      process.chdir(DOUBLE_DOTS);
+
+      const oldCurrentWorkingDirectoryPath = currentWorkingDirectoryPath; ///
+
+      configurationFileExists = checkConfigurationFileExists();
+
+      if (configurationFileExists) {
+        const bottommostOldCurrentWorkingDirectoryName = bottommostNameFromPath(oldCurrentWorkingDirectoryPath);
+
+        argument = bottommostOldCurrentWorkingDirectoryName; ///
+
+        command = PUBLISH_COMMAND;  ///
+      }
+    }
+  }
+
+  migrateConfigurationFile();
+
+  main(command, argument, options);
+}
+
+module.exports = configure;

package/bin/constants.js

@@ -3,6 +3,8 @@
 const FONT = "font",
       ERROR = "error",
       PERIOD = ".",
+      HIGHMARK = "highmark",
+      DOUBLE_DOTS = "..",
       HIGHMARK_CLI = "Highmark-CLI",
       LIVE_RELOAD_PATH = "/live-reload",
       DIVS_SELECTOR_STRING = "body > div",
@@ -12,6 +14,8 @@ module.exports = {
   FONT,
   ERROR,
   PERIOD,
+  HIGHMARK,
+  DOUBLE_DOTS,
   HIGHMARK_CLI,
   LIVE_RELOAD_PATH,
   DIVS_SELECTOR_STRING,

package/bin/main.js

@@ -5,12 +5,11 @@ const helpAction = require("./action/help"),
       versionAction = require("./action/version"),
       publishAction = require("./action/publish");
 
-const { HELP_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND, START_SERVER_COMMAND } = require("./commands"),
-      { DEFAULT_HELP,
-        DEFAULT_PORT,
+const { NO_COMMAND_GIVEN_MESSAGE, COMMAND_NOT_RECOGNISED_MESSAGE } = require("./messages"),
+      { HELP_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND, START_SERVER_COMMAND } = require("./commands"),
+      { DEFAULT_PORT,
         DEFAULT_WATCH,
         DEFAULT_QUIETLY,
-        DEFAULT_VERSION,
         DEFAULT_COPY_FONTS,
         DEFAULT_START_SERVER,
         DEFAULT_INPUT_FILE_PATH,
@@ -18,45 +17,26 @@ const { HELP_COMMAND, VERSION_COMMAND, PUBLISH_COMMAND, START_SERVER_COMMAND } =
         DEFAULT_OUTPUT_DIRECTORY_PATH } = require("./defaults");
 
 function main(command, argument, options) {
-  const commandMissing = (command === null),
-        { help = DEFAULT_HELP,
-          port = DEFAULT_PORT,
+  const { port = DEFAULT_PORT,
           watch = DEFAULT_WATCH,
           quietly = DEFAULT_QUIETLY,
-          version = DEFAULT_VERSION,
           copyFonts = DEFAULT_COPY_FONTS,
           startServer = DEFAULT_START_SERVER,
           inputFilePath = DEFAULT_INPUT_FILE_PATH,
           copyClientFiles = DEFAULT_COPY_CLIENT_FILES,
           outputDirectoryPath = DEFAULT_OUTPUT_DIRECTORY_PATH } = options;
 
-  if (false) {
-    ///
-  } else if (version) {
-    command = VERSION_COMMAND;
-  } else if (commandMissing) {
-    if (false) {
-      ///
-    } else if (help) {
-      command = HELP_COMMAND;
-    } else if (startServer) {
-      command = START_SERVER_COMMAND;
-    } else {
-      command = PUBLISH_COMMAND;
-    }
-  }
-
   switch (command) {
-    case HELP_COMMAND:  {
-      helpAction();
+    case null: {
+      console.log(NO_COMMAND_GIVEN_MESSAGE);
+
+      process.exit(1);
 
       break;
     }
 
-    case START_SERVER_COMMAND: {
-      const startServer = true;
-
-      serverAction(port, watch, quietly, startServer, outputDirectoryPath);
+    case HELP_COMMAND:  {
+      helpAction();
 
       break;
     }
@@ -72,6 +52,22 @@ function main(command, argument, options) {
 
       break;
     }
+
+    case START_SERVER_COMMAND: {
+      const startServer = true;
+
+      serverAction(port, watch, quietly, startServer, outputDirectoryPath);
+
+      break;
+    }
+
+    default: {
+      console.log(COMMAND_NOT_RECOGNISED_MESSAGE);
+
+      process.exit(1);
+
+      break;
+    }
   }
 }
 

package/bin/messages.js

@@ -1,6 +1,8 @@
 "use strict";
 
-const FAILED_SERVER_MESSAGE = "Failed to serve.",
+const NO_COMMAND_GIVEN_MESSAGE = "No command has been given.",
+      COMMAND_NOT_RECOGNISED_MESSAGE = "The command is not recognised.",
+      FAILED_SERVER_MESSAGE = "Failed to serve.",
       FAILED_PUBLISH_MESSAGE = "Failed to publish.",
       SUCCESSFUL_SERVER_MESSAGE = "Served successfully.",
       SUCCESSFUL_PUBLISH_MESSAGE = "Published successfully.",
@@ -11,10 +13,13 @@ 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.",
+      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_COMMAND_GIVEN_MESSAGE,
+  COMMAND_NOT_RECOGNISED_MESSAGE,
   FAILED_SERVER_MESSAGE,
   FAILED_PUBLISH_MESSAGE,
   SUCCESSFUL_SERVER_MESSAGE,
@@ -26,6 +31,7 @@ module.exports = {
   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/versions.js

@@ -0,0 +1,7 @@
+"use strict";
+
+const VERSION_1_0 = "1.0";
+
+module.exports = {
+  VERSION_1_0
+};

package/highmark.js

@@ -1,14 +1,13 @@
 #!/usr/bin/env node
 
-const necessary = require("necessary");
-
-const { parseArgv } = require("argumentative");
+const { parseArgv } = require("argumentative"),
+      { arrayUtilities } = require("necessary");
 
 const main = require("./bin/main"),
+      configure = require("./bin/configure"),
       abbreviations = require("./bin/abbreviations");
 
 const { argv } = process,
-      { arrayUtilities } = necessary,
       { first, second } = arrayUtilities;
 
 const { commands, options } = parseArgv(argv, abbreviations),
@@ -17,4 +16,4 @@ const { commands, options } = parseArgv(argv, abbreviations),
       command = firstCommand || null, ///
       argument = secondCommand || null; ///
 
-main(command, argument, options);
+configure(command, argument, options, main);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "highmark-cli",
   "author": "James Smith",
-  "version": "0.0.258",
+  "version": "0.0.260",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/highmark-cli",
   "description": "Highmark's LIC tool.",