chore(awslint): new rules for reference interfaces #27790
Conversation
mrgrain
changed the title
mrgrain
had a problem deploying
to
test-pipeline
GitHub Actions
Failure
There was a problem hiding this comment.
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.
aws-cdk-automation
added
the
pr/needs-cli-test-run
mrgrain
force-pushed
the
mrgrain/chore/awslint
branch
from
6fc8b10
to
e6f6804
Compare
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
mrgrain
force-pushed
the
mrgrain/chore/awslint
branch
4 times, most recently
from
ebbaa51
to
fade49e
Compare
| e.assert(resourceInterface.extends(interfaceBase), resourceInterface.fqn); | ||
| }, | ||
| }); | ||
|
|
||
| /* | ||
| // This rule is the worst |
| `If this is intentional, add "${EXCLUDE_ANNOTATION_REF_VIA_INTERFACE}" to element's jsdoc`, | ||
| eval: e => { | ||
| eval: (e) => { |
There was a problem hiding this comment.
This rule hasn't changed. I just refactored the code used to visit spec nodes to be reusable.
| const EXCLUDE_ANNOTATION_REF_VIA_INTERFACE = | ||
| '[disable-awslint:ref-via-interface]'; | ||
|
|
||
| const EXCLUDE_ANNOTATION_REF_VIA_REF_INTERFACE = | ||
| '[disable-awslint:ref-via-ref-interface]'; |
There was a problem hiding this comment.
I considered wrapping them both into a single rule, but found it too confusing and complicated.
Now we have two rules:
ref-via-interfaceguarantees that we are not expecting concrete instances of constructsref-via-ref-interfaceguarantees that we preferICfnWhateverreference interfaces overIWhateverinterfaces
mrgrain
changed the title
|
Generally looks good to me - did you see what impact this had on the lint times? |
I'll check that. |
mrgrain
force-pushed
the
mrgrain/chore/awslint
branch
from
fade49e
to
b43e155
Compare
|
Adds about 5s to awslint. Deeming this as acceptable. I am working on some speed-ups for the linter. |
Introducing two new rules, and immediately accepting all current violations.
resource-interface-extends-resource-ref- all resources interfaces likeIBucketmust also implement the reference interface, e.g.ICfnBucketref-via-ref-interface- all APIs should accept the reference interfaceICfnBucketover the resource interfaceIBucketBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license