refactor(awslint): construct-base-is-private, resource-attribute #2349
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
April 22, 2019 15:07
Implement a "Reflection" class for each rule family (modules, constructs, resources) which reflect on the type system and expose a relevant API for linter rules. The rational is that this increases our ability to reuse the model by other rule families. For example, the "ResourceReflection" extends "ConstructReflection" and adds more information that's specific to AWS resource constructs.
eladb
changed the title
add awslint:construct-base-is-private - eks.ClusterBase - codebuild.ProjectBase - codecommit.RepositoryBase - codedeploy.ServerDeploymentGroupBase - ecr.RepositoryBase - eks.ClusterBase - lambda.LayerVersionBase - rds.DatabaseClusterBase - secretsmanager.SecretBase - ses.ReceiptRuleSetBase - update "foreach.sh" to ignore undefined npm scripts - update contribution guide with instructions on how to use foreach.sh
eladb
changed the title
RomainMuller
added
the
package/awscl
eladb
removed
package/awscl
SanderKnape
pushed a commit
to SanderKnape/aws-cdk
that referenced
this pull request
May 14, 2019
…#2349) Refactor the rule implementation of awslint such that the context of each linter is implemented as a `XxxReflection` class (i.e. `ConstructReflection`, `ResourceReflection`). This increases our ability to reuse the model extracted from the type system in other linters. - `awslint:construct-base-is-private` will recommend that XxxBase are internal (required merging some files in some places) - `awslint:resource-attribute`: implement missing attributes from several modules - In some places, move the `ImportedXxx` class into the import method as a local class (makes the implementation much nicer because it's closed by the function call). Misc: - update "foreach.sh" to ignore undefined npm scripts - update contribution guide with instructions on how to use foreach.sh Fixes aws#2426 Fixes aws#2409 BREAKING CHANGE: `s3.Bucket.domainName` renamed to `s3.Bucket.bucketDomainName`. * `codedeploy.IXxxDeploymentConfig.deploymentConfigArn` is now a property and not a method. * `ec2.SecurityGroupBase` is now private * `ec2.VpcNetworkBase` is now private * `kinesis.StreamBase` is now private * `kms.EncryptionKeyBase` is now private * `logs.LogGroupBase` is now private * `ssm.ParameterBase` is now private * `eks.ClusterBase` is now private * `codebuild.ProjectBase` is now private * `codecommit.RepositoryBase` is now private * `codedeploy.ServerDeploymentGroupBase` is now private * `eks.ClusterBase` is now private * `lambda.LayerVersionBase` is now private * `rds.DatabaseClusterBase` is now private * `secretsmanager.SecretBase` is now private * `ses.ReceiptRuleSetBase` is now private
|
Thanks so much for taking the time to contribute to the AWS CDK ❤️ We will shortly assign someone to review this pull request and help get it
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refactor the rule implementation of awslint such that the context of each linter is implemented as a
XxxReflectionclass (i.e.ConstructReflection,ResourceReflection). This increases our ability to reuse the model extracted from the type system in other linters.awslint:construct-base-is-privatewill recommend that XxxBase are internal (required merging some files in some places)awslint:resource-attribute: implement missing attributes from several modulesImportedXxxclass into the import method as a local class (makes the implementation much nicer because it's closed by the function call).Misc:
Fixes #2426
Fixes #2409
BREAKING CHANGE:
s3.Bucket.domainNamerenamed tos3.Bucket.bucketDomainName.codedeploy.IXxxDeploymentConfig.deploymentConfigArnis now a property and not a method.ec2.SecurityGroupBaseis now privateec2.VpcNetworkBaseis now privatekinesis.StreamBaseis now privatekms.EncryptionKeyBaseis now privatelogs.LogGroupBaseis now privatessm.ParameterBaseis now privateeks.ClusterBaseis now privatecodebuild.ProjectBaseis now privatecodecommit.RepositoryBaseis now privatecodedeploy.ServerDeploymentGroupBaseis now privateeks.ClusterBaseis now privatelambda.LayerVersionBaseis now privaterds.DatabaseClusterBaseis now privatesecretsmanager.SecretBaseis now privateses.ReceiptRuleSetBaseis now privatePull Request Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.