rescript-lang / rescript-lang/vim-rescript

ctags / tags integration for listing the outline

Open
#15 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vim Script
Stars
164
Forks
17
PR merge metrics
No merged PRs in 30d

Description

A common VIM workflow is to create tags file (often via ctags). There is no ReScript / ctags language extension, but maybe this is not even needed.

In a first version it would be perfectly fine to comply to the ctags file format and use the editor-support binary to retrieve the data for our modules.

When rescript-vscode supports outlines, it would also be possible to use that functionality to list outlines via coc-vim of course. I want to have a vanilla vim version first though.

Also check out how to use tags / how to create tag files in vim.

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 by reading the referenced ctags file format and Vim tags workflow, then inspect how the editor-support binary can retrieve module data. Define the tag output and outline coverage before implementing it. Done means vanilla Vim can use the generated ctags-compatible data to list and navigate ReScript outlines.

Written by the indexing model from the issue text.

Assessment

Tech stack
vim
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.