microsoft / microsoft/TypeScript

TypeScript 3.9: Type files are behaving like included files

Offen
#38,079 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Needs Investigation
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere die Einrichtung mit tsconfig.json, tsconfig.base.json, tsconfig.client.json, tsconfig.shared.json und lib/types/shared/index.d.ts und vergleiche anschließend das Verhalten des Editors mit tsc --build. Untersuche, wie der TypeScript-Editor mit referenzierten Typdateien und der Projektkonfiguration umgeht; abgeschlossen ist die Aufgabe, wenn der Editor den erwarteten Fehler wegen des fehlenden Element meldet und dabei die referenzierten client- und serverseitigen Typen beibehält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript, vscode
Bereich
compilers, developer-experience
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.