Skip to content

Add (relative) URL imports for modules #41730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
5 tasks done
jkrems opened this issue Nov 30, 2020 · 1 comment
Open
5 tasks done

Add (relative) URL imports for modules #41730

jkrems opened this issue Nov 30, 2020 · 1 comment
Labels
In Discussion Not yet reached consensus Suggestion An idea for TypeScript

Comments

@jkrems
Copy link

jkrems commented Nov 30, 2020

Search Terms

  • import url
  • relative url import

Suggestion

Add a new moduleResolution mode (e.g. "url") that treats non-bare specifiers in import statements and -expressions as URLs, matching the behavior of browser and node ESM. Mostly for relative URLs but potentially also for absolute URLs. It likely shouldn't change the resolution of require calls.

There's a similar issue (Add support for URI style import) that focusses on HTTP URLs but I would consider supporting HTTP URLs out of scope for this issue. It may be possible to layer HTTP support on top of the basic feature, so they aren't mutually exclusive.

Use Cases

Write code that works as-is in browsers and node, using filenames that contain characters that would typically be URL encoded (like spaces).

Examples

Right now the "classic" and "node" (~CommonJS/babel) resolution modes treat relative specifiers as file system paths and don't support absolute file:// URLs at all. For browser ESM and node ESM, these should typically be treated as relative URLs. E.g.:

// main.ts
import {name} from './dep%20file.js';
console.log(name);

// dep file.ts:
export const name = 'Robin';

TypeScript generates working code for this (if emit on error is allowed) but it will fail to trace the import correctly because it expects an imported filename that contains the literal string "%20".

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, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.
@rotu
Copy link

rotu commented Jan 28, 2024

A new moduleResolution mode should not be necessary to support URL imports. In particular, the docs say:

node16, nodenext

These modes reflect the module resolution behavior of Node.js v12 and later.

Node.js has supported URL imports (for the file:, node:, and data: schemes) since Node 12. It seems correct to add URL support to those existing resolution settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
In Discussion Not yet reached consensus Suggestion An idea for TypeScript
Projects
None yet
Development

No branches or pull requests

3 participants