microsoft / microsoft/TypeScript

Wrong import suggestion in subpath pattern

Ouverte
#52,870 6 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Needs Investigation
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

Does this issue occur when all extensions are disabled?: Yes

  • VS Code Version: 1.75.1
  • OS Version: Darwin x64 22.1.0 (MacOS)

Steps to Reproduce:

  1. Install @neo4j-ndl/react@1.0.0-alpha-fafbc08
  2. Try to import an icon like <AdjustmentsHorizontalIconSolid /> in a JSX file.

The recommended import path is @neo4j-ndl/react/lib/types/icons while the correct based on the exports field would be @neo4j-ndl/react/icons

The modified package.json is looking like this:

{
  "name": "@neo4j-ndl/react",
  "version": "0.17.7",
  "sideEffects": false,
  "description": "React implementation of Neo4j Design System",
  "keywords": [
    "neo4j",
    "react",
    "design system",
    "needle",
    "ndl"
  ],
  "author": "Neo4j Inc.",
  "homepage": "",
  "license": "GPL-3.0",
  "main": "./lib/cjs/index.js",
  "module": "./lib/esm/index.js",
  "types": "./lib/types/index.d.ts",
  "exports": {
    "./icons": {
      "import": "./lib/esm/icons/index.js",
      "require": "./lib/cjs/icons/index.js",
      "types": "./lib/types/icons/index.d.ts"
    },
    ".": {
      "import": "./lib/esm/index.js",
      "require": "./lib/cjs/index.js",
      "types": "./lib/types/index.d.ts"
    }
  },
 ...
}

As a library publishers tried it also with WebStorm to see how it behaves and I can see that there it is imported as expected (video):

https://user-images.githubusercontent.com/12672541/219434237-a77ee748-c7b3-4995-a083-0690af3d9657.mp4

Also noticed, that if there is one module imported from @neo4j-ndl/react/icons then the suggestion works as expected (image):
CleanShot 2023-02-16 at 18 00 20@2x

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.

Piste de recherche

Reproduisez le problème dans un fichier JSX en utilisant le package.json modifié et son champ exports, en commençant par l’exemple du package @neo4j-ndl/react/icons. Suivez le comportement des suggestions d’importation pour un modèle de sous-chemin de package et comparez-le au cas fonctionnel après un import depuis @neo4j-ndl/react/icons. La tâche est terminée lorsque le chemin suggéré est @neo4j-ndl/react/icons plutôt que @neo4j-ndl/react/lib/types/icons.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, typescript
Domaine
developer-experience, tooling
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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