[api-extractor] "ERROR: Internal Error: Unable to analyze the export" when using `var`
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 38/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- typescript
- Área
- tooling
Línea de trabajo
Start with the linked minimal reproduction, tale-of-export-var-and-api-extractor, and run API Extractor against its exported var declaration using the reported TypeScript and Node.js versions. Trace the API Extractor analysis path that produces the reported internal error; done means the reproduction succeeds and the exported variable is handled without that error.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
I want to run api-extractor on a package interface which includes exported var values, which in d.ts manifest as
export declare var __name__: __type__
Repro steps
Minimal repro:
https://github.com/kuhe/tale-of-export-var-and-api-extractor
Expected result:
API extractor succeeds.
Actual result:
Error message:
ERROR: Internal Error: Unable to analyze the export "zero" in
/Users/***/workspace/tale-of-declare-var-and-api-extractor/lib/index.d.ts
You have encountered a software defect. Please consider reporting the issue to the maintainers of this application.
Details
Perhaps the initial reaction will be, like in https://github.com/microsoft/rushstack/issues/3353, that export var is not "recommended".
But I think that should not be up to this library, but rather the user. My team had started using api-extractor for documentation, and now find that we are unable to export vars, but unable to remove api-extractor as a dependency at the moment.
As a workaround, we will likely convert the vars into consts or lets, but shouldn't have to.
Standard questions
Please answer these questions to help us investigate your issue more quickly:
| Question | Answer |
|---|---|
@microsoft/api-extractor version? |
7.55.2 |
| Operating system? | Linux |
| API Extractor scenario? | docs (.api.json) |
| Would you consider contributing a PR? | Yes, if confirmed as unintentional |
| TypeScript compiler version? | 5.9.3 |
Node.js version (node -v)? |
20.5.1 |
- Lenguaje dominante
- TypeScript
- Estrellas
- 6.5k
- Forks
- 708
- Merge medio
- 4 d 7 h
- PR fusionados (30 d)
- 61
Preparar el entorno
Aún no hemos revisado los archivos de configuración de este proyecto. Empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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.
Más de microsoft/rushstack
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
microsoft/rushstack#5971 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
microsoft/rushstack#5902 · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
microsoft/rushstack#5839 · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
microsoft/rushstack#5683 · 3 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
Los mantenedores suelen responder en 1 día
Todos los issues de microsoft/rushstack
Issues similares
-
module-request
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
ports get and web print 'Port N already in use, trying next...' for every busy port they skipAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
appandflow/stim#1604 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
lingdojo/kana-dojo#31060 · 1 comentario · 5 reacciones ·
Los mantenedores suelen responder en 1 día
-
SSH workspace restore rewrites relative symlinks into the deleted sync-back staging directoryAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
paperclipai/paperclip#14173 ·
Los mantenedores suelen responder en 1 día
-
needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día