microsoft / microsoft/TypeScript

Provide metadata about TypeScript's available refactorings and quick fixes

Open
#34,859 4 comments 2 reactions 1 assignee View on GitHub

@orta is already working on this.

Since Nov 7, 2019.

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

Description

Problem

We are working on improving discoverability of JS/TS refactorings and quick fixes in VS Code. As part of this, we'd like to put together documentation and a new contribution points that lists out the code actions provided by TypeScript

At the moment, the only way I know to determine this list is to look through the TypeScript codebase.

Proposal

We'd like a way to get metadata about all the current TS quick fixes and code actions. The main information we are interested in:

  • Identifier for the quick fix
  • Human readable name / description for the quick fix
  • (possibly) A way to map this description to the localized description that TS ships with

Two ideas on how this could be exposed:

  • In the TS repo, check in a generated CodeActions.json file. This file would be updated whenever the refactorings or quick fixes change. VS Code would not need this to be published as part of the TypeScript package

  • Expose a command line option or tool to dump out all known refactorings and quick fixes.

/cc @orta Ryan mentioned you may also find this useful for the website

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.