CodeAction and CodeActionProviderMetaData fields added

[Archie27376]

What it does

Fixes #9989

• added support for the disabled and isPreferred fields to the CodeAction interface
• added support for the documentation field to CodeActionProviderMetaData interface

How to test

1. include the vscode-code-action-test test plugin
2. start the application and open a markdown file
3. type :) in the file
4. the quick-fix should display entries - the cat emoji entry is explicitly hidden (will be present on master)
   • reference

Review checklist

• As an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

• As a reviewer, I agree to behave in accordance with the review guidelines

[msujew]

@tsmaeder Do you have an example extension at hand with which one can test these changes?

[vince-fugnitto]

@Archie27376 using the test plugin vscode-code-action I was able to confirm at least for the CodeAction changes that there is still work to do.

bug-code-action.mp4

The cat result in the quick-fix should not be displayed (similarly to vscode) as it is explicitly disabled.

• https://github.com/vince-fugnitto/vscode-code-action-test/blob/54dd7898b5f0834eb70bca56c6a267b67a71d2a9/src/extension.ts#L48

The fix is quite simple however.

[vince-fugnitto]

I confirmed that the behavior works correctly with the test plugin 👍

The cat result is explicitly disabled and not visible similarly to vscode:

code-action-test.mp4

[tsmaeder]

I don't see how the documentation field is transferred to the main side and ultimately the monaco editor.

[vince-fugnitto]

I think we can omit support for documentation for now, it is used when registering registerCodeActionsProvider but our implementation differs from vscode in many ways:

theia/packages/plugin-ext/src/plugin/languages.ts

Lines 441 to 456 in 0f7dec1

	registerCodeActionsProvider(
	selector: theia.DocumentSelector,
	provider: theia.CodeActionProvider,
	pluginModel: PluginModel,
	pluginInfo: PluginInfo,
	metadata?: theia.CodeActionProviderMetadata
	): theia.Disposable {
	const callId = this.addNewAdapter(new CodeActionAdapter(provider, this.documents, this.diagnostics, pluginModel ? pluginModel.id : '', this.commands));
	this.proxy.$registerQuickFixProvider(
	callId,
	pluginInfo,
	this.transformDocumentSelector(selector),
	metadata && metadata.providedCodeActionKinds ? metadata.providedCodeActionKinds.map(kind => kind.value!) : undefined
	);
	return this.createDisposable(callId);
	}

• https://github.com/microsoft/vscode/blob/abfaf30a04ffd25f9b3a835479379329ab947495/src/vs/workbench/api/common/extHostLanguageFeatures.ts#L1785-L1797

[tsmaeder]

But ultimately, we're registering the code action provider to the editor, which does have a documentation field. We should pass this info to the editor in Theia, as well.

[Archie27376]

@tsmaeder Would you know how to properly pass the documentation field? I myself am not sure how to go about it.

[JonasHelming]

@tsmaeder

[tsmaeder]

Our definition of modes.CodeActionProvider is way out of date. We need to update our definition in monaco.d.ts and pass the necessary information to the front end through "registerQuickFixProvider". The current definition in monaco actually looks like this: https://github.com/microsoft/vscode/blob/2586299c42490a8ed6dff96ed731d44fcbe5b20e/src/vs/editor/common/languages.ts#L777

[tsmaeder]

I looks like in the branch we currently use (0.23) of vs code, the definition lives here: (https://github.com/microsoft/vscode/blob/b882940dc6d5b2acb096969b9e43385248719df7/src/vs/editor/common/modes.ts#L740).

I believe it would work to extend the definition of CodeActionProvider in monaco.d.ts with the needed bits.

[JonasHelming]

@Archie27376 : Please have a look at the hints that Thomas provided and let us know if you need further information!

[vince-fugnitto]

@JonasHelming Dante's (@Archie27376) internship has terminated, someone else would need to pick up the pull-request.