microsoft / microsoft/TypeScript

External interfaces included in IDE symbol space

Aperta
#243 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Domain: API Help Wanted Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

Overview

Interfaces defined in .d.ts files (even if they are not part of the Visual Studio project) are nonetheless included in the IDE symbol space; i.e. they appear in the Navigate To search results.

Repro

Add the NuGet package underscore.TypeScript.DefinitelyTyped to a project. Ensure that underscore.d.ts is not included in the project; however, do put a reference to it in a TypeScript file in the project, e.g.

/// <reference path="../Scripts/typings/underscore/underscore.d.ts"/>

In Visual Studio, press Ctrl + , and type reduce. Notice you get lots of listings for methods defined in the underscore interface.

Commentary

The repro steps are analogous to adding a reference to System.Web.Mvc, hitting Ctrl + ,, typing file, and seeing the File methods for System.Web.Mvc.Controller, plus who knows what else. Of course, for assembly references this doesn't happen; it would be noise, polluting the IDE symbol space with stuff you rarely want to try to navigate to. Libraries have lots of symbols, often more than our own apps. Those symbols get in the way of navigating quickly within our own app. That's why there's a switch to turn off external items. The same situation applies to JavaScript libraries with TypeScript annotations - not at the same scale as the .NET Framework, but still at enough scale to be a problem.

The bug is that for TypeScript, interfaces and their members in .d.ts files always show up. Ideally, they shouldn't show up regardless of whether the .d.ts file is referenced with an XML directive or by including the file in the project.

The main use case where it would be helpful to include the identifiers in the IDE symbol space is when developers are actually writing .d.ts files. To serve that need, it would be reasonable to include the symbols if the "Search within external items" option is enabled.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Riproduci il problema con underscore.d.ts referenziato da una direttiva XML, quindi analizza il modo in cui Navigate To indicizza interfacce e membri dai file .d.ts esterni. La correzione deve mantenere per impostazione predefinita tali identificatori al di fuori dello spazio dei simboli dell'IDE, consentendoli però quando “Search within external items” è abilitato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
developer-experience, search
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.