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: respect completion item resolve capability #925

Merged
merged 1 commit into from
Nov 22, 2022
Merged

fix: respect completion item resolve capability #925

merged 1 commit into from
Nov 22, 2022

Conversation

rgrinberg
Copy link
Member

Signed-off-by: Rudi Grinberg me@rgrinberg.com

ps-id: 1286e94f-b84b-49a7-94f3-4a14af371361

@rgrinberg rgrinberg force-pushed the ps/rr/fix__respect_completion_item_resolve_capability branch 2 times, most recently from b82e6d5 to 2996cf1 Compare November 17, 2022 22:36
@ulugbekna ulugbekna added this to the 1.15.0 milestone Nov 18, 2022
@rgrinberg rgrinberg requested a review from ulugbekna November 18, 2022 12:44
ulugbekna
ulugbekna reviewed Nov 21, 2022
View reviewed changes
Copy link
Collaborator

@ulugbekna ulugbekna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Shouldn't we include the information that would be resolved by the resolve request right away if the client doesn't support resolve requests?

  2. Do you also feel like compl.ml has become hard to read? (because of me)

CHANGES.md Outdated
@@ -1,5 +1,9 @@
# Unreleased

## Fixes

- Respect the client's resolve completion item resolve capability (#925)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Respect the client's resolve completion item resolve capability (#925)
- Respect the client's completion item resolve capability (#925)

ocaml-lsp-server/src/compl.ml
Comment on lines +267 to +279
let resolve =
let capabilities = State.client_capabilities state in
match
let open Option.O in
let* td = capabilities.textDocument in
let* compl = td.completion in
let* item = compl.completionItem in
item.resolveSupport
with
| None -> false
| Some { properties } ->
List.mem properties ~equal:String.equal "documentation"
in
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it make sense to have a module-wide state - a lazy value - that would compute this value once instead of doing it on every completion

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, it would make sense. We have a Diganostics.t that stores the results of computing capabilities. It will make sense here too.

@rgrinberg
fix: respect completion item resolve capability
23263b9 
Signed-off-by: Rudi Grinberg <me@rgrinberg.com>

ps-id: 1286e94f-b84b-49a7-94f3-4a14af371361
@rgrinberg rgrinberg force-pushed the ps/rr/fix__respect_completion_item_resolve_capability branch from 2996cf1 to 23263b9 Compare November 21, 2022 14:53
@rgrinberg
Copy link
Member Author

Shouldn't we include the information that would be resolved by the resolve request right away if the client doesn't support resolve requests?

Better not because resolving documentation for every completion candidate can be slow.

Do you also feel like compl.ml has become hard to read? (because of me)

I suppose we can make some improvements. It wasn't hard for me to fix the capabilities issues though.

@ulugbekna
Copy link
Collaborator

Hm, ok, let’s omit the documentation then. I imagine most editors should support resolve anyway

1 similar comment
@ulugbekna
Copy link
Collaborator

Hm, ok, let’s omit the documentation then. I imagine most editors should support resolve anyway

@rgrinberg rgrinberg merged commit 5819116 into master Nov 22, 2022
ulugbekna added a commit to ulugbekna/opam-repository that referenced this pull request Dec 16, 2022
@ulugbekna
[new release] ocaml-lsp-server, lsp and jsonrpc (1.14.3)
a9015b5 
CHANGES:

## Fixes

- Fix document syncing for ranges that span an entire line (ocaml/ocaml-lsp#927)

- Respect the client's completion item resolve and preSelect capabilities
  (ocaml/ocaml-lsp#925, ocaml/ocaml-lsp#936)

- Disable polling for dune's watch mode on Windows and OCaml 4.14.0 (ocaml/ocaml-lsp#935)

## Features

- Semantic highlighting support is enabled by default (ocaml/ocaml-lsp#933)

- Re-enable `ocamlformat-rpc` for formatting code snippets (but not files) (ocaml/ocaml-lsp#920, ocaml/ocaml-lsp#939)

  One needs to have either `ocamlformat` version > 0.21.0 or, otherwise,
  `ocamlformat-rpc` package installed.

- Add custom ocamllsp/hoverExtended request (ocaml/ocaml-lsp#561)

- Support utf-8 position encoding clients (ocaml/ocaml-lsp#919)

- Upgrade to merlin 4.7 and use merlin's `verbosity=smart` by default, which
  allows unwrapping module alias types (ocaml/ocaml-lsp#942)

## Fixes

- Fix semantic highlighting of "long identifiers," e.g., `Foo.Bar.x` (ocaml/ocaml-lsp#932)
ulugbekna added a commit to ulugbekna/opam-repository that referenced this pull request Dec 16, 2022
@ulugbekna
[new release] ocaml-lsp-server, lsp and jsonrpc (1.14.3)
ca852d7 
CHANGES:

## Fixes

- Fix document syncing for ranges that span an entire line (ocaml/ocaml-lsp#927)

- Respect the client's completion item resolve and preSelect capabilities
  (ocaml/ocaml-lsp#925, ocaml/ocaml-lsp#936)

- Disable polling for dune's watch mode on Windows and OCaml 4.14.0 (ocaml/ocaml-lsp#935)

## Features

- Semantic highlighting support is enabled by default (ocaml/ocaml-lsp#933)

- Re-enable `ocamlformat-rpc` for formatting code snippets (but not files) (ocaml/ocaml-lsp#920, ocaml/ocaml-lsp#939)

  One needs to have either `ocamlformat` version > 0.21.0 or, otherwise,
  `ocamlformat-rpc` package installed.

- Add custom ocamllsp/hoverExtended request (ocaml/ocaml-lsp#561)

- Support utf-8 position encoding clients (ocaml/ocaml-lsp#919)

- Upgrade to merlin 4.7 and use merlin's `verbosity=smart` by default, which
  allows unwrapping module alias types (ocaml/ocaml-lsp#942)

## Fixes

- Fix semantic highlighting of "long identifiers," e.g., `Foo.Bar.x` (ocaml/ocaml-lsp#932)
@ulugbekna ulugbekna mentioned this pull request Dec 16, 2022
Closed
ulugbekna added a commit to ulugbekna/opam-repository that referenced this pull request Dec 16, 2022
@ulugbekna
[new release] ocaml-lsp-server, lsp and jsonrpc (1.15.0~5.0preview1)
f70e40b 
CHANGES:

## Features

- Add support for OCaml 5.0

- Semantic highlighting support is enabled by default (ocaml/ocaml-lsp#933)

- Re-enable `ocamlformat-rpc` for formatting code snippets (but not files) (ocaml/ocaml-lsp#920, ocaml/ocaml-lsp#939)

  One needs to have either `ocamlformat` version > 0.21.0 or, otherwise,
  `ocamlformat-rpc` package installed.

- Add custom ocamllsp/hoverExtended request (ocaml/ocaml-lsp#561)

- Support utf-8 position encoding clients (ocaml/ocaml-lsp#919)

- Upgrade to merlin 4.7 and use merlin's `verbosity=smart` by default, which
  allows unwrapping module alias types (ocaml/ocaml-lsp#942)

## Fixes

- Fix document syncing for ranges that span an entire line (ocaml/ocaml-lsp#927)

- Respect the client's completion item resolve and preSelect capabilities
  (ocaml/ocaml-lsp#925, ocaml/ocaml-lsp#936)

- Disable polling for dune's watch mode on Windows and OCaml 4.14.0 (ocaml/ocaml-lsp#935)

- Fix semantic highlighting of "long identifiers," e.g., `Foo.Bar.x` (ocaml/ocaml-lsp#932)
@ulugbekna ulugbekna mentioned this pull request Dec 16, 2022
Merged
@ulugbekna ulugbekna mentioned this pull request Jan 7, 2023
Merged
ulugbekna added a commit to ulugbekna/opam-repository that referenced this pull request Jan 7, 2023
@ulugbekna
[new release] ocaml-lsp-server, lsp and jsonrpc (1.15.0-4.14)
65960bd 
CHANGES:

## Features

- Enable [semantic highlighting](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_semanticTokens)
  support by default (ocaml/ocaml-lsp#933)

- Support connecting over pipes and socket. Pipes on Windows aren't yet
  supported (ocaml/ocaml-lsp#946)

  [More](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#implementationConsiderations)
  about communication channels in LSP specification.

- Re-enable `ocamlformat-rpc` for formatting code snippets (but not files and
  not on Windows) (ocaml/ocaml-lsp#920, ocaml/ocaml-lsp#939)

  One needs to have installed either `ocamlformat` package version > 0.21.0 or,
  otherwise, `ocamlformat-rpc` package. Note that previously `ocamlformat-rpc`
  came in a standalone OPAM package, but since `ocamlformat` version > 0.21.0,
  it comes within `ocamlformat` package.

- Add custom
  [`ocamllsp/hoverExtended`](https://github.com/ocaml/ocaml-lsp/blob/e165f6a3962c356adc7364b9ca71788e93489dd0/ocaml-lsp-server/docs/ocamllsp/hoverExtended-spec.md#L1)
  request (ocaml/ocaml-lsp#561)

- Support utf-8 position encoding clients (ocaml/ocaml-lsp#919)

  [More](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position) about position encoding in LSP specification.

- Show unwrapped module alias types on hovering over module names. This is due
  to upgrading to merlin 4.7 and using merlin's `verbosity=smart` by default
  (ocaml/ocaml-lsp#942)

## Fixes

- Respect the client's completion item resolve and preSelect capabilities
  (ocaml/ocaml-lsp#925, ocaml/ocaml-lsp#936)

- Disable polling for dune's watch mode on Windows and OCaml 4.14.0 (ocaml/ocaml-lsp#935)

- Fix semantic highlighting of "long identifiers," e.g., `Foo.Bar.x` (ocaml/ocaml-lsp#932)

- Fix syncing of document contents:

  - For ranges that span an entire line (ocaml/ocaml-lsp#927)
  - Previously, whole line edits would incorrectly eat the newline characters (ocaml/ocaml-lsp#971)
@ulugbekna ulugbekna mentioned this pull request Jan 7, 2023
Merged
ulugbekna added a commit to ulugbekna/opam-repository that referenced this pull request Jan 7, 2023
@ulugbekna
[new release] ocaml-lsp-server, lsp and jsonrpc (1.15.0-5.0)
82c3791 
CHANGES:

## Features

- Add support for OCaml 5.0

- Enable [semantic highlighting](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_semanticTokens)
  support by default (ocaml/ocaml-lsp#933)

- Support connecting over pipes and socket. Pipes on Windows aren't yet
  supported (ocaml/ocaml-lsp#946)

  [More](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#implementationConsiderations)
  about communication channels in LSP specification.

- Re-enable `ocamlformat-rpc` for formatting code snippets (but not files and
  not on Windows) (ocaml/ocaml-lsp#920, ocaml/ocaml-lsp#939)

  One needs to have installed either `ocamlformat` package version > 0.21.0 or,
  otherwise, `ocamlformat-rpc` package. Note that previously `ocamlformat-rpc`
  came in a standalone OPAM package, but since `ocamlformat` version > 0.21.0,
  it comes within `ocamlformat` package.

- Add custom
  [`ocamllsp/hoverExtended`](https://github.com/ocaml/ocaml-lsp/blob/e165f6a3962c356adc7364b9ca71788e93489dd0/ocaml-lsp-server/docs/ocamllsp/hoverExtended-spec.md#L1)
  request (ocaml/ocaml-lsp#561)

- Support utf-8 position encoding clients (ocaml/ocaml-lsp#919)

  [More](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position) about position encoding in LSP specification.

- Show unwrapped module alias types on hovering over module names. This is due
  to upgrading to merlin 4.7 and using merlin's `verbosity=smart` by default
  (ocaml/ocaml-lsp#942)

## Fixes

- Respect the client's completion item resolve and preSelect capabilities
  (ocaml/ocaml-lsp#925, ocaml/ocaml-lsp#936)

- Disable polling for dune's watch mode on Windows and OCaml 4.14.0 (ocaml/ocaml-lsp#935)

- Fix semantic highlighting of "long identifiers," e.g., `Foo.Bar.x` (ocaml/ocaml-lsp#932)

- Fix syncing of document contents:

  - For ranges that span an entire line (ocaml/ocaml-lsp#927)
  - Previously, whole line edits would incorrectly eat the newline characters (ocaml/ocaml-lsp#971)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ulugbekna ulugbekna ulugbekna approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.15.0
Development

Successfully merging this pull request may close these issues.
2 participants
@rgrinberg @ulugbekna