microsoft / microsoft/TypeScript

[isolatedDeclarations] Should imported JSON files be emitted when "resolveJsonModules", "emitDeclarationOnly", and "isolatedDeclarations" are all enabled?

Open
#58,684 2 comments 1 reaction 1 assignee View on GitHub

@sheetalkamat is already working on this.

Since Jun 18, 2024.

Needs Investigation
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

🔍 Search Terms

json, resolvejsonmodules, isolateddeclarations, emit, declarations, import, emitDeclarationOnly

✅ Viability Checklist
⭐ Suggestion

Emit/transpile JSON files when the aforementioned compile options are enabled

📃 Motivating Example

The primary purpose of isolated declarations is to be able to emit declarations for a project without needing to typecheck it and one of the main motivators for that is being able to start typechecking downstream projects, e.g. in a composite build, without waiting for typecheck.

It might be fair to say then that it would be good for downstream projects to be able to start typechecking without waiting for their dependees to transpile code. Even with isolated declarations, this is not possible at the moment, because types may depend on JSON files when resolveJsonModules is enabled, and JSON files are only emitted/copied when JS transpilation is enabled, i.e. "emitDeclarationOnly": false.

💻 Use Cases

Being able to typecheck a composite project in parallel where sub-projects are configured with

    "isolatedDeclarations": true,
    "emitDeclarationOnly": true,
    "resolveJsonModule": true,

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.