CodeActionScope by mjbvz · Pull Request #41782 · microsoft/vscode

mjbvz · 2018-01-18T02:17:16Z

Problem
We'd like to improve the UX for refactorings. Two specific ideas:

A refactorings context menu
Allow a keybinding to a specific refactoring, such as extract method

Proposal
Introduce a new CodeActionScope type. This identifies the class/type of a given refactoring. All refactoring code actions for example would have a scope of refactor.*, with an extract method refactoring action having a scope of refactor.extract.method

For the refactoring context menu, we use CodeActionScope to filter out any code actions that are not refactorings. The CodeActionContext will also have a scope field on it that a CodeActionProvider can use to determine which code actions to compute and return
For keybindings, we can setup a keybinding such as:
```
{
	"key": "ctrl+shift+.",
	"command": "editor.action.codeAction",
	"args": [
		"refactor.extract"
	]
}
```
where "refactor" is treated as the code action scope. Only code actions of the type "refactor.*" should be shown

Todo
Still a lot to do on this PR

Tests
Hookup scope for CodeActionContext
Create an new editor.action.codeAction command instead of overloading the existing editor.action.quickFix command

jrieken · 2018-01-19T09:07:19Z

src/vs/vscode.d.ts

Maybe CodeActionKind is the better name because this is about the 'character' of a code action and because we have been using ...Kind already for similar purposes...

jrieken · 2018-01-19T09:07:54Z

src/vs/vscode.d.ts

Not sure if the Refactor-prefix is needed? Isn't this implicit?

jrieken · 2018-01-19T09:08:27Z

src/vs/vscode.d.ts

better append

jrieken · 2018-01-19T09:09:04Z

src/vs/vscode.d.ts

Do we have an use-case for this?

Yes, this is used for the requestedScope logic in the TS refactoring code action provider so that we can skip computing code actions that vscode will filter out later

jrieken · 2018-01-19T09:11:44Z

src/vs/vscode.d.ts

Maybe use a for with for select-semantics, like only?

jrieken · 2018-01-19T09:20:48Z

src/vs/editor/contrib/quickFix/quickFixModel.ts

getting a little messy... can we fold both args into one request object and pass that along?

jrieken · 2018-01-19T09:23:05Z

src/vs/vscode.d.ts

We should also have static readonly Rewrite for things like 'Convert if-else into ternary statement' etc, etc

and also maybe CleanUp category?

jrieken · 2018-01-19T09:26:11Z

src/vs/vscode.d.ts

no public

mjbvz · 2018-01-19T22:41:44Z

Thanks for the feedback. Pushed change that updates the names as suggested. I'll also look into cleaning up the trigger implementation flow.

The new change also allows for callers of editor.action.codeAction to control if/when a code action is applied automatically using an autoApply flag:

{
		"key": "ctrl+shift+.",
		"command": "editor.action.codeAction",
		"args": [
			"refactor.extract",
			{ "autoApply": true }
		]
	}

"autoApply": undefined - Default behavior. Automatically accept code action if there is only one, otherwise show context menu
"autoApply": true - Always accept the first code action
"autoApply": false - Never automatically accept the first code action, always show the context menu even if there is just a single item

ghost

I think cAmEl is good for naming class's. Like codeActionKind

Take args as an object instead of as an array of values

mjbvz · 2018-01-22T19:24:44Z

Most recent change makes the keybindings for this more like insertSnippet:

{
		"key": "ctrl+shift+.",
		"command": "editor.action.codeAction",
		"args": {
			"kind": "refactor.extract",
			"apply": "ifSingle"
		}
}

"apply": "ifSingle" - Default behavior. Automatically accept code action if there is only one, otherwise show context menu
"apply": "first" - Always accept the first code action
"apply": "never" - Never automatically accept the first code action, always show the context menu even if there is just a single item

mjbvz · 2018-01-22T19:46:28Z

Will follow up with changes to expose a new "refactor" action with keybinding, as well as hooking up more of the TS quick fixes / refactorings to use CodeActionKind

mjbvz self-assigned this Jan 18, 2018

mjbvz requested a review from jrieken January 18, 2018 02:17

jrieken requested changes Jan 19, 2018

View reviewed changes

mjbvz force-pushed the code-action-scope branch from 499b465 to 2a7d23d Compare January 19, 2018 22:37

ghost suggested changes Jan 21, 2018

View reviewed changes

mjbvz added 15 commits January 22, 2018 10:36

Add CodeActionScope

e7fe505

Replace matches with contains, try using in ts extension

e0987bc

Move filtering to getCodeActions

44424f4

Basic test

b1b7d4f

Docs

ec47865

Fix tests

265bc79

Hooking up requested scope

95f76e0

Add basic test for requestedScope

03d2a80

Added auto apply logic

7d542f3

Gate refactor provider to only compute refactorings when requested

1deb4db

Making suggested renames

ee4dd6e

Clean up code action trigger impl to use single Trrigger info object

4c7c9a5

Rename codeActionScope file and internal CodeActionScope class

1a28bc1

Add quick fix base type

438eb06

Make keybinding API more similar to insertSnippet

5f68a21

Take args as an object instead of as an array of values

mjbvz force-pushed the code-action-scope branch from dfba759 to 5f68a21 Compare January 22, 2018 19:22

mjbvz added this to the January 2018 milestone Jan 22, 2018

mjbvz added 3 commits January 22, 2018 11:34

Clean up docs

dfb6370

scope -> kind

b4a53fc

Fixing examples to match Refactor kind

0c30b3f

mjbvz force-pushed the code-action-scope branch from 59a30c7 to 0c30b3f Compare January 22, 2018 19:43

mjbvz merged commit eccf728 into microsoft:master Jan 22, 2018

mjbvz mentioned this pull request Jan 26, 2018

Keybinding for applying a specific code action #33049

Closed

github-actions bot locked and limited conversation to collaborators Mar 30, 2020

Conversation

mjbvz commented Jan 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mjbvz commented Jan 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

mjbvz commented Jan 22, 2018

Uh oh!

mjbvz commented Jan 22, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mjbvz commented Jan 18, 2018 •

edited

Loading

mjbvz commented Jan 19, 2018 •

edited

Loading