winglang/wing

wing-api-checker rule that every resource has an @inflight annotation

Open

#320 opened on Oct 24, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (214 forks)github user discovery
good first issue🎨 sdk👷‍♀️ contributor-experience📚 documentation

Repository metrics

Stars
 (5,385 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We'd like to update wing-api-checker to perform a check that if a class extends Resource then it (or one of its superclasses) has a docstring annotation for @inflight. This annotation is needed so that the Wing compiler can infer the type information of the inflight methods of the resource and associate it with the resource.

For example, here is one such annotation:

https://github.com/winglang/wing/blob/c07ec23a7179f5a6c56018ff83fdb8071e3d79a7/libs/wingsdk/src/sim/bucket.ts#L9-L13

The wing-api-checker uses jsii-reflect to traverse the type information of the SDK's APIs. There is limited documentation online for it, but you can take a look at the existing wing-api-checker code to see how its used to check for other missing docstring information: https://github.com/winglang/wing/blob/b8bcf153624e82c18499d98c521221e089e8d449/apps/wing-api-checker/src/index.ts#L59-L61

Contributor guide

Research direction
Examine the existing wing api checker code to understand how it uses jsii reflect to traverse types and check docstring annotations. Implement a new rule that checks for @inflight annotation on Resource classes.
Tech stack
typescript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptjsii reflect
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60