Activate Jupyterlab-lsp within my extension

[fcxjlsw05]

I am currently building an extension which includes components hosting code mirror editor (@jupyterlab/codemirror).

According to the doc https://github.com/jupyter-lsp/jupyterlab-lsp/blob/master/docs/Extending.ipynb, I thought jupyterlap-lsp should be supported by default. But it turns out not. If I press tab outside my extension(just open the file in document widget), jupyterlab-lsp is activated

Reading through the document, I don't find a solution how to integrate jupyterlab-lsp with my extension.

Any hint what I should do here?

[bollwyvl]

This would be... Not very easy today. You'd need to mirror the adapter machinery for Editor or Notebook from this repo. It's a bit of a yak shave: we'd probably want to demonstrate this with another core widget, e.g. the settings JSON editor, but would want in-browser language servers.

[krassowski]

Thanks for the interest!

If your widget implements IDocumentWidget<FileEditor> interface, and you have a tracker implementing IWidgetTracker<IDocumentWidget<FileEditor>> interface you could re-use the registration code linked below:

jupyterlab-lsp/packages/jupyterlab-lsp/src/adapters/file_editor/index.ts

Lines 1 to 43 in 0cff6b9

	import { JupyterFrontEndPlugin } from '@jupyterlab/application';
	import { IDocumentWidget } from '@jupyterlab/docregistry';
	import { IEditorTracker } from '@jupyterlab/fileeditor';
	import { CommandEntryPoint } from '../../command_manager';
	import { ILSPAdapterManager, PLUGIN_ID } from '../../tokens';
	import { FileEditorAdapter } from './file_editor';
	export const FileEditorContextMenuEntryPoint: CommandEntryPoint =
	'file-editor-context-menu';
	export const FILE_EDITOR_ADAPTER: JupyterFrontEndPlugin<void> = {
	id: PLUGIN_ID + ':FileEditorAdapter',
	requires: [ILSPAdapterManager],
	optional: [IEditorTracker],
	activate(
	app,
	adapterManager: ILSPAdapterManager,
	fileEditorTracker: IEditorTracker | null
	) {
	if (fileEditorTracker === null) {
	console.warn(
	'LSP: no fileEditorTracker - not registering file editor capabilities'
	);
	} else {
	adapterManager.registerAdapterType({
	name: 'file_editor',
	tracker: fileEditorTracker,
	adapter: FileEditorAdapter,
	entrypoint: FileEditorContextMenuEntryPoint,
	get_id(widget: IDocumentWidget): string {
	return widget.id;
	},
	context_menu: {
	selector: '.jp-FileEditor',
	rank_group: 0,
	rank_group_size: 4
	}
	});
	}
	},
	autoStart: true
	};

I think we do not export FileEditorAdapter, but we can include it in the roadmap for the 4.0 version (#742). The interface of ILSPAdapterManager will likely be subject to some changes in 4.0 too.

[fcxjlsw05]

Thanks for quick response! It will be great if we could get it work soon. I will seek a work-around for now