nim-works/nimskull

LSP (Language Server Protocol) Replacement for Nimsuggest

Open

#448 opened on Oct 9, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Nim (39 forks)auto 404
good first issue

Repository metrics

Stars
 (346 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently we have a nimsuggest which, when the compiler's semantic analysis works, provides autocomplete, documentation lookup, and more. This is via a protocol unique to nimsuggest. On the other hand many text editors, IDEs, etc nearly universally implement clients for the Language Sever Protocol.

Prior Art/Existing Implementations:

What needs to be done:

  • write an LSP server that lives side by side nimsuggest
    • it should be in this repository as we'll replace nimsuggest with it
  • it needs to have strong test coverage
  • once it's stable and we have a vscode extension, drop nimsuggest

Contributor guide

Research direction
Study the existing nimsuggest implementation and the LSP specification. Then build a prototype based on the prior art like nimlsp.
Tech stack
None
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
NimLSP protocol
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25