Build up a system to specify which Vim versions modules support

Open
  • Is something wrong?
#235 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
vim
Domain
tooling

Research direction

Start by reading the related issue #189 and the existing module conventions. The issue identifies _vital_xxx() support declarations and module tests as entry points, with open questions around documentation syntax, unsupported-version test skipping, and load-time warnings. Done requires a decided design and implementation for the listed support checks.

Written by the indexing model from the issue text.

Description

#189 から派生。

Vim のバージョンだけでなく、コンパイルオプション(+clientserver など)やプラットフォーム(Win/Mac/Linux)なども含めて、そのモジュールがサポートする Vim を規定できるようにする。

  • ドキュメントの記法を決める
  • _vital_xxx() 的なやつでサポートする Vim をコードで指定できるようにする (詳細未決定)
  • サポートしていない Vim でテストを走らせた場合は該当モジュールのテストはスキップするように
  • サポートしていない Vim でモジュールがロードされた場合に警告を出す?
    • ライブラリだし警告の出し方はプラグイン側で制御したいと思うので、警告として扱いやすい形の例外を出すのが良さそう?
Dominant language
Vim Script
Stars
586
Forks
64
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from vim-jp/vital.vim

All issues in vim-jp/vital.vim

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.