add docstring to create prompter methods

Author: vicheey

packages/core/src/shared/ui/sam/bucketPrompter.ts

@@ -18,6 +18,13 @@ export enum BucketSource {
     UserProvided,
 }
 
+/**
+ * Creates a quick pick prompter for configuring S3 bucket used for sync or deploy application artifact
+ * Provides two options:
+ * 1. Create a SAM CLI managed bucket
+ * 2. Specify an existing bucket
+ * @returns A QuickPick prompter configured with bucket source options
+ */
 export function createBucketSourcePrompter() {
     const items: DataQuickPickItem<BucketSource>[] = [
         {
@@ -37,6 +44,13 @@ export function createBucketSourcePrompter() {
     })
 }
 
+/**
+ * Creates a quick pick prompter for configuring S3 bucket name used for sync or deploy application artifact
+ * The prompter supports choosing from existing s3 bucket name or creating a new one
+ * @param client S3 client
+ * @param mementoRootKey Memento key to store recent bucket name (e.g 'samcli.deploy.params')
+ * @returns A quick pick prompter configured with bucket name options
+ */
 export function createBucketNamePrompter(client: DefaultS3Client, mementoRootKey: string) {
     const recentBucket = getRecentResponse(mementoRootKey, client.regionCode, 'bucketName')
     const items = client.listBucketsIterable().map((b) => [

packages/core/src/shared/ui/sam/ecrPrompter.ts

@@ -14,6 +14,14 @@ import { getRecentResponse } from '../../sam/utils'
 export const localize = nls.loadMessageBundle()
 export const prefixNewRepoName = (name: string) => `newrepo:${name}`
 
+/**
+ * Creates a quick pick prompter for ECR repositories
+ * The prompter supports choosing from existing option and new repositories by entering a name
+ *
+ * @param client ECR client used to list repositories
+ * @param mementoRootKey Key used to store/retrieve recently used repository (e.g 'samcli.deploy.params')
+ * @returns A quick pick prompter configured for ECR repository
+ */
 export function createEcrPrompter(client: DefaultEcrClient, mementoRootKey: string) {
     const recentEcrRepo = getRecentResponse(mementoRootKey, client.regionCode, 'ecrRepoUri')
     const consoleUrl = getAwsConsoleUrl('ecr', client.regionCode)

packages/core/src/shared/ui/sam/paramsSourcePrompter.ts

@@ -34,6 +34,12 @@ function loadParamsSourcePrompterItems(existValidSamconfig: boolean | undefined)
     return items
 }
 
+/**
+ * Creates a quick pick prompter for SAM deploy parameter source selection
+ *
+ * @param existValidSamconfig Whether a valid samconfig.toml file exist and contain necessary flag for SAM sync operation
+ * @returns A quick pick prompter
+ */
 export function createDeployParamsSourcePrompter(existValidSamconfig: boolean | undefined) {
     const items = loadParamsSourcePrompterItems(existValidSamconfig)
 
@@ -44,6 +50,13 @@ export function createDeployParamsSourcePrompter(existValidSamconfig: boolean |
     })
 }
 
+/**
+ * Creates a quick pick prompter for SAM sync parameter source selection
+ *
+ * @param existValidSamconfig Whether a valid samconfig.toml file exist and contain necessary flag for SAM sync operation
+ * @returns A quick pick prompter
+ */
+
 export function createSyncParamsSourcePrompter(existValidSamconfig: boolean | undefined) {
     const items = loadParamsSourcePrompterItems(existValidSamconfig)
 

packages/core/src/shared/ui/sam/stackPrompter.ts

@@ -17,6 +17,15 @@ const canPickStack = (s: StackSummary) => s.StackStatus.endsWith('_COMPLETE')
 const canShowStack = (s: StackSummary) =>
     (s.StackStatus.endsWith('_COMPLETE') || s.StackStatus.endsWith('_IN_PROGRESS')) && !s.StackStatus.includes('DELETE')
 
+/**
+ * Creates a quick pick prompter for choosing a CloudFormation stack
+ * The promper supports selecting from existing options or creating a new stack by entering a name
+ *
+ * @param client - CloudFormation client to use for listing stacks
+ * @param mementoRootKey - Key used to store/retrieve recently used stack (e.g 'samcli.deploy.params')
+ * @returns A quick pick prompter configured for stack selection
+ *
+ */
 export function createStackPrompter(client: DefaultCloudFormationClient, mementoRootKey: string) {
     const recentStack = getRecentResponse(mementoRootKey, client.regionCode, 'stackName')
     const consoleUrl = getAwsConsoleUrl('cloudformation', client.regionCode)

packages/core/src/shared/ui/sam/templatePrompter.ts

@@ -22,6 +22,18 @@ export interface TemplateItem {
     readonly data: CloudFormation.Template
 }
 
+/**
+ * Creates a quick pick prompter for choosing SAM/CloudFormation templates
+ *
+ * @param registry - Registry containing CloudFormation templates
+ * @param mementoRootKey - Root key for storing recent template selections (e.g 'samcli.deploy.params')
+ * @param projectRoot - Optional URI of the project root to filter templates
+ * @returns A QuickPick prompter configured for template selection
+ *
+ * The prompter displays a list of SAM/CloudFormation templates found in the workspace.
+ * Templates are shown with relative paths when possible, and workspace folder names when multiple folders exist.
+ * Recently used templates are marked. If no templates are found, provides a help link.
+ */
 export function createTemplatePrompter(
     registry: CloudFormationTemplateRegistry,
     mementoRootKey: string,