CDK ENV Check

Check any environment variables expected by AWS CDK are present in your codebase.

It's easy to make mistakes and forget to implement or simply misspell the necessary environment variables in your codebase.

Usage

npx cdk-env-check --exclude=... <CDK_PROJECT_PATH> [CODEBASE_PATHS...]

--exclude=: Optional argument(s) to exclude certain environment variables from the check. You can provide multiple environment variables. For example, --exclude=AWS_REGION --exclude=CDK_DEFAULT_ACCOUNT.

<CDK_PROJECT_PATH>: The path to the CDK project directory.

[CODEBASE_PATHS...]: Optional subsequent arguments specifying paths to codebase directories to check. You can provide multiple paths separated by spaces.

Example usage:

Check environment variables with a CDK project located at ./lib and codebase directories at ./common and ./lambda-fs

npx cdk-env-check ./lib ./common ./lambda-fs

Check environment variables with a CDK project located at ./cdk-project and a single codebase directory at ./src

npx cdk-env-check ./cdk-project ./src

Check environment variables with CDK project and codebase located at ./infra (same directorie)

npx cdk-env-check ./infra ./infra