microsoft / microsoft/TypeScript

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

Ouverte
#59,620 3 commentaires 1 réaction 1 personne assignée Voir sur GitHub

@andrewbranch y travaille déjà.

Depuis le 13/8/2024.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
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/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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.