microsoft / microsoft/TypeScript

Support for Import Maps

Open
#61,325 1 comment 2 reactions 0 assignees View on GitHub
Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

### 🔍 Search Terms

import, map, path, alias, scope

### ✅ Viability Checklist

- [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [x] This wouldn't change the runtime behavior of existing JavaScript code
- [x] This could be implemented without emitting different JS based on the types of the expressions
- [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

### ⭐ Suggestion

I'm curious to hear thoughts on introducing an `importMap` option in `compilerOptions`.

Some initial thoughts:

- Import maps are a WICG standard.
- They can effectively replace `paths` for most use cases.
- They're supported by Deno.
- Projects with colocated Node and Deno workspaces could leverage the same source of truth regarding imports/aliases.
- Import maps provide the ability to configure `scopes` (extremely useful in my experience)

### 📃 Motivating Example

Every project that utilizes import maps.

### 💻 Use Cases

1. What do you want to use this for?

Simplifying my configuration in projects that contain both Node and Deno workspaces.

2. What shortcomings exist with current approaches?

One needs to re-specify their aliases in numerous places.

3. What workarounds are you using in the meantime?

N/A

Contributor guide

Open the contributing guide

Research direction

Start by reading the existing compilerOptions handling for paths and the module-resolution behavior that import maps would affect. Compare the proposed importMap option with import-map aliases and scopes, then define the supported configuration and compatibility behavior before implementation; done means a reviewed design with coverage for the stated Node and Deno workspace use case.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.