microsoft / microsoft/TypeScript
`importModuleSpecifierPreference: "non-relative"` should use self-name package imports
@andrewbranch is already working on this.
Since Aug 13, 2024.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
- relative imports
- workspaces
- monorepo
- subpath export
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about auto imports and subpath exports.
⏯ Playground Link
No response
💻 Code
Full reduced test case: https://github.com/OliverJAsh/typescript-auto-imports-exports
Contents inlined below. TLDR:
- Two workspaces,
packages/aandpackages/b. packages/bdepends onpackages/a.
Root files:
tsconfig.json:
{
"compilerOptions": {
"strict": true,
"noEmit": true,
"target": "ESNext",
"module": "Node16",
"moduleResolution": "Node16"
}
}
package.json:
{
"private": true,
"dependencies": {
"typescript": "^5.5.4"
},
"workspaces": [
"packages/a",
"packages/b"
],
"packageManager": "yarn@4.4.0"
}
Package a:
packages/a/package.json:
{
"name": "a",
"private": true,
"exports": {
"./test": "./module.ts"
}
}
packages/a/module.ts:
export const a = 1;
packages/a/other-module.ts:
// Try to import this
// Auto import uses a relative path here: `./module` ❌
a;
Package b:
packages/b/package.json:
{
"name": "b",
"private": true,
"dependencies": {
"a": "workspace:^"
}
}
packages/b/module.ts:
// Try to import this
// Auto import works correctly here: `a/test` ✅
a;
🙁 Actual behavior
- The auto import suggestion in
packages/b/other-module.tsuses the subpath export defined inpackages/a/package.json. The suggested import path isa/test. ✅ - The auto import suggestion in
packages/a/other-module.tsdoes not use the subpath export defined inpackages/a/package.json. Instead it uses a relative import. The suggested import path is./module.
It seems that TypeScript is not using the subpath export information for self-referencing imports.
🙂 Expected behavior
In both cases I would expect the subpath export to be used (rather than relative imports), otherwise you can end up with some verbose relative paths in the case of projects with deeply nested folders.
I would expect TypeScript to only use a relative import if a subpath export is not available.
Additional information about the issue
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.