Skip to content

Provide metadata about TypeScript's available refactorings and quick fixes #34859

Open
@mjbvz

Description

@mjbvz

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

Metadata

Metadata

Assignees

Labels

CommittedThe team has roadmapped this issueRescheduledThis issue was previously scheduled to an earlier milestoneSuggestionAn idea for TypeScript

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions