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 (336 forks)batch import
bountybounty-100enhancementhelp wanted

Repository metrics

Stars
 (11,389 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Investigate the TypeScript language server protocol implementation for completions, focusing on 'additionalTextEdits' and 'textEdit'. Look at how external module exports are included and how entry details resolution works. Understand the plumbing needed for 'source' in the completion items.
Tech stack
typescriptnodejs
Domain
backenddeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
TypeScriptLanguage Server ProtocolNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40