Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for notebook.format Code Action #212750

Merged
merged 4 commits into from
May 16, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/vs/editor/common/languages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -834,6 +834,8 @@ export interface CodeActionProvider {

displayName?: string;

extensionId?: string;

/**
* Provide commands for the given document and range.
*/
Expand Down
7 changes: 4 additions & 3 deletions src/vs/workbench/api/browser/mainThreadLanguageFeatures.ts
Original file line number Diff line number Diff line change
Expand Up @@ -367,9 +367,9 @@ export class MainThreadLanguageFeatures extends Disposable implements MainThread
}));
}

// --- quick fix
// --- code actions

$registerQuickFixSupport(handle: number, selector: IDocumentFilterDto[], metadata: ICodeActionProviderMetadataDto, displayName: string, supportsResolve: boolean): void {
$registerCodeActionSupport(handle: number, selector: IDocumentFilterDto[], metadata: ICodeActionProviderMetadataDto, displayName: string, extensionId: string, supportsResolve: boolean): void {
const provider: languages.CodeActionProvider = {
provideCodeActions: async (model: ITextModel, rangeOrSelection: EditorRange | Selection, context: languages.CodeActionContext, token: CancellationToken): Promise<languages.CodeActionList | undefined> => {
const listDto = await this._proxy.$provideCodeActions(handle, model.uri, rangeOrSelection, context, token);
Expand All @@ -387,7 +387,8 @@ export class MainThreadLanguageFeatures extends Disposable implements MainThread
},
providedCodeActionKinds: metadata.providedKinds,
documentation: metadata.documentation,
displayName
displayName,
extensionId,
};

if (supportsResolve) {
Expand Down
2 changes: 1 addition & 1 deletion src/vs/workbench/api/common/extHost.protocol.ts
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ export interface MainThreadLanguageFeaturesShape extends IDisposable {
$registerMultiDocumentHighlightProvider(handle: number, selector: IDocumentFilterDto[]): void;
$registerLinkedEditingRangeProvider(handle: number, selector: IDocumentFilterDto[]): void;
$registerReferenceSupport(handle: number, selector: IDocumentFilterDto[]): void;
$registerQuickFixSupport(handle: number, selector: IDocumentFilterDto[], metadata: ICodeActionProviderMetadataDto, displayName: string, supportsResolve: boolean): void;
$registerCodeActionSupport(handle: number, selector: IDocumentFilterDto[], metadata: ICodeActionProviderMetadataDto, displayName: string, extensionID: string, supportsResolve: boolean): void;
$registerPasteEditProvider(handle: number, selector: IDocumentFilterDto[], metadata: IPasteEditProviderMetadataDto): void;
$registerDocumentFormattingSupport(handle: number, selector: IDocumentFilterDto[], extensionId: ExtensionIdentifier, displayName: string): void;
$registerRangeFormattingSupport(handle: number, selector: IDocumentFilterDto[], extensionId: ExtensionIdentifier, displayName: string, supportRanges: boolean): void;
Expand Down
10 changes: 7 additions & 3 deletions src/vs/workbench/api/common/extHostLanguageFeatures.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2196,6 +2196,10 @@ export class ExtHostLanguageFeatures implements extHostProtocol.ExtHostLanguageF
return ext.displayName || ext.name;
}

private static _extId(ext: IExtensionDescription): string {
return ext.identifier.value;
}

// --- outline

registerDocumentSymbolProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DocumentSymbolProvider, metadata?: vscode.DocumentSymbolProviderMetadata): vscode.Disposable {
Expand Down Expand Up @@ -2385,18 +2389,18 @@ export class ExtHostLanguageFeatures implements extHostProtocol.ExtHostLanguageF
return this._withAdapter(handle, ReferenceAdapter, adapter => adapter.provideReferences(URI.revive(resource), position, context, token), undefined, token);
}

// --- quick fix
// --- code actions

registerCodeActionProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.CodeActionProvider, metadata?: vscode.CodeActionProviderMetadata): vscode.Disposable {
const store = new DisposableStore();
const handle = this._addNewAdapter(new CodeActionAdapter(this._documents, this._commands.converter, this._diagnostics, provider, this._logService, extension, this._apiDeprecation), extension);
this._proxy.$registerQuickFixSupport(handle, this._transformDocumentSelector(selector, extension), {
this._proxy.$registerCodeActionSupport(handle, this._transformDocumentSelector(selector, extension), {
providedKinds: metadata?.providedCodeActionKinds?.map(kind => kind.value),
documentation: metadata?.documentation?.map(x => ({
kind: x.kind.value,
command: this._commands.converter.toInternal(x.command, store),
}))
}, ExtHostLanguageFeatures._extLabel(extension), Boolean(provider.resolveCodeAction));
}, ExtHostLanguageFeatures._extLabel(extension), ExtHostLanguageFeatures._extId(extension), Boolean(provider.resolveCodeAction));
store.add(this._createDisposable(handle));
return store;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

import * as nls from 'vs/nls';
import { IWorkbenchContribution } from 'vs/workbench/common/contributions';
import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
import { Disposable } from 'vs/base/common/lifecycle';


export class NotebookDefaultFormatter extends Disposable implements IWorkbenchContribution {

static readonly ID = 'workbench.contrib.notebook.defaultFormatter';
static readonly configName = 'notebook.defaultFormatter';

static extensionIds: (string | null)[] = [];
static extensionItemLabels: string[] = [];
static extensionDescriptions: string[] = [];
Yoyokrazy marked this conversation as resolved.
Show resolved Hide resolved

constructor(
@IExtensionService private readonly _extensionService: IExtensionService,
) {
super();
this._store.add(this._extensionService.onDidChangeExtensions(this._updateConfigValues, this));
this._updateConfigValues();
}

private async _updateConfigValues(): Promise<void> {
await this._extensionService.whenInstalledExtensionsRegistered();
let extensions = [...this._extensionService.extensions];

extensions = extensions.sort((a, b) => {
const boostA = a.categories?.find(cat => cat === 'Formatters' || cat === 'Programming Languages');
const boostB = b.categories?.find(cat => cat === 'Formatters' || cat === 'Programming Languages');

if (boostA && !boostB) {
return -1;
} else if (!boostA && boostB) {
return 1;
} else {
return a.name.localeCompare(b.name);
}
});

NotebookDefaultFormatter.extensionIds.length = 0;
NotebookDefaultFormatter.extensionItemLabels.length = 0;
NotebookDefaultFormatter.extensionDescriptions.length = 0;

NotebookDefaultFormatter.extensionIds.push(null);
NotebookDefaultFormatter.extensionItemLabels.push(nls.localize('null', 'None'));
NotebookDefaultFormatter.extensionDescriptions.push(nls.localize('nullFormatterDescription', "None"));

for (const extension of extensions) {
if (extension.main || extension.browser) {
NotebookDefaultFormatter.extensionIds.push(extension.identifier.value);
NotebookDefaultFormatter.extensionItemLabels.push(extension.displayName ?? '');
NotebookDefaultFormatter.extensionDescriptions.push(extension.description ?? '');
}
}
}

static _maybeQuotes(s: string): string {
return s.match(/\s/) ? `'${s}'` : s;
}
}
Loading
Loading