feat: #122 Add SAM stack name parameter (#123)

* feat: #122 Add SAM stack name parameter

* chore: add documentation

Author: ServerlessLife

README.md

@@ -120,6 +120,7 @@ The configuration is saved to `lldebugger.config.ts`.
  --config-env <evironment>       SAM environment
  --sam-config-file <file>        SAM configuration file
  --sam-template-file <file>      SAM template file
+ --sam-stack-name <name>         SAM stack name;
  --profile <profile>             AWS profile to use
  --region <region>               AWS region to use
  --role <role>                   AWS role to use

src/configuration/getConfigFromCliArgs.ts

@@ -54,6 +54,7 @@ export async function getConfigFromCliArgs(
   program.option('--config-env <evironment>', 'SAM environment');
   program.option('--sam-config-file <file>', 'SAM configuration file');
   program.option('--sam-template-file <file>', 'SAM template file');
+  program.option('--sam-stack-name <name>', 'SAM stack name');
   program.option('--profile <profile>', 'AWS profile to use');
   program.option('--region <region>', 'AWS region to use');
   program.option('--role <role>', 'AWS role to use');

src/configuration/getConfigFromWizard.ts

@@ -139,6 +139,14 @@ export async function getConfigFromWizard({
           default:
             configFromCliArgs.samTemplateFile ?? currentConfig?.samTemplateFile,
         },
+        {
+          type: 'input',
+          name: 'samStackName',
+          message:
+            'Would you like to enter SAM stack name and not use the one from config?',
+          default:
+            configFromCliArgs.samStackName ?? currentConfig?.samStackName,
+        },
       ]);
 
       answers = { ...answers, ...samAnswers };
@@ -421,6 +429,8 @@ export default {
   samConfigFile: "${config.samConfigFile}",
   // SAM framework template file
   samTemplateFile: "${config.samTemplateFile}",
+  // SAM framework stack name
+  samStackName: "${config.samStackName}",
   // Observable mode
   observable: ${config.observable},
   // Observable mode interval
@@ -468,6 +478,7 @@ function getConfigFromAnswers(answers: any): LldConfigCliArgs {
     configEnv: answers.configEnv,
     samConfigFile: answers.samConfigFile,
     samTemplateFile: answers.samTemplateFile,
+    samStackName: answers.samStackName,
     observable: answers.observable,
     interval:
       answers.interval !== undefined

src/frameworks/samFramework.ts

@@ -90,7 +90,13 @@ export class SamFramework implements IFramework {
       samConfig = yaml.parse(samConfigContent);
     }
 
-    const stackName = samConfig[environment]?.global?.parameters?.stack_name;
+    let stackName: string | undefined;
+
+    if (config.samStackName) {
+      stackName = config.samStackName;
+    } else {
+      stackName = samConfig[environment]?.global?.parameters?.stack_name;
+    }
 
     if (!stackName) {
       throw new Error(`Stack name not found in ${samConfigFile}`);

src/types/lldConfig.ts

@@ -56,6 +56,11 @@ export type LldConfigBase = {
    */
   samTemplateFile?: string;
 
+  /**
+   * SAM framework cli parameter stack-name
+   */
+  samStackName?: string;
+
   /**
    * Resources discovery function
    */