winglang/wing

Eslint rule - check that all SDK APIs are exported

Open

#297 opened on Oct 19, 2022

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

Repository metrics

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

Description

It would be handy to have a custom eslint plugin that asserts that all typescript files are exported to the root of the SDK. Any exported APIs inside a directory named internal or with the pattern *.util.ts can be excluded.

In my experience it's pretty easy to forget to re-export a module in index.ts, so a linter rule would help.

Contributor guide

Research direction
Research how to create a custom ESLint rule using TypeScript. Inspect the SDK's export structure to understand what files need to be exported. Write a rule that traverses the AST to detect missing exports in index.ts files, excluding internal directories and *.util.ts files.
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60