occam-open-cli 5.1.0 → 5.1.1

package/README.md

@@ -57,6 +57,8 @@ Commands:
 
   reset-password [<email_address>]               Reset password 
 
+  set-shell-commands                             Set shell commands 
+
 Options:
 
   --help|-h                                      Show this help

package/bin/action/help.js

@@ -31,6 +31,8 @@ Commands:
 
   reset-password [<email_address>]               Reset password 
 
+  set-shell-commands                             Set shell commands 
+
 Options:
 
   --help|-h                                      Show this help

package/bin/action/publish.js

@@ -5,6 +5,7 @@ const publishOperation = require("../operation/publish"),
       packReleaseOperation = require("../operation/packRelease"),
       getIdentityTokenOperation = require("../operation/getIdentityToken"),
       releaseNamePromptOperation = require("../operation/prompt/releaseName"),
+      executeShellCommandsOperation = require("../operation/executeShallCommands"),
       updateMetaJSONFileVersionOperation = require("../operation/updateMetaJSONFileVersion");
 
 const { DOUBLE_DASH } = require("../constants"),
@@ -20,7 +21,8 @@ function publishAction(argument, dryRun, logLevel) {
           loadProjectOperation,
           packReleaseOperation,
           publishOperation,
-          updateMetaJSONFileVersionOperation
+          updateMetaJSONFileVersionOperation,
+          executeShellCommandsOperation
         ],
         success = false,
         context = {

package/bin/action/setShellCommands.js

@@ -0,0 +1,33 @@
+"use strict";
+
+const setShellCommandsPromptOperation = require("../operation/prompt/setShellCommands");
+
+const { executeOperations } = require("../utilities/operation"),
+      { retrieveShellCommands, updateShellCommands } = require("../configuration"),
+      { FAILED_SET_SHELL_COMMANDS_MESSAGE, SUCCESSFUL_SET_SHELL_COMMANDS_MESSAGE } = require("../messages");
+
+function setShellCommandsAction() {
+  const operations = [
+          setShellCommandsPromptOperation
+        ],
+        shellCommands = retrieveShellCommands(),
+        context = {
+          shellCommands
+        };
+
+  executeOperations(operations, (completed) => {
+    if (!completed) {
+      console.log(FAILED_SET_SHELL_COMMANDS_MESSAGE);
+
+      return;
+    }
+
+    const { shellCommands } = context;
+
+    updateShellCommands(shellCommands);
+
+    console.log(SUCCESSFUL_SET_SHELL_COMMANDS_MESSAGE);
+  }, context);
+}
+
+module.exports = setShellCommandsAction;

package/bin/actions.js

@@ -11,7 +11,8 @@ const helpAction = require("./action/help"),
       initialiseAction = require("./action/initialise"),
       setOptionsAction = require("./action/setOptions"),
       createAccountAction = require("./action/createAccount"),
-      resetPasswordAction = require("./action/resetPassword");
+      resetPasswordAction = require("./action/resetPassword"),
+      setShellCommandsAction = require("./action/setShellCommands");
 
 const { DEFAULT_NO, DEFAULT_YES, DEFAULT_HELP, DEFAULT_DRY_RUN, DEFAULT_VERSION, DEFAULT_QUIETLY, DEFAULT_LOG_LEVEL } = require("./defaults"),
       { HELP_COMMAND,
@@ -25,7 +26,8 @@ const { DEFAULT_NO, DEFAULT_YES, DEFAULT_HELP, DEFAULT_DRY_RUN, DEFAULT_VERSION,
         INITIALISE_COMMAND,
         SET_OPTIONS_COMMAND,
         CREATE_ACCOUNT_COMMAND,
-        RESET_PASSWORD_COMMAND } = require("./commands");
+        RESET_PASSWORD_COMMAND,
+        SET_SHELL_COMMANDS_COMMAND } = require("./commands");
 
 function actions(command, argument, options) {
   const commandMissing = (command === null),
@@ -60,6 +62,7 @@ function actions(command, argument, options) {
     case SET_OPTIONS_COMMAND : setOptionsAction(); break;
     case CREATE_ACCOUNT_COMMAND : createAccountAction(argument); break;
     case RESET_PASSWORD_COMMAND : resetPasswordAction(argument); break;
+    case SET_SHELL_COMMANDS_COMMAND : setShellCommandsAction(); break;
 
     default:
       argument = command; ///

package/bin/commands.js

@@ -11,7 +11,8 @@ const HELP_COMMAND = "help",
       INITIALISE_COMMAND = "initialise",
       SET_OPTIONS_COMMAND = "set-options",
       CREATE_ACCOUNT_COMMAND = "create-account",
-      RESET_PASSWORD_COMMAND = "reset-password";
+      RESET_PASSWORD_COMMAND = "reset-password",
+      SET_SHELL_COMMANDS_COMMAND = "set-shell-commands";
 
 module.exports = {
   HELP_COMMAND,
@@ -25,5 +26,6 @@ module.exports = {
   INITIALISE_COMMAND,
   SET_OPTIONS_COMMAND,
   CREATE_ACCOUNT_COMMAND,
-  RESET_PASSWORD_COMMAND
+  RESET_PASSWORD_COMMAND,
+  SET_SHELL_COMMANDS_COMMAND
 };

package/bin/configuration/version_5_1.js

@@ -0,0 +1,38 @@
+"use strict";
+
+const { VERSION_5_1 } = require("../versions"),
+      { DEFAULT_HOST, DEFAULT_SHELL_COMMANDS } = require("../defaults");
+
+function createConfiguration() {
+  const version = VERSION_5_1,
+        host = DEFAULT_HOST,
+        options = {},
+        shellCommands = DEFAULT_SHELL_COMMANDS,
+        identityToken = null,
+        configuration = {
+          version,
+          host,
+          options,
+          shellCommands,
+          identityToken
+        };
+
+  return configuration;
+}
+
+function migrateConfigurationToVersion_5_1(configuration) {
+  const version = VERSION_5_1,
+        shellCommands = DEFAULT_SHELL_COMMANDS;
+
+  Object.assign(configuration, {
+    version,
+    shellCommands
+  });
+
+  return configuration;
+}
+
+module.exports = {
+  createConfiguration,
+  migrateConfigurationToVersion_5_1
+};

package/bin/configuration.js

@@ -3,11 +3,12 @@
 const { configurationUtilities } = require("necessary");
 
 const { OPEN } = require("./constants"),
-      { CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE } = require("./messages"),
       { migrateConfigurationToVersion_1_5 } = require("./configuration/version_1_5"),
       { migrateConfigurationToVersion_2_0 } = require("./configuration/version_2_0"),
-      { UNVERSIONED, VERSION_1_5, VERSION_2_0, CURRENT_VERSION } = require("./versions"),
-      { migrateConfigurationToVersion_5_0, createConfiguration } = require("./configuration/version_5_0");
+      { migrateConfigurationToVersion_5_0 } = require("./configuration/version_5_0"),
+      { CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE } = require("./messages"),
+      { migrateConfigurationToVersion_5_1, createConfiguration } = require("./configuration/version_5_1"),
+      { UNVERSIONED, VERSION_1_5, VERSION_2_0, VERSION_5_0, CURRENT_VERSION } = require("./versions");
 
 const { rc } = configurationUtilities,
       { setRCBaseExtension, checkRCFileExists, updateRCFile, writeRCFile, readRCFile } = rc;
@@ -16,34 +17,47 @@ const rcBaseExtension = OPEN;
 
 setRCBaseExtension(rcBaseExtension);
 
-function getHost() {
+function retrieveHost() {
   const configuration = readConfigurationFile(),
         { host } = configuration;
 
   return host;
 }
 
-function getOptions() {
+function retrieveOptions() {
   const configuration = readConfigurationFile(),
         { options } = configuration;
 
   return options;
 }
 
-function getIdentityToken() {
+function retrieveShellCommands() {
+  const configuration = readConfigurationFile(),
+        { shellCommands } = configuration;
+
+  return shellCommands;
+}
+
+function retrieveIdentityToken() {
   const configuration = readConfigurationFile(),
         { identityToken } = configuration;
 
   return identityToken;
 }
 
-function setOptions(options) {
+function updateOptions(options) {
   updateConfigurationFile({
     options
   });
 }
 
-function setIdentityToken(identityToken) {
+function updateShellCommands(shellCommands) {
+  updateConfigurationFile({
+    shellCommands
+  });
+}
+
+function updateIdentityToken(identityToken) {
   updateConfigurationFile({
     identityToken
   });
@@ -61,30 +75,34 @@ function createConfigurationFile() {
 }
 
 function migrateConfigurationFile() {
-  let version;
-
-  let json = readRCFile();
-
-  let configuration = json; ///
-
-  version = configuration.version || UNVERSIONED; ///
+  let json = readRCFile(),
+      configuration = json, ///
+      { version = UNVERSIONED } = configuration;
 
   while (version !== CURRENT_VERSION) {
     switch (version) {
       case UNVERSIONED :
         configuration = migrateConfigurationToVersion_1_5(configuration);
+
         break;
 
       case VERSION_1_5 :
         configuration = migrateConfigurationToVersion_2_0(configuration);
+
         break;
 
       case VERSION_2_0 :
         configuration = migrateConfigurationToVersion_5_0(configuration);
+
+        break;
+
+      case VERSION_5_0 :
+        configuration = migrateConfigurationToVersion_5_1(configuration);
+
         break;
     }
 
-    version = configuration.version || UNVERSIONED; ///
+    ({ version } = configuration);
   }
 
   json = configuration; ///
@@ -100,11 +118,13 @@ function checkConfigurationFileExists() {
 }
 
 module.exports = {
-  getHost,
-  getOptions,
-  getIdentityToken,
-  setOptions,
-  setIdentityToken,
+  retrieveHost,
+  retrieveOptions,
+  retrieveShellCommands,
+  retrieveIdentityToken,
+  updateOptions,
+  updateShellCommands,
+  updateIdentityToken,
   removeIdentityToken,
   createConfigurationFile,
   migrateConfigurationFile,

package/bin/defaults.js

@@ -2,6 +2,8 @@
 
 const { levels } = require("necessary");
 
+const { EMPTY_STRING } = require("./constants");
+
 const { INFO_LEVEL } = levels;
 
 const DEFAULT_NO = false,
@@ -12,6 +14,7 @@ const DEFAULT_NO = false,
       DEFAULT_VERSION = false,
       DEFAULT_QUIETLY = false,
       DEFAULT_LOG_LEVEL = INFO_LEVEL,
+      DEFAULT_SHELL_COMMANDS = EMPTY_STRING,
       DEFAULT_GITHUB_HOST_NAME = "github.com";
 
 module.exports = {
@@ -23,5 +26,6 @@ module.exports = {
   DEFAULT_VERSION,
   DEFAULT_QUIETLY,
   DEFAULT_LOG_LEVEL,
+  DEFAULT_SHELL_COMMANDS,
   DEFAULT_GITHUB_HOST_NAME
 };

package/bin/descriptions.js

@@ -6,6 +6,7 @@ const USE_SSH_DESCRIPTION = "Use SSH when cloning: ",
       RELEASE_NAME_DESCRIPTION = "Package name: ",  ///
       ARE_YOU_SURE_DESCRIPTION = "Are you sure? (y)es (n)o: ",
       EMAIL_ADDRESS_DESCRIPTION = "Email address: ",
+      SHELL_COMMANDS_DESCRIPTION = "Shell command(s) to run after successful publishing: ",
       CONFIRM_PASSWORD_DESCRIPTION = "Confirm password: ",
       GITHUB_HOST_NAME_DESCRIPTION = "GitHub host name (leave blank for default): ",
       CLONE_DEPENDENCIES_DESCRIPTION = "Clone dependencies? (y)es (n)o: ",
@@ -18,6 +19,7 @@ module.exports = {
   RELEASE_NAME_DESCRIPTION,
   ARE_YOU_SURE_DESCRIPTION,
   EMAIL_ADDRESS_DESCRIPTION,
+  SHELL_COMMANDS_DESCRIPTION,
   CONFIRM_PASSWORD_DESCRIPTION,
   GITHUB_HOST_NAME_DESCRIPTION,
   CLONE_DEPENDENCIES_DESCRIPTION,

package/bin/messages.js

@@ -18,12 +18,14 @@ const PASSWORDS_DO_NOT_MATCH_MESSAGE = "The passwords do not match.",
       FAILED_DEPRECATE_MESSAGE = "Failed to deprecate the package.",
       FAILED_INITIALISE_MESSAGE = "Failed to create a configuration file because one is already present.",
       FAILED_SET_OPTIONS_MESSAGE = "Failed to set the options.",
+      FAILED_SET_SHELL_COMMANDS_MESSAGE = "Failed to set the shell commands.",
       SUCCESSFUL_OPEN_MESSAGE = "The package has been opened successfully.",
       SUCCESSFUL_CLONE_MESSAGE = "The package has been cloned successfully.",
       SUCCESSFUL_PUBLISH_MESSAGE = "The package has been published successfully.",
       SUCCESSFUL_DEPRECATE_MESSAGE = "The package has been deprecated successfully.",
       SUCCESSFUL_INITIALISE_MESSAGE = "The configuration file has been created successfully.",
-      SUCCESSFUL_SET_OPTIONS_MESSAGE = "The options have been set successfully.";
+      SUCCESSFUL_SET_OPTIONS_MESSAGE = "The options have been set successfully.",
+      SUCCESSFUL_SET_SHELL_COMMANDS_MESSAGE = "The shell commands have been set successfully.";
 
 module.exports = {
   PASSWORDS_DO_NOT_MATCH_MESSAGE,
@@ -44,10 +46,12 @@ module.exports = {
   FAILED_DEPRECATE_MESSAGE,
   FAILED_INITIALISE_MESSAGE,
   FAILED_SET_OPTIONS_MESSAGE,
+  FAILED_SET_SHELL_COMMANDS_MESSAGE,
   SUCCESSFUL_OPEN_MESSAGE,
   SUCCESSFUL_CLONE_MESSAGE,
   SUCCESSFUL_PUBLISH_MESSAGE,
   SUCCESSFUL_DEPRECATE_MESSAGE,
   SUCCESSFUL_INITIALISE_MESSAGE,
-  SUCCESSFUL_SET_OPTIONS_MESSAGE
+  SUCCESSFUL_SET_OPTIONS_MESSAGE,
+  SUCCESSFUL_SET_SHELL_COMMANDS_MESSAGE
 };

package/bin/operation/clone.old.js

@@ -5,7 +5,7 @@ const { exec } = require("child_process"),
 
 const { checkEntryExists } = fileSystemUtilities;
 
-const { getOptions } = require("../configuration"),
+const { retrieveOptions } = require("../configuration"),
       { DEFAULT_GITHUB_HOST_NAME } = require("../defaults");
 
 function cloneOperation(proceed, abort, context) {
@@ -27,7 +27,7 @@ function cloneOperation(proceed, abort, context) {
 
   let { repository } = context;
 
-  const options = getOptions(),
+  const options = retrieveOptions(),
         { ssh } = options;
 
   if (ssh) {

package/bin/operation/cloneReleases.js

@@ -4,7 +4,7 @@ const { exec } = require("child_process"),
       { Entries } = require("occam-file-system"),
       { fileSystemUtilities, asynchronousUtilities } = require("necessary");
 
-const { getOptions } = require("../configuration"),
+const { retrieveOptions } = require("../configuration"),
       { DEFAULT_GITHUB_HOST_NAME } = require("../defaults");
 
 const { checkEntryExists } = fileSystemUtilities;
@@ -53,7 +53,7 @@ function cloneReleasePromptOperation(release, next, done, context, index) {
 function cloneRelease(release, quietly, done) {
   let repository = repositoryFromRelease(release)
 
-  const options = getOptions(),
+  const options = retrieveOptions(),
         { ssh } = options;
 
   if (ssh) {

package/bin/operation/executeShallCommands.js

@@ -0,0 +1,20 @@
+"use strict";
+
+const { EMPTY_STRING } = require("../constants");
+const { retrieveShellCommands } = require("../configuration");
+
+function executeShellCommandsOperation(proceed, abort, context) {
+  const { success } = context;
+
+  if (success) {
+    const shellCommands = retrieveShellCommands();
+
+    if (shellCommands !== EMPTY_STRING) {
+      debugger
+    }
+  }
+
+  proceed();
+}
+
+module.exports = executeShellCommandsOperation;

package/bin/operation/getIdentityToken.js

@@ -1,9 +1,9 @@
 "use strict";
 
-const { getIdentityToken } = require("../configuration");
+const { retrieveIdentityToken } = require("../configuration");
 
 function getIdentityTokenOperation(proceed, abort, context) {
-  const identityToken = getIdentityToken();
+  const identityToken = retrieveIdentityToken();
 
   if (!identityToken) {
     abort();

package/bin/operation/prompt/setShellCommands.js

@@ -0,0 +1,34 @@
+"use strict";
+
+const { shellUtilities } = require("necessary");
+
+const { EMPTY_STRING } = require("../../constants"),
+      { validateShellCommands } = require("../../utilities/validate"),
+      { DEFAULT_SHELL_COMMANDS } = require("../../defaults"),
+      { SHELL_COMMANDS_DESCRIPTION } = require("../../descriptions");
+
+const { prompt } = shellUtilities;
+
+function setShellCommandsPromptOperation(proceed, abort, context) {
+  const { shellCommands } = context,
+        initialAnswer = shellCommands, ///
+        validationFunction = validateShellCommands,  ///
+        description = SHELL_COMMANDS_DESCRIPTION,
+        options = {
+          description,
+          initialAnswer,
+          validationFunction
+        };
+
+  prompt(options, (answer) => {
+    const shellCommands = answer; ///
+
+    Object.assign(context, {
+      shellCommands
+    });
+
+    proceed();
+  });
+}
+
+module.exports = setShellCommandsPromptOperation;

package/bin/operation/setIdentityToken.js

@@ -1,12 +1,12 @@
 "use strict";
 
-const { setIdentityToken } = require("../configuration");
+const { updateIdentityToken } = require("../configuration");
 
 function setIdentityTokenOperation(proceed, abort, context) {
   const { identityToken } = context;
 
   if (identityToken !== null) {
-    setIdentityToken(identityToken);
+    updateIdentityToken(identityToken);
   }
 
   proceed();

package/bin/operation/setOptions.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const { setOptions } = require("../configuration");
+const { updateOptions } = require("../configuration");
 
 function setOptionsOperation(proceed, abort, context) {
   const { useSSH } = context,
@@ -17,7 +17,7 @@ function setOptionsOperation(proceed, abort, context) {
     });
   }
 
-  setOptions(options);
+  updateOptions(options);
 
   proceed();
 }

package/bin/post.js

@@ -3,7 +3,7 @@
 const { Readable } = require("stream"),
       { headers, contentTypes, statusCodes, requestUtilities } = require("necessary");
 
-const { getHost } = require("./configuration"),
+const { retrieveHost } = require("./configuration"),
       { getPackageVersion } = require("./utilities/packageJSON"),
       { contentFromResponse } = require("./utilities/response"),
       { statusMessageFromStatusCode } = require("./utilities/status"),
@@ -15,7 +15,7 @@ const { createPostRequest } = requestUtilities,
       { APPLICATION_JSON_CHARSET_UTF_8_CONTENT_TYPE } = contentTypes;
 
 function post(uri, json, callback) {
-  const host = getHost(),
+  const host = retrieveHost(),
         query = {},
         headers = getHeaders(),
         content = JSON.stringify(json), ///

package/bin/utilities/validate.js

@@ -12,6 +12,8 @@ function validateReleaseName(releaseName) { return /^[a-z0-9]{2,16}(?:-[a-z0-9]{
 
 function validateEmailAddress(emailAddress) { return /^[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,16}$/.test(emailAddress); }
 
+function validateShellCommands(shellCommands) { return  /^.*$/.test(shellCommands); }
+
 function validateGitHubHostName(gitHubHostName) { return /^[a-zA-Z0-9.\-]*$/.test(gitHubHostName); }
 
 function validateEmailAddressOrUsername(emailAddressOrUsername) {
@@ -39,6 +41,7 @@ module.exports = {
   validateAffirmation,
   validateReleaseName,
   validateEmailAddress,
+  validateShellCommands,
   validateGitHubHostName,
   validateEmailAddressOrUsername
 };

package/bin/versions.js

@@ -4,12 +4,14 @@ const UNVERSIONED = "unversioned",
       VERSION_1_5 = "1.5",
       VERSION_2_0 = "2.0",
       VERSION_5_0 = "5.0",
-      CURRENT_VERSION = VERSION_5_0;  ///
+      VERSION_5_1 = "5.1",
+      CURRENT_VERSION = VERSION_5_1;  ///
 
 module.exports = {
   UNVERSIONED,
   VERSION_1_5,
   VERSION_2_0,
   VERSION_5_0,
+  VERSION_5_1,
   CURRENT_VERSION
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "occam-open-cli",
   "author": "James Smith",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/occam-open-cli",
   "description": "Occam's command line package management tool.",
@@ -11,7 +11,7 @@
   },
   "dependencies": {
     "argumentative": "^2.0.21",
-    "necessary": "^11.2.0",
+    "necessary": "^11.2.2",
     "occam-file-system": "^5.0.134"
   },
   "scripts": {},