Type search custom request

[PizieDust]

TypeSearch Request

Description

This custom request allows clients to perform a type search at a specific position within a text document based on finding functions or types that match a specific query pattern.

Server capability

• property name: handleTypeSearch
• property type: boolean

Request

export interface TypeSearchParams extends TexDocumentPositionParams
{
    query: string;
    limit: int;
    with_doc: bool;
}

• method: ocamllsp/typeSearch
• params:
  • TextDocumentPositionParams: This is an existing interface that includes:
    - TextDocumentIdentifier: Specifies the document uri for which the request is sent.
    - Position: Specifies the cursor position.
    More details can be found in the TextDocumentPositionParams - LSP Specification.
  • query: The search pattern.
  • limit: The number of results to return
  • with_doc: If to return documentation information or not

Response

result: TypeSearch | null
export interface TypeSearch {
    type t = Query_protocol.type_search_result list
}

• t: A list of types that match the query.

  type Query_protocol.type_search_result =
  {
      name : string; // The fully qualified name of this result.
      typ : string;  // The signature of this result.
      loc : Range.t; // The location of the definition of this result in the source code.
      doc : string option; // Optional documentation associated with this result.
      cost : int; // A numeric value representing the "cost" or distance between this result and the query.
      constructible : string; // A constructible form or template that can be used to invoke this result
  }
  

• A response with null result is returned if no entries are found.

[coveralls]

Pull Request Test Coverage Report for Build 4579

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 25 of 26 (96.15%) changed or added relevant lines in 1 file are covered.
• 27 unchanged lines in 3 files lost coverage.
• Overall coverage increased (+0.07%) to 21.996%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
ocaml-lsp-server/src/custom_requests/req_type_search.ml	25	26	96.15%

Files with Coverage Reduction	New Missed Lines	%
ocaml-lsp-server/src/inlay_hints.ml	2	86.96%
ocaml-lsp-server/src/inference.ml	4	70.45%
ocaml-lsp-server/src/signature_help.ml	21	0.0%

Totals
Change from base Build 4565:	0.07%
Covered Lines:	5579
Relevant Lines:	25364

---

💛 - Coveralls

[xvw]

Nice!

[rgrinberg]

Nice. Which client is going to make use of this?

[xvw]

Nice. Which client is going to make use of this?

We probably will implement a VScode extension for the query

[rgrinberg]

Okay, I think we need to see that vscode client to evaluate this work.

[voodoos]

Overall this looks good to me, thanks @PizieDust

[voodoos]

This could be replaced by Json.option Json.string res.doc

[voodoos]

@xvw, @PizieDust, Melrin 5.2-502 has been released so the CI should pass without pinning and could be un-drafted. Is the custom request ready for a last round of review ?

[xvw]

I am still a little bit confuse by the syntactic choice fo expressing JSON