onivim/oni

TypeScript: Hook up auto-import functionality

Open

#1,593 opened on Feb 21, 2018

View on GitHub
 (12 comments) (3 reactions) (1 assignee)TypeScript (11,389 stars) (336 forks)batch import
bountybounty-100enhancementhelp wanted

Description

Splitting out from #1326 - integrate 'auto-import' functionality from TypeScript. This should generalize to other completion providers, too.

  • Implement additionalTextEdits and textEdit for CompletionItems as defined by the completion request in the language server protocol: https://microsoft.github.io/language-server-protocol/specification
  • Update our TypeScriptServerHost to send additionalTextEdits for auto-imports. This will involve settting the includeExternalModuleExports for the completions request, hooking up entry details resolution to get information about the additional code actions as part of the details request, and resolving those code actions to text edits. Looks like we'll need to plumb the 'source' through somehow, as this is needed when calling to get details.

Contributor guide

Tech stack
typescript
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic understanding of TypeScriptFamiliarity with Language Server Protocol
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Review the LSP completion specification for additionalTextEdits and textEdit. Examine the TypeScriptServerHost code to understand current completion handling and how to set the includeExternalModuleExports flag. Check issue #1326 for context on auto import integration and investigate how to resolve code actions to text edits, possibly by plumbing the 'source' through the completion details request.
TypeScript: Hook up auto-import functionality · onivim/oni#1593 | Good First Issue