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.

Sign up for GitHub

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

Jump to bottom

Fix json schema for notebook renderers #152100

Merged
merged 1 commit into from Jun 14, 2022
Merged

Fix json schema for notebook renderers #152100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
145 changes: 83 additions & 62 deletions src/vs/workbench/contrib/notebook/browser/extensionPoint.ts
View file
Open in desktop
Expand Up @@ -97,84 +97,105 @@ const notebookProviderContribution: IJSONSchema = {
}
};

const defaultRendererSnippet = Object.freeze({ id: '', displayName: '', mimeTypes: [''], entrypoint: '' });

const notebookRendererContribution: IJSONSchema = {
description: nls.localize('contributes.notebook.renderer', 'Contributes notebook output renderer provider.'),
type: 'array',
defaultSnippets: [{ body: [{ id: '', displayName: '', mimeTypes: [''], entrypoint: '' }] }],
defaultSnippets: [{ body: [defaultRendererSnippet] }],
items: {
type: 'object',
required: [
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.displayName]: {
type: 'string',
description: nls.localize('contributes.notebook.renderer.displayName', 'Human readable name of the notebook output renderer.'),
},
[NotebookRendererContribution.mimeTypes]: {
type: 'array',
description: nls.localize('contributes.notebook.selector', 'Set of globs that the notebook is for.'),
items: {
type: 'string'
defaultSnippets: [{ body: defaultRendererSnippet }],
allOf: [
{
type: 'object',
required: [
NotebookRendererContribution.id,
NotebookRendererContribution.displayName,
],
properties: {
[NotebookRendererContribution.id]: {
type: 'string',
description: nls.localize('contributes.notebook.renderer.viewType', 'Unique identifier of the notebook output renderer.'),
},
[NotebookRendererContribution.displayName]: {
type: 'string',
description: nls.localize('contributes.notebook.renderer.displayName', 'Human readable name of the notebook output renderer.'),
},
[NotebookRendererContribution.hardDependencies]: {
type: 'array',
uniqueItems: true,
items: { type: 'string' },
markdownDescription: nls.localize('contributes.notebook.renderer.hardDependencies', 'List of kernel dependencies the renderer requires. If any of the dependencies are present in the `NotebookKernel.preloads`, the renderer can be used.'),
},
[NotebookRendererContribution.optionalDependencies]: {
type: 'array',
uniqueItems: true,
items: { type: 'string' },
markdownDescription: nls.localize('contributes.notebook.renderer.optionalDependencies', 'List of soft kernel dependencies the renderer can make use of. If any of the dependencies are present in the `NotebookKernel.preloads`, the renderer will be preferred over renderers that don\'t interact with the kernel.'),
},
[NotebookRendererContribution.requiresMessaging]: {
default: 'never',
enum: [
'always',
'optional',
'never',
],

enumDescriptions: [
nls.localize('contributes.notebook.renderer.requiresMessaging.always', 'Messaging is required. The renderer will only be used when it\'s part of an extension that can be run in an extension host.'),
nls.localize('contributes.notebook.renderer.requiresMessaging.optional', 'The renderer is better with messaging available, but it\'s not requried.'),
nls.localize('contributes.notebook.renderer.requiresMessaging.never', 'The renderer does not require messaging.'),
],
description: nls.localize('contributes.notebook.renderer.requiresMessaging', 'Defines how and if the renderer needs to communicate with an extension host, via `createRendererMessaging`. Renderers with stronger messaging requirements may not work in all environments.'),
},
}
},
[NotebookRendererContribution.entrypoint]: {
description: nls.localize('contributes.notebook.renderer.entrypoint', 'File to load in the webview to render the extension.'),
{
oneOf: [
{
type: 'string',
},
{
type: 'object',
required: ['extends', 'path'],
required: [
NotebookRendererContribution.entrypoint,
NotebookRendererContribution.mimeTypes,
],
properties: {
extends: {
type: 'string',
description: nls.localize('contributes.notebook.renderer.entrypoint.extends', 'Existing renderer that this one extends.'),
[NotebookRendererContribution.mimeTypes]: {
type: 'array',
description: nls.localize('contributes.notebook.selector', 'Set of globs that the notebook is for.'),
items: {
type: 'string'
}
},
path: {
[NotebookRendererContribution.entrypoint]: {
description: nls.localize('contributes.notebook.renderer.entrypoint', 'File to load in the webview to render the extension.'),
type: 'string',
},
}
},
{
required: [
NotebookRendererContribution.entrypoint,
],
properties: {
[NotebookRendererContribution.entrypoint]: {
description: nls.localize('contributes.notebook.renderer.entrypoint', 'File to load in the webview to render the extension.'),
type: 'object',
required: ['extends', 'path'],
properties: {
extends: {
type: 'string',
description: nls.localize('contributes.notebook.renderer.entrypoint.extends', 'Existing renderer that this one extends.'),
},
path: {
type: 'string',
description: nls.localize('contributes.notebook.renderer.entrypoint', 'File to load in the webview to render the extension.'),
},
}
},
}
}
]
},
[NotebookRendererContribution.hardDependencies]: {
type: 'array',
uniqueItems: true,
items: { type: 'string' },
markdownDescription: nls.localize('contributes.notebook.renderer.hardDependencies', 'List of kernel dependencies the renderer requires. If any of the dependencies are present in the `NotebookKernel.preloads`, the renderer can be used.'),
},
[NotebookRendererContribution.optionalDependencies]: {
type: 'array',
uniqueItems: true,
items: { type: 'string' },
markdownDescription: nls.localize('contributes.notebook.renderer.optionalDependencies', 'List of soft kernel dependencies the renderer can make use of. If any of the dependencies are present in the `NotebookKernel.preloads`, the renderer will be preferred over renderers that don\'t interact with the kernel.'),
},
[NotebookRendererContribution.requiresMessaging]: {
default: 'never',
enum: [
'always',
'optional',
'never',
],

enumDescriptions: [
nls.localize('contributes.notebook.renderer.requiresMessaging.always', 'Messaging is required. The renderer will only be used when it\'s part of an extension that can be run in an extension host.'),
nls.localize('contributes.notebook.renderer.requiresMessaging.optional', 'The renderer is better with messaging available, but it\'s not requried.'),
nls.localize('contributes.notebook.renderer.requiresMessaging.never', 'The renderer does not require messaging.'),
],
description: nls.localize('contributes.notebook.renderer.requiresMessaging', 'Defines how and if the renderer needs to communicate with an extension host, via `createRendererMessaging`. Renderers with stronger messaging requirements may not work in all environments.'),
},
}
}
]
}
};

Expand Down