microsoft / microsoft/TypeScript

`--explainFiles` differentiate `import type ...` vs `import`

Open
#43,338 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Suggestion

explainFiles "import type"

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

I would like the --explainFiles behavior to differentiate between import type and import runtime imports in its printout.

📃 Motivating Example

c:/project/src/server-side/contract
  Imported Types via '../server-side/contract' from file 'c:/project/src/client-side/app.tsx'
           ^^^^^

💻 Use Cases

I am looking for suspected non-import type ... imports that are poisoning our build, bleeding code from non-client files ultimately into client bundles (before maybe tree-shaking them out again). At best, this impacts build performance. I know that better code organization could help avoid confusing import chains and improper imports - that's what I'm trying to untangle it for.

I am using the output from --explainFiles to recognize the various patterns and reconstitute a dependency graph:

const targetPattern = /^(?!\s)(.*)/;
const importedViaPattern = /^  Imported via (['"])(.*)\1 from file '([^']*)'/;
const includePattern = /^  Matched by include pattern (['"])(.*)\1 in '([^']*)'/;
const referencedViaPattern = /^  Referenced via (['"])(.*)\1 from file '([^']*)'/;
const libReferencesPattern = /^  Library referenced via (['"])(.*)\1 from file '([^']*)'/;
const typeLibraryPattern = /^  Type library referenced via (['"])(.*)\1 from file '([^']*)'/;
const fileRedirectsPattern = /^  File redirects to file '([^']*)'/
const compilerOptionsPattern = /^  Library '(.*)' specified in compilerOptions/;
const filesPattern = /^  Part of 'files' list in/;
const implicitTypeLibraryPattern = /^  Entry point for implicit type library/;

There seems to be no difference in the output between an import and an import type so my dependency graph can't cull the type imports that won't be emitted to the next stage in the build pipeline.

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

Start with the --explainFiles entry point and trace how imported files are represented in its output; the issue provides no source file or test path. Done means the printout distinguishes import type from runtime import so consumers can exclude type-only dependencies from their graph.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.