occam-verify-cli 0.0.382 → 0.0.384

package/bin/abbreviations.js

@@ -1,11 +1,13 @@
 "use strict";
 
-const { LOG_LEVEL_OPTION, RELEASE_NAME_OPTION } = require("./options");
+const { HELP_OPTION, VERSION_OPTION, LOG_LEVEL_OPTION } = require("./options");
 
-const l = LOG_LEVEL_OPTION,
-      p = RELEASE_NAME_OPTION;
+const h = HELP_OPTION,
+      v = VERSION_OPTION,
+      l = LOG_LEVEL_OPTION
 
 module.exports = {
-  l,
-  p
+  h,
+  v,
+  l
 };

package/bin/action/help.js

@@ -0,0 +1,34 @@
+"use strict";
+
+function helpAction() {
+  console.log(`Usage: 
+  
+  verify [<options>] [<argument>]                 Verify the specified project
+
+  verify [<command>]  [<options>] [<argument>]    
+
+Commands:
+
+  version                                         Show the version
+
+  help                                            Show this help
+  
+Options:
+
+  --help|-h                                       Show this help
+
+  --version|-v                                    Show the version
+
+  --log-level|-l                                  Set the log level when publishing
+
+Further information:
+
+Please see the readme file on GitHub:
+
+  https://github.com/djalbat/occam-verify-cli
+`);
+
+  process.exit();
+}
+
+module.exports = helpAction;

package/bin/action/verify.js

@@ -0,0 +1,46 @@
+"use strict";
+
+const { loggingUtilities } = require("necessary"),
+      { verifyRelease, releaseContextUtilities } = require("../../lib/index");
+
+const { releaseContextFromReleaseNameAndShortenedVersion } = require("../utilities/fileSystem");
+
+const { log } = loggingUtilities,
+      { setLogLevel } = log,
+      { createReleaseContext, initialiseReleaseContexts } = releaseContextUtilities;
+
+function verifyAction(argument, logLevel) {
+  const releaseName = argument, ///
+        releaseContextMap = {},
+        shortenedVersion = null,
+        dependentNames = [],
+        context = {
+          log,
+          releaseContextMap,
+          releaseContextFromReleaseNameAndShortenedVersion
+        };
+
+  setLogLevel(logLevel);
+
+  createReleaseContext(releaseName, dependentNames, shortenedVersion, context, (error) => {
+    if (error) {
+      ///
+
+      return;
+    }
+
+    initialiseReleaseContexts(releaseName, releaseContextMap);
+
+    const releaseVerified = verifyRelease(releaseName, releaseContextMap);
+
+    if (releaseVerified) {
+      const releaseContext = releaseContextMap[releaseName];
+
+      releaseContext.toJSON();
+
+      ///
+    }
+  });
+}
+
+module.exports = verifyAction;

package/bin/action/version.js

@@ -0,0 +1,15 @@
+"use strict";
+
+const { VERIFY_CLI } = require("../constants"),
+      { getPackageVersion } = require("../utilities/packageJSON");
+
+function versionAction() {
+  const packageVersion = getPackageVersion(),
+        version = packageVersion; ///
+
+  console.log(`${VERIFY_CLI} version ${version}`);
+
+  process.exit();
+}
+
+module.exports = versionAction;

package/bin/actions.js

@@ -0,0 +1,40 @@
+"use strict";
+
+const helpAction = require("./action/help"),
+      verifyAction = require("./action/verify"),
+      versionAction = require("./action/version");
+
+const { DEFAULT_HELP, DEFAULT_VERSION, DEFAULT_LOG_LEVEL } = require("./defaults"),
+      { HELP_COMMAND,
+        VERIFY_COMMAND,
+        VERSION_COMMAND } = require("./commands");
+
+function actions(command, argument, options) {
+  const commandMissing = (command === null),
+        { help = DEFAULT_HELP,
+          version = DEFAULT_VERSION,
+          logLevel = DEFAULT_LOG_LEVEL } = options;
+
+  if (false) {
+    ///
+  } else if (help) {
+    command = HELP_COMMAND;
+  } else if (version) {
+    command = VERSION_COMMAND;
+  } else if (commandMissing) {
+    command = HELP_COMMAND;
+  }
+
+  switch (command) {
+    case HELP_COMMAND : helpAction(); break;
+    case VERIFY_COMMAND : verifyAction(argument, logLevel); break;
+    case VERSION_COMMAND : versionAction(); break;
+
+    default:
+      argument = command; ///
+
+      verifyAction(argument, logLevel);
+  }
+}
+
+module.exports = actions;

package/bin/commands.js

@@ -0,0 +1,11 @@
+"use strict";
+
+const HELP_COMMAND = "help",
+      VERIFY_COMMAND = "verify",
+      VERSION_COMMAND = "version";
+
+module.exports = {
+  HELP_COMMAND,
+  VERIFY_COMMAND,
+  VERSION_COMMAND
+};

package/bin/constants.js

@@ -0,0 +1,9 @@
+"use strict";
+
+const VERIFY_CLI = "Verify-CLI",
+      PACKAGE_JSON = "package.json";
+
+module.exports = {
+  VERIFY_CLI,
+  PACKAGE_JSON
+};

package/bin/defaults.js

@@ -4,8 +4,12 @@ const { levels } = require("necessary");
 
 const { INFO_LEVEL } = levels;
 
-const DEFAULT_LOG_LEVEL = INFO_LEVEL;
+const DEFAULT_HELP = false,
+      DEFAULT_VERSION = false,
+      DEFAULT_LOG_LEVEL = INFO_LEVEL;
 
 module.exports = {
+  DEFAULT_HELP,
+  DEFAULT_VERSION,
   DEFAULT_LOG_LEVEL
 };

package/bin/main.js

@@ -1,49 +1,9 @@
 "use strict";
 
-const { arrayUtilities, loggingUtilities } = require("necessary"),
-      { verifyRelease, releaseContextUtilities } = require("../lib/index");
+const actions = require("./actions");
 
-const { DEFAULT_LOG_LEVEL } = require("./defaults"),
-      { releaseContextFromReleaseNameAndShortenedVersion } = require("./utilities/fileSystem");
-
-const { log } = loggingUtilities,
-      { first } = arrayUtilities,
-      { setLogLevel } = log,
-      { createReleaseContext, initialiseReleaseContexts } = releaseContextUtilities;
-
-function main(commands, options) {
-  const firstCommand = first(commands),
-        { logLevel = DEFAULT_LOG_LEVEL, releaseName = firstCommand } = options, ///
-        releaseContextMap = {},
-        shortenedVersion = null,
-        dependentNames = [],
-        context = {
-          log,
-          releaseContextMap,
-          releaseContextFromReleaseNameAndShortenedVersion
-        };
-
-  setLogLevel(logLevel);
-
-  createReleaseContext(releaseName, dependentNames, shortenedVersion, context, (error) => {
-    if (error) {
-      ///
-
-      return;
-    }
-
-    initialiseReleaseContexts(releaseName, releaseContextMap);
-
-    const releaseVerified = verifyRelease(releaseName, releaseContextMap);
-
-    if (releaseVerified) {
-      const releaseContext = releaseContextMap[releaseName];
-
-      releaseContext.toJSON();
-
-      ///
-    }
-  });
+function main(command, argument, options) {
+  actions(command, argument, options);
 }
 
 module.exports = main;

package/bin/options.js

@@ -1,9 +1,11 @@
 "use strict";
 
-const LOG_LEVEL_OPTION = "log-level",
-      RELEASE_NAME_OPTION = "package-name";
+const HELP_OPTION = "help",
+      VERSION_OPTION = "version",
+      LOG_LEVEL_OPTION = "log-level";
 
 module.exports = {
-  LOG_LEVEL_OPTION,
-  RELEASE_NAME_OPTION
+  HELP_OPTION,
+  VERSION_OPTION,
+  LOG_LEVEL_OPTION
 };

package/bin/utilities/packageJSON.js

@@ -0,0 +1,26 @@
+"use strict";
+
+const { arrayUtilities, fileSystemUtilities } = require("necessary");
+
+const { PACKAGE_JSON } = require("../constants");
+
+const { second } = arrayUtilities,
+      { readFile } = fileSystemUtilities;
+
+const utilitiesDirectoryName = __dirname, ///
+      matches = utilitiesDirectoryName.match(/^(.+)\/bin\/utilities$/),
+      secondMatch = second(matches),
+      applicationDirectoryName = secondMatch, ///
+      packageJSONFilePath = `${applicationDirectoryName}/${PACKAGE_JSON}`,
+      packageJSONFile = readFile(packageJSONFilePath),
+      packageJSON = JSON.parse(packageJSONFile),
+      { version } = packageJSON,
+      packageVersion = version;  ///
+
+function getPackageVersion() {
+  return packageVersion;
+}
+
+module.exports = {
+  getPackageVersion
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "occam-verify-cli",
   "author": "James Smith",
-  "version": "0.0.382",
+  "version": "0.0.384",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/occam-verify-cli",
   "description": "Occam's Verifier",
@@ -33,5 +33,8 @@
     "watch": "npm run clean && npm run batch && npm run incremental",
     "watch-debug": "npm run clean && npm run batch-debug && npm run incremental-debug"
   },
-  "main": "./lib/index.js"
+  "main": "./lib/index.js",
+  "bin": {
+    "verify": "./verify.js"
+  }
 }

package/verify.js

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