aws-cloudformation / aws-cloudformation/cloudformation-cli-typescript-plugin
bug: @ts-ignore causing issues when libchecking providers
- Lenguaje dominante
- TypeScript
- Estrellas
- 46
- Forks
- 18
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
i am unable to do libChecking on my providers as [this](https://github.com/aws-cloudformation/cloudformation-cli-typescript-plugin/commit/e656c332f3233a9c0ee82b4c84952baf9d75f100) commit adds `@ts-ignore` directives to the `interface Integer` [here](https://github.com/aws-cloudformation/cloudformation-cli-typescript-plugin/blob/c6741811d918954b2bead0aa844400d236537581/src/interface.ts#L69-L82).
for this is problematic as it causes the following issue when building my resources (below).
i think the suggestion in the commit message is that resources should disable "lib checking". I dont see this as a great solution as it applies to all libraries. As i use aws-sdkv3 in my resources (and additional components i build using smithy), i have more than once caught issues due to incompatibilities between transient dependencies.
reviewing the code i am also not able to understand _why_ the code was added to the interface. browsing through the issues and commit messages doesn't seem to provide answers to this question either.
any recommended path forward is greatly appreciated.
@kddejong, @ericzbeard
```
node_modules/@amazon-web-services-cloudformation/cloudformation-cli-typescript-lib/dist/interface.d.ts:30:11 - error TS2430: Interface 'Integer' incorrectly extends interface 'BigInt'.
Types of property '[Symbol.toStringTag]' are incompatible.
Type '"Integer"' is not assignable to type '"BigInt"'.
30 interface Integer extends BigInt {
~~~~~~~
node_modules/@amazon-web-services-cloudformation/cloudformation-cli-typescript-lib/dist/interface.d.ts:35:11 - error TS2430: Interface 'IntegerConstructor' incorrectly extends interface 'BigIntConstructor'.
Types of property 'prototype' are incompatible.
Type 'Integer' is not assignable to type 'BigInt'.
35 interface IntegerConstructor extends BigIntConstructor {
````
Guía de contribución
Línea de trabajo
Comienza con src/interface.ts, especialmente con las líneas 69-82, y compáralo con el archivo generado node_modules/@amazon-web-services-cloudformation/cloudformation-cli-typescript-lib/dist/interface.d.ts. Reproduce el fallo de lib-check/build de TypeScript informado y rastrea por qué se añadieron las declaraciones Integer e IntegerConstructor. La tarea está terminada cuando el provider puede ejecutar lib-check sin los errores TS2430 informados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- node.js, typescript
- Área
- build-system, tooling
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 32/100