microsoft / microsoft/TypeScript
Node module dependencies that use a triple-slash directive to reference libs poison the global scope
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
TypeScript Version: 2.x, 3.x
Search Terms: lib.dom.d.ts pollutes global scope, name is defined as never, event is defined as Event | undefined
See: https://github.com/AaronFriel/is-test/blob/4e235decffdfd3c137ea066f8462d57d2fc8d0f2/src/index.ts at the commit hash linked.
Expected behavior:
Given a tsconfig.json with lib: [], I would expect the following code to fail to build due to $variable not defined errors:
import is from '@sindresorhus/is';
function main() {
console.log(name);
console.log(event);
console.log(caches);
console.log(applicationCache);
console.log(parent);
}
Actual behavior:
See: https://github.com/AaronFriel/is-test/blob/master/src/index.ts for a particularly egregious example of this. It builds without any type errors. When running npm run start, it will throw a runtime error on the first console.log. If you remove that line, the next one fails, and so on, for the next 700+ lines.
General purpose libraries often need to be written to handle multiple versions of ES (ES5, ES6, ES7...) and multiple host environments (e.g.: DOM, ScriptHost, WebWorker). But right now they are faced with a choice:
A: Use a triple slash directive to import types that they use, and poison the user's global scope, causing nearly one thousand variable names to be silently accepted as defined without any type checker errors.
B: Remove the triple slash directives and require that users use the --skipLibCheck option or equivalent in their config file or include the required libs in their compiler options. Otherwise the library will fail to type check.
This is a choice that library authors would quite reasonably not want to make.
Potential solutions:
-
Triple slash directives should import types only in dependencies.
This seems tricky to implement, I think.
-
There should be a types-only version of the major lib files, so that general-purpose utility packages can reference those instead.
This seems less tricky: extract all the types from the
domlib a newdom-typeslib, and use a directive to reference the types. Then, library authors can triple-slash referencedom-typesand get only the types. Has the advantage of not causing any compatibility issues, and library authors can opt in to the types-only package. -
???
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 reproduciendo el comportamiento con el ejemplo enlazado de src/index.ts y un tsconfig.json que use lib: []; inspecciona cómo las directivas triple-slash y lib.dom.d.ts afectan a la comprobación de tipos de las dependencias. Se considera terminado cuando los globales no declarados del ejemplo producen errores de tipo sin requerir que los autores de las bibliotecas eliminen los tipos a los que hacen referencia; no se especifica ningún archivo de prueba concreto.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- compilers
- Tipo de issue
- Error
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100