microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-07-10 05:28:19 -05:00
Code Issues Packages Projects Releases 177 Wiki Activity

notebooks: deprecate viewType for renderers, prefer renderer ID

Browse Source
This commit is contained in:
Connor Peet
2020-08-21 10:09:04 -07:00
parent 83bea8f0e4
commit d4f6fe3227
3 changed files with 18 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
extensions/vscode-notebook-tests/package.json
View File

@@ -62,7 +62,7 @@
],
"notebookOutputRenderer": [
{
"viewType": "notebookCoreTestRenderer",
"id": "notebookCoreTestRenderer",
"displayName": "Notebook Core Test Renderer",
"entrypoint": "./src/customRenderer.js",
"mimeTypes": [

13
src/vs/workbench/contrib/notebook/browser/extensionPoint.ts
View File

@@ -25,13 +25,15 @@ export interface INotebookEditorContribution {
namespace NotebookRendererContribution {
export const viewType = 'viewType';
export const id = 'id';
export const displayName = 'displayName';
export const mimeTypes = 'mimeTypes';
export const entrypoint = 'entrypoint';
}
export interface INotebookRendererContribution {
readonly [NotebookRendererContribution.viewType]: string;
readonly [NotebookRendererContribution.id]?: string;
readonly [NotebookRendererContribution.viewType]?: string;
readonly [NotebookRendererContribution.displayName]: string;
readonly [NotebookRendererContribution.mimeTypes]?: readonly string[];
readonly [NotebookRendererContribution.entrypoint]: string;
@@ -94,18 +96,23 @@ const notebookProviderContribution: IJSONSchema = {
const notebookRendererContribution: IJSONSchema = {
description: nls.localize('contributes.notebook.renderer', 'Contributes notebook output renderer provider.'),
type: 'array',
defaultSnippets: [{ body: [{ viewType: '', displayName: '', mimeTypes: [''] }] }],
defaultSnippets: [{ body: [{ id: '', displayName: '', mimeTypes: [''] }] }],
items: {
type: 'object',
required: [
NotebookRendererContribution.viewType,
NotebookRendererContribution.id,
NotebookRendererContribution.displayName,
NotebookRendererContribution.mimeTypes,
NotebookRendererContribution.entrypoint,
],
properties: {
[NotebookRendererContribution.id]: {
type: 'string',
description: nls.localize('contributes.notebook.renderer.viewType', 'Unique identifier of the notebook output renderer.'),
},
[NotebookRendererContribution.viewType]: {
type: 'string',
deprecationMessage: nls.localize('contributes.notebook.provider.viewType.deprecated', 'Rename `viewType` to `id`.'),
description: nls.localize('contributes.notebook.renderer.viewType', 'Unique identifier of the notebook output renderer.'),
},
[NotebookRendererContribution.displayName]: {

10
src/vs/workbench/contrib/notebook/browser/notebookServiceImpl.ts
View File

@@ -293,8 +293,14 @@ export class NotebookService extends Disposable implements INotebookService, ICu
continue;
}
const id = notebookContribution.id ?? notebookContribution.viewType;
if (!id) {
console.error(`Notebook renderer from ${extension.description.identifier.value} is missing an 'id'`);
continue;
}
this.notebookRenderersInfoStore.add(new NotebookOutputRendererInfo({
id: notebookContribution.viewType,
id,
extension: extension.description,
entrypoint: notebookContribution.entrypoint,
displayName: notebookContribution.displayName,
@@ -302,8 +308,6 @@ export class NotebookService extends Disposable implements INotebookService, ICu
}));
}
}
// console.log(this.notebookRenderersInfoStore);
});
this._editorService.registerCustomEditorViewTypesHandler('Notebook', this);