microsoft / microsoft/TypeScript

`importModuleSpecifierPreference: "non-relative"` should use self-name package imports

Đang mở
#59,620 3 bình luận 1 reaction 1 người được giao Xem trên GitHub

@andrewbranch đang làm issue này rồi.

Từ ngày 13/8/2024.

Awaiting More Feedback Suggestion
Ngôn ngữ chính
Go
Star
111k
Fork
14.4k
Merge trung bình
1 ngày 19 giờ
Pull request đã merge (30 ngày)
117

Mô tả

🔎 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/a and packages/b.
  • packages/b depends on packages/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.ts uses the subpath export defined in packages/a/package.json. The suggested import path is a/test. ✅
  • The auto import suggestion in packages/a/other-module.ts does not use the subpath export defined in packages/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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.