microsoft / microsoft/TypeScript

Expose more internal api for making language service plugins.

Open
#36,252 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

language service plugin api refactor codefix vscode

Suggestion

  • ts.refactor.registerRefactor
    A more standard way to make refactor rather than hook the language servies functions.
    And refactor is a rare api that I do not need to write ui code or command for vscode.
  • ts.textChanges.*
    Use this, I can easily generate code or modify code that conform the current code format style.
    Especially you don't expose the ts.formatting.*
  • ts.TypeChecker.getTrueType() ts.TypeChecker.getFalseType()
    The TypeFlags.BooleanLiteral is not enough to determine it is true or false.

Use Cases

https://github.com/heroboy/generate-typescript-switch-case-for-enum-type-language-service-plugin

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 by reviewing the TypeScript language service plugin APIs and the requested entry points: ts.refactor.registerRefactor, ts.textChanges., ts.formatting., and TypeChecker.getTrueType()/getFalseType(). Compare them with the linked generate-typescript-switch-case-for-enum-type-language-service-plugin use case; done requires a scoped, agreed public API proposal rather than implementing all listed requests.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.