jaredly / jaredly/reason-language-server

"Dependencies: ......" expression in front of types, in case of no dependencies

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

Nobody has claimed this yet.

Dominant language
OCaml
Stars
649
Forks
85
PR merge metrics
No merged PRs in 30d

Description

This issue here is a cosmetic one, but could help newcomers.
As an example I am using [re-web](https://github.com/yawaramin/re-web/)
E.g. there are two files, 1) `Body.mli` and 2) `Body.ml`.

First has no dependencies, but the grey colored label does not say "Dependencies: -", "Dependencies: (none)" or omits the label, but it says "Dependencies:" (screenshot 1). This is irritating, since a newcomer might refer this to any paragraph coming below the label. Intuitively, when there are no dependencies, I'd best like to have the label omitted fully.

Second has dependencies, so they are enumerated in grey font color (screenshot 2).

![image](https://user-images.githubusercontent.com/752620/78451026-1a2a6200-7683-11ea-9273-4ee937371f4b.png)
![image](https://user-images.githubusercontent.com/752620/78451054-565dc280-7683-11ea-8dde-0037d099c4b2.png)

Contributor guide

No contributing guide indexed for this repository

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

Reproduce the display with re-web's Body.mli and Body.ml examples, then trace the language-server code that renders the Dependencies label. The change is done when a file with no dependencies omits the empty label while a file with dependencies still lists them.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
devtools
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.