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

Allow to disable LSP or Kernel completions independently. #586

Merged
merged 6 commits into from
Apr 28, 2021
Merged
Show file tree
Hide file tree
Changes from 4 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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## Changelog

### (unreleased)

- Add ability to deactivate Kernel completions or LSP completion through the settings.

### `jupyter-lsp 1.2.0` (2021-04-26)

- features:
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ from the Language Server (in notebook).
If the kernel is too slow to respond promptly only the Language Server suggestions will be shown (default threshold: 0.6s).
You can configure the completer to not attempt to fetch the kernel completions if the kernel is busy (skipping the 0.6s timeout).

You can deactivate the kernel suggestions by adding `"kenel"` to the `disableCompletionsFrom` in the `completion` section
krassowski marked this conversation as resolved.
Show resolved Hide resolved
of _Advanced Settings_. Alternatively if you _only_ want kernel completions you can add `"languageServer"` to the same
setting; Or add both if you like to code in hardcore mode and get no completions, or if another provider has been added.

### Rename

Rename variables, functions and more, in both: notebooks and the file editor.
Expand Down
6 changes: 6 additions & 0 deletions packages/jupyterlab-lsp/schema/completion.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@
"type": "number",
"description": "The time to wait for the kernel completions suggestions in milliseconds. Set to 0 to disable kernel completions, or to -1 to wait indefinitely (not recommended)."
},
"disableCompletionsFrom": {
"description": "The sources from which to exclude completion from. Possible values include 'kernel', 'languageServer'.",
"type": "array",
"default": [],
"uniqueItems": true
},
"waitForBusyKernel": {
"title": "Wait for kernel if busy",
"default": true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,22 @@ export class LSPConnector
return this.options.settings.composite.kernelCompletionsFirst;
}

protected get use_lsp_completions(): boolean {
return (
this.options.settings.composite.disableCompletionsFrom.indexOf(
'languageServer'
) == -1
);
}

protected get use_kernel_completions(): boolean {
return (
this.options.settings.composite.disableCompletionsFrom.indexOf(
'kernel'
) == -1
);
}

protected get suppress_continuous_hinting_in(): string[] {
return this.options.settings.composite.suppressContinuousHintingIn;
}
Expand Down Expand Up @@ -212,22 +228,26 @@ export class LSPConnector
let virtual_cursor = virtual_editor.root_position_to_virtual_position(
cursor_in_root
);
const lsp_promise: Promise<CompletionHandler.ICompletionItemsReply> = this
.use_lsp_completions
? this.fetch_lsp(
token,
typed_character,
virtual_start,
virtual_end,
virtual_cursor,
document,
position_in_token
)
: Promise.resolve(null);

const lsp_promise = this.fetch_lsp(
token,
typed_character,
virtual_start,
virtual_end,
virtual_cursor,
document,
position_in_token
);
let promise: Promise<CompletionHandler.ICompletionItemsReply> = null;

try {
const kernelTimeout = this._kernel_timeout;

if (
this.use_kernel_completions &&
this._kernel_connector &&
this._has_kernel &&
(this._is_kernel_idle || this._should_wait_for_busy_kernel) &&
Expand Down Expand Up @@ -271,12 +291,16 @@ export class LSPConnector
promise = Promise.all([
kernel_promise.catch(p => p),
lsp_promise.catch(p => p)
]).then(([kernel, lsp]) =>
this.merge_replies(
[this.transform_reply(kernel), lsp],
this._editor
)
);
]).then(([kernel, lsp]) => {
let replies = [];
if (kernel != null) {
replies.push(this.transform_reply(kernel));
}
if (lsp != null) {
replies.push(lsp);
}
return this.merge_replies(replies, this._editor);
});
}
}
if (!promise) {
Expand Down