microsoft / microsoft/TypeScript

Allow dynamic usage of `import = require` syntax

Open
#60,884 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

🔍 Search Terms

dynamic import, require, verbatimmodulesyntax

✅ Viability Checklist
⭐ Suggestion

I propose that import = require() should be allowed anywhere a require() statement is allowed (under appropriate module settings).

function foo() {
   import foo = require('./module.js');
}
📃 Motivating Example

I've been trying to convert a commonjs project to verbatimModuleSyntax. Currently dynamic JSON imports are written as

function foo() {
   const json = await import('./foo.json');
}

which are rewritten as Promise.resolve().then(() => require('./foo.json')); by TS due to my module setting. The import() syntax currently has the advantage that TS statically analyzes and provides types for the imported JSON.

I'd like to convert the JSON import to a require() call, however, a bare require() loses static analysis. Therefore, I'd like to be able to use

function foo() {
   import json = require('./foo.json');
}

in order to have type inference and static analysis of the json file (also to have it copied to the output build).

(using a node import()-from-CJS is not available to me at this time)

💻 Use Cases
  1. What do you want to use this for? dynamic require()s with static analysis, under verbatimModuleSyntax
  2. What shortcomings exist with current approaches? No static analysis of dynamic require()s.
  3. What workarounds are you using in the meantime? Not using verbatimModuleSyntax

Somewhat relates to https://github.com/microsoft/TypeScript/issues/60598

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 by reviewing the related issue #60598 and the current handling of dynamic import(), require(), and verbatimModuleSyntax. The change is done when function-scoped import = require() is accepted under appropriate module settings while preserving static analysis and JSON output behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.