VSCodeVim/Vim

Implement tcomment instead of vim-commentary (specifically commenting text objects)

Open

#2242 opened on Dec 23, 2017

View on GitHub
 (0 comments) (8 reactions) (0 assignees)TypeScript (12,664 stars) (1,271 forks)batch import
help wantedkind/feature

Description

  • Click thumbs-up 👍 on this issue if you want it!
  • Click confused 😕 on this issue if not having it makes VSCodeVim unusable.

The VSCodeVim team prioritizes issues based on reaction count.

Is this a BUG REPORT or FEATURE REQUEST? (choose one): Feature Request

I've switched to tcomment over vim-commentary for a few different reasons:

  1. Commenting in JSX (this is actually already implemented in VSCodeVim, it doesn't work very well in the original vim-commentary implementation)
  2. More flexible commenting with movements and text objects.

Consider the following:

function foo(bar: string): string {
  return 'bar';
}

If I have my cursor on the b of bar and press gci(, vim-commentary will produce the following:

//function foo(bar: string): string {
  return 'bar';
}

tcomment, on the other hand, will produce the following:

function foo(/*bar: string*/): string {
  return 'bar';
}

VSCodeVim currently implements the vim-commentary functionality, I would argue that the tcomment functionality is much better.

Contributor guide

Tech stack
typescript
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with Vim text objectsunderstanding of VSCodeVim extension
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests replacing vim commentary with tcomment for better commenting of text objects. The current commenting logic is likely in a specific file; search for references to 'commentary' in the codebase. The implementation should handle text objects like `gci(` as shown. No linked PRs or comments. A good starting point is to understand how the current commenting works and then adapt the tcomment approach.