microsoft / microsoft/TypeScript
External interfaces included in IDE symbol space
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Go
- Estrelas
- 111k
- Forks
- 14.3k
- Merge médio
- 2d 4h
- PRs com merge (30d)
- 132
Descrição
#### 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.
```
///
```
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.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Reproduza o problema com underscore.d.ts referenciado por uma diretiva XML e, em seguida, investigue como Navigate To indexa interfaces e membros de arquivos .d.ts externos. A correção deve manter esses identificadores fora do espaço de símbolos da IDE por padrão, mas permitir seu uso quando “Search within external items” estiver habilitado.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- typescript
- Domínio
- developer-experience, search
- Tipo de issue
- Bug
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 35/100