redhat-developer / redhat-developer/rsp-client

derive capabilities version from client version

Open
#90 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
6
Forks
14
PR merge metrics
No merged PRs in 30d

Description

The client reports client capabilities protocol version. See here: https://github.com/redhat-developer/rsp-client/blob/master/src/client.ts#L116

export class RSPClient {
    ...
    /**
     * Returns the capabilities implemented by the client
     */
    getCapabilities(): Protocol.ClientCapabilitiesRequest {
        return {map: {'protocol.version': '0.16.0', 'prompt.string': 'true'}};
    }

This version should match the client/protocol version and tends to be forgotten when bumping the client version. We thus should find a way to derive this version from the client version.
A suggestion is to parse package.json, extract the version and use it when building the client. See here: https://github.com/redhat-developer/rsp-client/pull/87#issuecomment-499432884

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/client.ts at RSPClient.getCapabilities() and review package.json for the client version. Check the approach suggested in pull request 87's comment, then verify that the reported protocol.version is derived from the package version and remains synchronized when the client version changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.