microsoft / microsoft/TypeScript

TypeScript 3.9: Type files are behaving like included files

Open
#38,079 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Needs Investigation
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the setup using tsconfig.json, tsconfig.base.json, tsconfig.client.json, tsconfig.shared.json, and lib/types/shared/index.d.ts, then compare editor behavior with tsc --build. Investigate how the TypeScript editor handles referenced type files and project configuration; done means the editor reports the expected missing Element error while preserving the referenced client and server types.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
compilers, developer-experience
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.