aws / aws/aws-cdk

eslint rules for CDK apps

Open
#32,293 1 comment 2 reactions 0 assignees View on GitHub
effort/medium feature-request p1 package/tools
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the feature

We should have a collection of linter rules to help write CDK apps. There are common mistakes that are hard to prevent at runtime, and require static source analysis.

Examples:

* Don't use variable names in construct IDs
* Don't mix L1 and L2 types
* Don't pass `scope` but pass `this`

Etc. I'm sure we can come up with more. Put your best ideas in here!

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points. Start by defining the rule collection and its scope from the listed examples, then identify where ESLint rules for CDK apps belong; done means an agreed set of useful static checks with corresponding implementation and test locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, eslint, typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.