microsoft / microsoft/TypeScript

Async LanguageServiceHost

Open
#29,361 7 comments 17 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: API In Discussion Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

language, service, host, async, api

Suggestion

It'd super awesome if Language Service would accept a LanguageServiceHost with async API

Use Cases

Using LanguageService in environments where readFileSync is not available like browsers (using browserfs package or fs provided by WebSockets)

I'm working on an app like CodeSandbox but a bit more sophisticated.

Examples

class Host implements ts.LanguageServiceHost {
  async getScriptSnapshot(filename: string): Promise<ts.IScriptSnapshot> { }
  async readFile(filename: string): Promise<string> {}
}

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the LanguageServiceHost and LanguageService APIs described in the issue, comparing their current synchronous assumptions with the async getScriptSnapshot and readFile examples. Determine the required API design for browser environments where readFileSync is unavailable; done means an async host can be used without breaking existing TypeScript or JavaScript code.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.