chore: clean up the code, add inline docs (#6)

.projenrc.js

@@ -51,7 +51,7 @@ const deployTask = project.addTask('integ:exec:deploy');
 deployTask.exec(`rm -fr ${appDir}`);
 deployTask.exec(`cdk --app "${tsNode} test/exec.integ.ts" deploy --output ${appDir}`);
 
-const cliCmd = `${tsNode} src/cli/cdk-exec.ts --app ${appDir} exec`;
+const cliCmd = `${tsNode} src/cli/cdk-exec.ts --app ${appDir}`;
 project.addTask('integ:exec:sfn:succeed', {
   exec: `${cliCmd} integ-cdk-exec/StateMachine --input '{"succeed":true}'`,
 });

README.md

@@ -2,7 +2,20 @@
 
 Provides `cdk-exec`, a command to tighten up your AWS CDK development loop by
 helping you find and execute the physical resources for your lambdas and state
-machines, with or without input. Example: `cdk-exec my-stack/MyLambda`
+machines, with or without input.
+
+```
+$ cdk-exec integ-cdk-exec/Function --input '{"succeed":true}'
+✨  Executing integ-cdk-exec-Function76856677-k5ehIzbG2T6S
+
+Output:
+{
+  "succeed": true,
+  "message": "Hello from Lambda"
+}
+
+✅  Execution succeeded
+```
 
 > WARNING: Do not rely on this tool to execute your functions in a production
 > environment. Now that you have been warned, please read on.
@@ -64,7 +77,7 @@ $ cdk synth --output cdk.out
 
 ```
 $ cdk-exec integ-cdk-exec/StateMachine --input '{"succeed":true}'
-✨  Executing arn:aws:states:REGION:0000000000:stateMachine:StateMachine2E01A3A5-kPnq1OgV5KYX
+✨  Executing arn:aws:states:REGION:000000000000:stateMachine:StateMachine2E01A3A5-8z4XHXAvT3qq
 
 Output:
 {
@@ -78,7 +91,7 @@ Output:
 
 ```
 $ cdk-exec integ-cdk-exec/Function --input '{"succeed":true}'
-✨  Executing arn:aws:states:REGION:0000000000:stateMachine:StateMachine2E01A3A5-kPnq1OgV5KYX
+✨  Executing integ-cdk-exec-Function76856677-k5ehIzbG2T6S
 
 Output:
 {
@@ -93,7 +106,7 @@ Output:
 
 ```
 $ cdk-exec --app path/to/cdkout integ-cdk-exec/Function --input '{"json":"here"}'
-✨  Executing arn:aws:states:REGION:0000000000:stateMachine:StateMachine2E01A3A5-kPnq1OgV5KYX
+✨  Executing integ-cdk-exec-Function76856677-k5ehIzbG2T6S
 
 Output:
 {

src/aws-sdk.ts

@@ -1,11 +1,25 @@
 import AWS from 'aws-sdk';
 
 export interface IAwsSdk {
+  /**
+   * Get the CloudFormation client.
+   */
   cloudFormation(): AWS.CloudFormation;
+
+  /**
+   * Get the StepFunctions SDK client.
+   */
   stepFunctions(): AWS.StepFunctions;
+
+  /**
+   * Get the Lambda SDK client.
+   */
   lambda(): AWS.Lambda;
 }
 
+/**
+ * Creates AWS SDK clients.
+ */
 export class AwsSdk implements IAwsSdk {
   cloudFormation(): AWS.CloudFormation {
     return new AWS.CloudFormation();
@@ -18,6 +32,9 @@ export class AwsSdk implements IAwsSdk {
   }
 }
 
+/**
+ * List stack resources.
+ */
 export class LazyListStackResources {
   private readonly stackName: string;
   private readonly cloudFormation: AWS.CloudFormation;

src/cli/cdk-exec.ts

@@ -3,7 +3,7 @@ import * as cxapi from 'aws-cdk-lib/cx-api';
 import chalk from 'chalk';
 import * as yargs from 'yargs';
 import { AwsSdk } from '../aws-sdk';
-import { AmbiguousPathError, getExecutor } from '../executor';
+import { AmbiguousPathError, Executor } from '../executor';
 
 async function main(): Promise<number> {
   const args: any = yargs
@@ -29,20 +29,31 @@ async function main(): Promise<number> {
   });
 }
 
-export interface ExecCmdOptions {
+export interface CdkExecOptions {
+  /**
+   * App directory.
+   */
   readonly app: string;
-  readonly constructPath: string;
+
+  /**
+   * Path of the construct to execute.
+   */
+  readonly constructPath?: string;
+
+  /**
+   * Execution input.
+   */
   readonly input?: string;
 }
 
-export async function cdkExec(options: ExecCmdOptions): Promise<number> {
+export async function cdkExec(options: CdkExecOptions): Promise<number> {
   const assembly = new cxapi.CloudAssembly(options.app);
 
   try {
-    const executor = await getExecutor({
-      sdk: new AwsSdk(),
-      constructPath: options.constructPath,
+    const executor = await Executor.find({
       assembly,
+      constructPath: options.constructPath,
+      sdk: new AwsSdk(),
     });
 
     if (!executor) {