Skip to content
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

refactor: Construct props must not use the 'any' type (awslint:props-no-any) #2701

Merged
merged 1 commit into from
May 31, 2019

Conversation

shivlaks
Copy link
Contributor

Adds a new awslint:props-no-any rule which validates that props do not use
the "any" type.

This is in accordance with the new AWS Construct Library guidelines.

Fixes #2673


Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
    • Design: For significant features, design document added to design folder
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

…no-any)

Adds a new awslint:props-no-any rule which validates that props do not use
the "any" type.

This is in accordance with the new AWS Construct Library guidelines.

Fixes #2673
@shivlaks shivlaks requested a review from a team as a code owner May 31, 2019 01:06
@@ -51,7 +51,7 @@ export interface PassProps {
*
* @default No injected result
*/
readonly result?: any;
readonly result?: {[key: string]: any};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Call this out as a BREAKING CHANGE in the commit message that you merge.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do

@@ -16,7 +16,7 @@ export interface SubscriptionProps {
*
* The meaning of this value depends on the value for 'protocol'.
*/
readonly endpoint: any;
readonly endpoint: string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Call this out as a BREAKING CHANGE in the commit message that you merge.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do

@shivlaks shivlaks merged commit cb2b334 into master May 31, 2019
@shivlaks shivlaks deleted the shivlaks/awslint-props-no-any branch June 10, 2019 15:42
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
This was referenced Dec 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

awslint:props-no-any
3 participants