winglang/wing

Eslint rule - check that all SDK APIs are exported

Open

#297 aberto em 19 de out. de 2022

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

Métricas do repositório

Stars
 (5.385 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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.

Guia do colaborador

Direção de pesquisa
Pesquise como criar uma regra ESLint personalizada usando TypeScript. Inspecione a estrutura de exportação do SDK para entender quais arquivos precisam ser exportados. Escreva uma regra que percorra a AST para detectar exportações ausentes nos arquivos index.ts, excluindo diretórios internos e arquivos *.util.ts.
Pilha de tecnologia
typescript
Domain
developer experiencetooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60