cdk-insights 1.8.0 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -150,8 +150,13 @@ export interface CdkInsightsAspectOptions {
150
150
  }
151
151
  /**
152
152
  * Helper function to check if CDK stack traces are enabled.
153
- * Users should set CDK_DEBUG=true or add context @aws-cdk/core:stackTrace: true
154
- * for the most reliable source location capture.
153
+ * Three paths CDK honours, in order of how a user typically sets them:
154
+ * 1. `CDK_DEBUG=true` env var (per-shell, transient).
155
+ * 2. `CDK_CONTEXT_JSON` env containing the `@aws-cdk/core:stackTrace` flag
156
+ * (used by `cdk synth --context @aws-cdk/core:stackTrace=true`).
157
+ * 3. `cdk.json` `context['@aws-cdk/core:stackTrace'] = true` (durable, the
158
+ * path `cdk-insights setup` configures so users don't have to remember
159
+ * anything).
155
160
  */
156
161
  export declare const isCdkDebugEnabled: () => boolean;
157
162
  /**