-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(cloudformation-diff): Fix aws-sdk dependency issue #28680
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request
. Additionally, if clarification is needed add Clarification Request
to a comment.
latest version of aws-sdk
Exemption Request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can the underlying issue be fixed instead by changing the offending import from
import { CloudFormation } from 'aws-sdk';
to
import type { CloudFormation } from 'aws-sdk';
The only reason the import is being is used is to get the type not to make any actual API calls. Changing the import should help make that clearer and prevent accidentally needing the aws-sdk
at runtime.
In this case, the eslint-disable
comment can be removed too since it's no longer an extraneous import.
Thanks for investigating @kylelaker, I just confirmed that your fix works on the reproduction repo. @frankpengau can you please confirm if using |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much for this fix and for adjusting your PR based on the review feedback! This will definitely be a helpful change. Great catch!
Exemption Request |
@kylelaker @comcalvi Is there anything else required from my end to get this change in? |
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
…get CFN types resolved in exports (#28768) Issue still persists after #28680. ``` node_modules/@aws-cdk/cloudformation-diff/lib/diff-template.d.ts:1:37 - error TS2307: Cannot find module 'aws-sdk' or its corresponding type declarations. 1 import type { CloudFormation } from 'aws-sdk'; ~~~~~~~~~ Found 1 error in node_modules/@aws-cdk/cloudformation-diff/lib/diff-template.d.ts:1 ``` Types are still required as a direct dependency in package.json. Closes #28679 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
…get CFN types resolved in exports (aws#28768) Issue still persists after aws#28680. ``` node_modules/@aws-cdk/cloudformation-diff/lib/diff-template.d.ts:1:37 - error TS2307: Cannot find module 'aws-sdk' or its corresponding type declarations. 1 import type { CloudFormation } from 'aws-sdk'; ~~~~~~~~~ Found 1 error in node_modules/@aws-cdk/cloudformation-diff/lib/diff-template.d.ts:1 ``` Types are still required as a direct dependency in package.json. Closes aws#28679 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Missing dependency when exporting
@aws-cdk/cloudformation-diff
in custom AWS Construct Library.Closes #28679
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license