♻️ refactor: cli improvement, some renamings

Author: Guy7B

cli/index.js

@@ -21,33 +21,38 @@ const options = parseArgs(process.argv.slice(2),{
   number: ['tNumber'],
 });
 
-(() => {
-  const [command] = options._;
-  if(command === 'help' || !command) {
-    console.info('Available commands:');
-    Object.entries(COMMAND_DESCRIPTION).forEach(([key, value]) => {
-      console.info(`  ${key} - ${value}\n`);
-    });
-
-    return;
-  }
+const showHelp = () => {
+  console.info('Available commands:');
+  Object.entries(COMMAND_DESCRIPTION).forEach(([key, value]) => {
+    console.info(`  ${key} - ${value}\n`);
+  });
+};
 
+(() => {
   if (options.interactive) {
     const importJsx = require('import-jsx');
     importJsx('./Components/App');
-  } else {
+    process.exit(0);
+  }
+
+  const [command] = options._;
+  if(command === 'help') {
+    showHelp();
+    process.exit(0);
+  }
+
+  if (command) {
     if(options.help) {
       console.info(HELP_COMMANDS[command]);
-      return;
+      process.exit(0);
     }
     scripts[command](options).then(() => {
       console.info(`"${command}" command run successfully.`);
       process.exit(0);
     }).catch((error) => {
-      console.error(error, `An error has occured while running transformation (${command}).`);
+      console.error(error, `An error has occured while running command (${command}).`);
       process.exit(1);
     });
   }
-})();
-
 
+})();

examples/serverless-localstack/data-transformations/UsersExample/v2_add_random_number_field.js

@@ -22,6 +22,5 @@ const transformDown = async ({ ddb, isDryRun }) => {
 module.exports = {
   transformUp,
   transformDown,
-  // prepare, // pass this function only if you need preparation data for the transformation
   transformationNumber: 2,
 };

examples/serverless-localstack/serverless.yml

@@ -17,12 +17,11 @@ provider:
     PREPARATION_DATA_BUCKET: transformations-preparation-data-${self:provider.stage}
 
 plugins:
-    - serverless-localstack
-    - serverless-manifest-plugin
-    - serverless-dotenv-plugin
-    - serverless-pseudo-parameters
-    - dynamo-data-transform
-
+  - serverless-localstack
+  - serverless-manifest-plugin
+  - serverless-dotenv-plugin
+  - serverless-pseudo-parameters
+  - dynamo-data-transform
 custom:
   localstack:
     hostname:

serverless-plugin/commands.js

@@ -39,7 +39,7 @@ module.exports = {
         },
       },
       prepare: {
-        usage: `"sls dynamodt prepare --table {{TABLE_NAME}} --tNumber 1" - ${COMMAND_DESCRIPTION.prepare}`,
+        usage: `"sls dynamodt prepare --table <table> --tNumber <transformation_number>" - ${COMMAND_DESCRIPTION.prepare}`,
         lifecycleEvents: ['prepare'],
         options: {
           tNumber: COMMAND_OPTIONS.tNumber,
@@ -48,15 +48,15 @@ module.exports = {
         },
       },
       down: {
-        usage: `sls dynamodt down --table {{TABLE_NAME}} - ${COMMAND_DESCRIPTION.down}`,
+        usage: `sls dynamodt down --table <table> - ${COMMAND_DESCRIPTION.down}`,
         lifecycleEvents: ['rollback'],
         options: {
           table: COMMAND_OPTIONS.table,
           dry: COMMAND_OPTIONS.dry,
         },
       },
       history: {
-        usage: `sls dynamodt history --table {{TABLE_NAME}} -  ${COMMAND_DESCRIPTION.history}`,
+        usage: `sls dynamodt history --table <table> -  ${COMMAND_DESCRIPTION.history}`,
         lifecycleEvents: ['history'],
         options: {
           table: COMMAND_OPTIONS.table,

src/config/transformation-template-file.js

@@ -29,7 +29,7 @@ const transformDown = async ({ ddb, isDryRun }) => {
 module.exports = {
   transformUp,
   transformDown,
-  // prepare, // pass this function only if you need preparation data for the transformation
+  // prepare, // export this function only if you need preparation data for the transformation
   transformationNumber: 1,
 };