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

Guidelines implementation: Props #2270

Closed
12 tasks
eladb opened this issue Apr 15, 2019 · 1 comment
Closed
12 tasks

Guidelines implementation: Props #2270

eladb opened this issue Apr 15, 2019 · 1 comment
Labels
effort/medium Medium work item – several days of effort package/awscl Cross-cutting issues related to the AWS Construct Library

Comments

@eladb
Copy link
Contributor

eladb commented Apr 15, 2019

  • Implement and apply rule awslint:props-no-property: Constructs should not have a "props" property that exposes their init props
  • Implement and apply rule awslint:props-coverage: Props should expose the entire surface area of the AWS resource
    • Step functions
    • ECS
    • AutoScaling
  • Implement and apply rule awslint:props-no-arn-refs: Props should use strong types instead of attributres (forbid props with "arn" suffix)
  • Implement and apply rule awslint:props-no-cfn-types: Props should not expose L1 types (types which start with "Cfn")
  • Implement and apply rule awslint:props-no-tokens: Props should not use the "Token" type
  • Implement and apply rule awslint:props-decdk: Props should be deCDK compatible (see doc)
  • Implement and apply rule awslint:props-default-doc: All optional props should have a @default documentation and specify "-" as the default value
  • Implement and apply rule awslint:props-flat: Prop types should not be structs to encourage flat set of props
  • Implement and apply rule awslint:props-no-unions: Props should not use TypeScript unions
@eladb eladb added the package/awscl Cross-cutting issues related to the AWS Construct Library label Apr 15, 2019
@eladb eladb added the effort/medium Medium work item – several days of effort label Apr 15, 2019
@eladb
Copy link
Contributor Author

eladb commented May 1, 2019

Split into multiple issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/medium Medium work item – several days of effort package/awscl Cross-cutting issues related to the AWS Construct Library
Projects
None yet
Development

No branches or pull requests

1 participant