microsoft / microsoft/TypeScript

TypeScript 3.9: Type files are behaving like included files

Abierto
#38,079 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Needs Investigation
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

I'm trying to use the new TypeScript code editor support for solution projects and it's working pretty well, but has the issue mentioned in the title.

When I add typeRoots or a type file, the referenced file isn't used just to get types from it. Instead, it acts like an included file for that project and the file's type checking follows that project configuration in the editor.

tsconfig.json

{
  "files": [],
  "references": [
    {
      "path": "./tsconfig.client.json"
    },
    {
      "path": "./tsconfig.server.json"
    },
    {
      "path": "./tsconfig.shared.json"
    }
  ]
}

tsconfig.base.json

{
  "compilerOptions": {
    "baseUrl": "./",
    "composite": true,
    "declarationDir": "./@types",
    "emitDeclarationOnly": true,
    "lib": [
      "ES5"
    ],
    "target": "ES5",
    "typeRoots": [
      "node_modules/@types/",
      "lib/types/"
    ]
  }
}

tsconfig.client.json

{
  "extends": "./tsconfig.base.json",
  "compilerOptions": {
    "lib": [
      "ES6",
      "DOM"
    ],
    "target": "ES6",
    "types": [
      "client",
      "shared" // This line is the problem
    ]
  },
  "exclude": [
    "lib/types/shared/"
  ],
  "include": [
    "lib/types/client/"
  ]
}

tsconfig.shared.json

{
  "extends": "./tsconfig.base.json",
  "compilerOptions": {
    "types": [
      "shared"
    ]
  },
  "include": [
    "lib/types/shared/"
  ]
}

lib/types/shared/index.d.ts

type ShouldNotHaveDomLib = Element; // This works, but should output an error

It seems like an issue with VSCode as building the project with "tsc --build" does throw the expected error:

lib/types/shared/index.d.ts:1:28 - error TS2304: Cannot find name 'Element'.

1 type ShouldNotHaveDomLib = Element;

I found that removing the "shared" types from tsconfig.client.json made the client types unavaliable as expected, but then made the server ones avaliable, as the "server" project is the second on the reference list.

With this, I found a very simple solution: put "shared" project as the first referenced in "tsconfig.json"

{
  "files": [],
  "references": [
    {
      "path": "./tsconfig.shared.json"
    },
    {
      "path": "./tsconfig.client.json"
    },
    {
      "path": "./tsconfig.server.json"
    }
  ]
}

This solves the issue for me and yes, building the shared project first should be the standard, so not a huge deal for people using this project pattern. Still, it still is an unexpected behaviour and there might be some other patterns where this is a bigger issue.

I searched for issues here, on TypeScript and Javascript and Typescript Nightly and found nothing, so I apologize if this is a duplicate and/or should be reported to one of those repositories.

  • VSCode Version: 1.44.2 (testes in latest insider too)
  • OS Version: Windows 10 19608

Steps to Reproduce:

  1. Download the Javascript and Typescript Nightly extension
  2. Set up project as above
  3. Add some types to types/client/index.d.ts
  4. Try to use those types in types/server/index.d.ts

Does this issue occur when all extensions are disabled?: No, because I do need the Javascript and Typescript Nightly extension to use TS 3.9 features. However, it still happens while using it with only this extension.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Reproduce la configuración utilizando tsconfig.json, tsconfig.base.json, tsconfig.client.json, tsconfig.shared.json y lib/types/shared/index.d.ts; después, compare el comportamiento del editor con tsc --build. Investigue cómo gestiona el editor de TypeScript los archivos de tipos referenciados y la configuración del proyecto; se considera terminado cuando el editor informa del error esperado por la falta de Element, conservando los tipos referenciados de client y server.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript, vscode
Área
compilers, developer-experience
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
38/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.