chore: Improve messages

Author: ServerlessLife

README.md

@@ -21,7 +21,7 @@ Serverless is amazing and solves many issues with traditional systems. However,
 
 Lambda Live Debugger connects to your deployed Lambda, routes requests to your computer, and sends responses back to the deployed Lambda. This allows you to debug locally, but the system behaves as if the code is running in the cloud with the same permissions. In case of code changes, you do not have to redeploy. The code is reloaded automatically without deploying or even restarting the debugger.
 
-The tool attaches Lambda Extensions (via a Layer), intercepts, and relays calls to AWS IoT. AWS IoT transfers messages between your Lambda and the local machine. If the Lambda is written in TypeScript, it's transpiled to JavaScript. The code is executed via the Node Worker Thread.
+The tool attaches Lambda Extensions (via a layer), intercepts, and relays calls to AWS IoT. AWS IoT transfers messages between your Lambda and the local machine. If the Lambda is written in TypeScript, it's transpiled to JavaScript. The code is executed via the Node Worker Thread.
 
 ![Architecture](./public/architecture.drawio.png)
 
@@ -34,11 +34,11 @@ AWS keys generated on the cloud for Lambda are transferred to the local environm
 
 Lambda Live Debugger makes the following changes to your AWS infrastructure:
 
-- Deploys the Lambda Layer
-- Attaches the Layer to each Lambda you're debugging
+- Deploys the Lambda layer
+- Attaches the layer to each Lambda you're debugging
 - Adds a policy to the Lambda Role for AWS IoT access
 
-In case you do not want to debug all functions and add the Layer to them, you can limit to the ones you need via the `function` parameter.
+In case you do not want to debug all functions and add the layer to them, you can limit to the ones you need via the `function` parameter.
 
 The tool generates temporary files in the `.lldebugger` folder, which can be deleted after debugging. The wizard can add `.lldebugger` to `.gitignore` for you.
 
@@ -109,7 +109,7 @@ The configuration is saved to `lldebugger.config.ts`.
 
 ```
  -V, --version                   output the version number
- -r, --remove [option]           Remove Lambda Live Debugger infrastructure. Options: 'keep-layer' (default), 'all'. The latest also removes the Lambda Layer
+ -r, --remove [option]           Remove Lambda Live Debugger infrastructure. Options: 'keep-layer' (default), 'all'. The latest also removes the Lambda layer
  -w, --wizard                    Program interactively asks for each parameter and saves it to lldebugger.config.ts
  -v, --verbose                   Verbose logging
  -c, --context <context>         AWS CDK context (default: [])
@@ -187,9 +187,9 @@ When you no longer want to debug and want Lambda to execute the code deployed to
 lld -r
 ```
 
-This detaches the Layer from your Lambdas and removes the IoT permission policy. It will not remove the Layer because others might use it.
+This detaches the layer from your Lambdas and removes the IoT permission policy. It will not remove the layer because others might use it.
 
-To also remove the Layer:
+To also remove the layer:
 
 ```
 lld -r=all

src/configuration/getConfigFromCliArgs.ts

@@ -20,7 +20,7 @@ export async function getConfigFromCliArgs(
   program.name('lld').description('Lambda Live Debugger').version(version);
   program.option(
     '-r, --remove [option]',
-    "Remove Lambda Live Debugger infrastructure. Options: 'keep-layer' (default), 'all'. The latest also removes the Lambda Layer",
+    "Remove Lambda Live Debugger infrastructure. Options: 'keep-layer' (default), 'all'. The latest also removes the Lambda layer",
     //validateRemoveOption,
     //"keep-layer"
   );

src/infraDeploy.ts

@@ -146,23 +146,25 @@ async function findExistingLayerVersion() {
     nextMarker = response.NextMarker;
   } while (nextMarker);
 
-  Logger.verbose('No existing layer found.');
+  Logger.verbose(
+    `No matching layer version found with description ${layerDescription}`,
+  );
 
   return undefined;
 }
 
 /**
- * Get the description of the Lambda Layer that is set to the layer
+ * Get the description of the Lambda layer that is set to the layer
  * @returns
  */
 async function getLayerDescription() {
   if (!layerDescription) {
-    layerDescription = `Lambda Live Debugger Layer version ${await getVersion()}`;
+    layerDescription = `Lambda Live Debugger layer version ${await getVersion()}`;
   }
 
   if ((await getVersion()) === '0.0.1') {
     // add a random string to the description to make it unique
-    layerDescription = `Lambda Live Debugger Layer - development ${crypto.randomUUID()}`;
+    layerDescription = `Lambda Live Debugger layer - development ${crypto.randomUUID()}`;
   }
 
   return layerDescription;
@@ -229,7 +231,7 @@ async function deployLayer() {
 }
 
 /**
- * Delete the Lambda Layer
+ * Delete the Lambda layer
  */
 async function deleteLayer() {
   let nextMarker: string | undefined;
@@ -366,7 +368,6 @@ async function removePolicyFromLambdaRole(roleName: string) {
         PolicyName: inlinePolicyName,
       }),
     );
-    Logger.verbose(`[Role ${roleName}] Policy removed successfully`);
   } catch (error: any) {
     throw new Error(`Failed to remove policy from the role ${roleName}.`, {
       cause: error,
@@ -402,9 +403,7 @@ async function createPolicyDocument(roleName: string) {
     }
   } catch (error: any) {
     if (error.name === 'NoSuchEntityException') {
-      Logger.verbose(
-        `[Role ${roleName}] Policy does not exist (NoSuchEntityException)`,
-      );
+      Logger.verbose(`[Role ${roleName}] Policy does not exist`);
       return undefined;
     } else {
       throw new Error(
@@ -837,7 +836,7 @@ async function analyzeLambdaAdd(
     });
 
     Logger.verbose(
-      `[Function ${functionName}] Layer does not exist at all, need to add it and attach to the function`,
+      `[Function ${functionName}] The layer for this version does not exist in the account. We need to add it and attach it to the function`,
     );
 
     return {
@@ -899,7 +898,7 @@ async function analyzeLambdaAdd(
       if (!environmentVariables || environmentVariables[key] !== value) {
         needToUpdate = true;
         Logger.verbose(
-          `[Function ${functionName}] need to update environment variables`,
+          `[Function ${functionName}] Need to update environment variables`,
         );
         break;
       }

src/lldebugger.ts

@@ -84,7 +84,7 @@ async function run() {
       removalChanges.rolesToRemove.length ||
       Configuration.config.remove === 'all';
 
-    const changesMessage = `\nThe following changes will be applied to your AWS account:${
+    const changesMessage = `The following changes will be applied to your AWS account:${
       (removalChanges.lambdasToRemove.length
         ? `\n - Remove LLD layer and environment variables from Lambdas:\n${removalChanges.lambdasToRemove
             .map((l) => `   - ${l.functionName}`)
@@ -161,7 +161,7 @@ async function run() {
     changes.lambdasToRemove.length ||
     changes.rolesToRemove.length;
 
-  const changesMessage = `\nThe following changes will be applied to your AWS account:${
+  const changesMessage = `The following changes will be applied to your AWS account:${
     (changes.deployLayer
       ? `\n - Deploy Lambda Live Debugger layer version ${version}`
       : '') +