microsoft / microsoft/TypeScript
Add support for beforeDeclarations
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
🔍 Search Terms
beforeDeclarations declaration transform transformers afterDeclarations
✅ Viability Checklist
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
The TypeScript compiler API already supports custom transformers in 3 ways:
- Before built-in .js transformations
- After built-in .js transformations
- After built-in .d.ts transformations
But the API is missing a "Before built-in .d.ts transformations" variant.
📃 Motivating Example
To generate type declarations more dynamically, you often need to access AST nodes of your codebase as it is written. The built-in transformers erase already a lot of the AST making this information unavailable. With the help of this new beforeDeclarations you are able to access your full AST and use it to auto-generate your typescript declaration files.
💻 Use Cases
- Use information from property initializers to include "default values" your JSDoc comments. (see #41486).
- Remove declarations using information like visibility modifiers or used functions in your code to not expose implementation details.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza revisando las variantes existentes de transformadores personalizados de la TypeScript compiler API, especialmente las etapas before y after de transformación de declaraciones descritas en el issue. Compara las formas de sus API públicas y determina cómo encajaría una etapa beforeDeclarations. Se considera terminado cuando los transformadores personalizados puedan acceder al AST previo a la transformación para la generación de declaraciones y los casos de uso que motivan el cambio estén admitidos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- compilers
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100