Aws-cdk: Make awslint publicly available

Created on 4 Mar 2019  路  5Comments  路  Source: aws/aws-cdk

It would be nice if you could make awslint public available as npm package, so that other people who want to publish CDK libraries can also benefit from it and design their libs also according to the AWS Resource Construct Design Guidelines.

efformedium feature-request in-progress managemendevenv

Most helpful comment

Note: this is taking a bit longer to do because currently awslint is tightly coupled with the CloudFormation model, so there is no real value in running it on anything else. The idea is the move some of the rules so they will apply to any construct and then it makes total sense to reuse

All 5 comments

Sure, that should be fairly easy to do

Note: this is taking a bit longer to do because currently awslint is tightly coupled with the CloudFormation model, so there is no real value in running it on anything else. The idea is the move some of the rules so they will apply to any construct and then it makes total sense to reuse

Still releavnt

+1 Please do this. My team is working on a Construct library, and we currently have awslint copied into our repo. Would be nice to consume a package instead of having to keep our copy up to date.

I don't see any major blocker from running awslint against another repository anymore. With CloudFormation registry everybody can build CloudFormation resources and build CDK constructs on top.

Some minor changes required:

  • [x] Make it a separate package. I suggest moving it to packages/awslint and keep the name? Not scoping it to @aws-cdk/ namespace
  • [ ] The namespace for guessing L1 constructs is hard-coded (code). That me means all L2 constructs need to be marked with @resource annotation. That was hard-coded before as well but now works since CDK v1.37.0 (PR) generic
  • [ ] The module-name linter enforces a module name pattern @aws-cdk/aws- (code). First of all the namespace @aws-cdk/ can鈥檛 be used by any project. But also the naming for aws-<namespace> would not work for all. Not optimal but the rule can be disabled manually for now when consuming awslint.
  • [ ] The no-unused-type linter only runs on @aws-cdk/aws- packages (code).
Was this page helpful?
0 / 5 - 0 ratings

Related issues

nzspambot picture nzspambot  路  3Comments

artyom-melnikov picture artyom-melnikov  路  3Comments

pepastach picture pepastach  路  3Comments

eladb picture eladb  路  3Comments

Kent1 picture Kent1  路  3Comments