Merge pull request #1 from valiton/fix-review-comments

Fix review comments

Author: ChristophP

README.md

@@ -1,7 +1,8 @@
-# AWS PARAM REPLACE
+# AWS PARAM INJECT
 
-This is a simple tool to replace this patter `${ssm:/my/path/to/param}` with the
-value of `/my/path/to/param` in the AWS Parameter store.
+This is a simple tool to inject AWS SSM Parameters into text.
+If text contains pattern like this `${ssm:/my/path/to/param}`,
+it will be injected with the value of the parameter `/my/path/to/param`.
 
 This can for example be used in a Deployment script when we want to fetch and
 inject variables from the Parameter Store into an ECS Task definition.
@@ -29,7 +30,7 @@ MY_TEXT="
 Value=\${ssm:/my/path/to/param1}
 OtherValue=\${ssm:/my/path/to/param2}
 "
-npx -p @valiton/aws-param-replace aws-param-replace "$MY_TEXT"
+npx -p @valiton/aws-param-inject aws-param-inject "$MY_TEXT"
 
 # Outputs:
 #
@@ -41,23 +42,24 @@ npx -p @valiton/aws-param-replace aws-param-replace "$MY_TEXT"
 
 Since `npm ci` will not be available install the package globally first
 ```sh
-npm i -g aws-param-replace
+npm i -g aws-param-inject
 # then run it
-aws-param-replace "..."
+aws-param-inject "..."
 ```
 
 ### Node API
 
 ```js
-const replaceSsmParams = require('aws-param-replace');
+const injectSsmParams = require('@valiton/aws-param-inject');
 
 // Make sure to escape the dollar sign in the template string
 const input = `
 Value=\${ssm:/my/path/to/param1}
 OtherValue=\${ssm:/my/path/to/param2}
 `
 
-replaceSsmParams(input)
+injectSsmParams(input)
+  .then(inputWithInjectedParameters => ...)
 ```
 
 ## Requirements
@@ -66,4 +68,5 @@ Node 8+
 
 ## Credits
 
-Made by [Valiton](https://www.valiton.com/).
+Inspired by the awesome [serverless framework](https://serverless.com/).
+Made my [Valiton](https://www.valiton.com/).

package-lock.json

@@ -1,9 +1,9 @@
 {
-  "name": "@valiton/aws-param-replace",
+  "name": "@valiton/aws-param-inject",
   "version": "1.0.0",
-  "description": "Simple tool to fetch and replace parameters from AWS SSM into a string.",
+  "description": "Simple tool to fetch and inject parameters from AWS SSM into a string.",
   "bin": "src/index.js",
-  "main": "src/replace-ssm-params.js",
+  "main": "src/inject-ssm-params.js",
   "files": [
     "/src/"
   ],

package.json

@@ -1,28 +1,27 @@
 #!/usr/bin/env node
-const replaceSsmParams = require('./replace-ssm-params');
+const injectSsmParams = require('./inject-ssm-params');
 
-const input = process.argv[2];
-
-if (!input) {
-  const usageMsg = `
-Usage: aws-param-replace <String>
+const usageMsg = `\
+Usage: aws-param-inject <String>
 
 <String> can contain any number of patterns like \${ssm:/path/to/param},
-which will be replaced into the input string.
+which will be injected into the input string.
 
 Example:
 
 MY_TEXT="
 Value=\${ssm:/my/path/to/param1}
 OtherValue=\${ssm:/my/path/to/param2}
 "
-aws-param-replace "$MY_TEXT"
-`;
-  console.info(usageMsg);
-  process.exit(1);
-}
+aws-param-inject "$MY_TEXT"`;
+
+const readInput = () => {
+  const input = process.argv[2];
+  return input ? Promise.resolve(input) : Promise.reject(new Error(usageMsg));
+};
 
-replaceSsmParams(input)
+readInput()
+  .then(injectSsmParams)
   .then(console.log)
   .catch(err => {
     console.error(err.message);

src/index.js

@@ -10,9 +10,9 @@ const responseToMap = data =>
     {}
   );
 
-const handleError = invalidParameters => {
+const makeError = invalidParameters => {
   const formattedParams = invalidParameters.join(', ');
-  const errMsg = `\nThe following Parameters could not be fetched from SSM. [${formattedParams}\n]`;
+  const errMsg = `The following Parameters could not be fetched from SSM. [${formattedParams}]`;
   return new Error(errMsg);
 };
 
@@ -24,7 +24,7 @@ const fetchParameters = names =>
       data =>
         data.InvalidParameters.length === 0
           ? Promise.resolve(responseToMap(data))
-          : Promise.reject(handleError(data.InvalidParameters))
+          : Promise.reject(makeError(data.InvalidParameters))
     );
 
 const replaceParameters = input => paramsMap =>