VSCodeVim / VSCodeVim/Vim

Expose a Command API

Open
#9,103 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
15.2k
Forks
1.5k
Avg merge
3d 18h
Merged PRs (30d)
6

Description

Is your feature request related to a problem? Please describe.
Hi everyone,
i recently authored a port of the vim fugitive plugin to VS Code.
However, a major part of the functionality is missing, because i am not
supporting the :Git commands.
These would require, that i could register a custom vim command.

Describe the solution you'd like
I would like VSCodeVim to expose an API similar to vscode.commands.registerCommand(...)
This opens up the possibility for additional VSCodeVim plugins, which do not have to be maintained by this project.

Describe alternatives you've considered
I tried using the terminal as a vim command replacement, however this approach is not ergonomic.

Additional context
A link to my repo: https://github.com/Henrik-St/vscode-fugitive

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

Use VS Code's vscode.commands.registerCommand API as the reference and study the requested VSCodeVim integration for the vscode-fugitive use case. Define the public registration and invocation behavior needed for custom :Git commands, then verify that an external plugin can use it without changes to this project.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vim, vscode
Domain
api, developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.