microsoft / microsoft/TypeScript

Support import maps and bare import specifiers

Open
#43,326 4 comments 35 reactions 1 assignee View on GitHub

@weswigham is already working on this.

Since Mar 22, 2021.

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

Description

Suggestion

🔍 Search Terms

  1. import maps
  2. bare import specifiers

✅ 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

As import maps are part of Chrome (as of version 89), and Firefox has given a nod of approval, it would be great if Typescript embraced this cross-package import syntax.

Import maps assume an index.html (for example) file with a script tag, e.g.:

<script type="importmap">
{
  "imports": {
    "moment": "/node_modules/moment/src/moment.js",
    "lodash": "/node_modules/lodash-es/lodash.js"
  }
}
</script>

I would suggest being able to

  1. Point to a file containing such an importmap in tsconfig and/or
  2. Just supporting bare import specifiers, based on package.json/package-lock.json, the way unpkg.com is able to do..

📃 Motivating Example

Now you can reference cross-package JS files seamlessly, without bundling tools, based on browser standards.

Workaround:

The path resolution Typescript provides is inadequate, and quite unhelpful.

The only fairly reliable workaround I've found is cloning the repo to a sibling folder of my project.

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.