VS Code: Rewrap block of text or comment

Question

How do I rewrap a block of text or a long comment to fit 80 columns?

I don't want it to just render the word wrap (this is easily achieved with Edit -> Toggle Word Wrap or setting "editor.wordWrap": "on"), but I want it to actually insert hard line breaks. This feature is called "fill paragraph" in some editors.

For example:

// This is a very long comment. I would like for this comment to occupy multiple lines rather than a single line, so that it is easy to read for other people.

Now I'd like to press some key to get:

// This is a very long comment. I would like for this comment to occupy
// multiple lines rather than a single line, so that it is easy to read for
// other people.

Looking for a JavaScript solution here that can run as a plugin? Does it have to be language sensitive, such as `#` vs `//`? — tadman, Mar 20 '17 at 19:13
@tadman You can use built-in class or id to identify comments, since its all html and css. — BladeMight, Mar 20 '17 at 19:16
@BladeMight Yeah, but the size of the comment delimiter impacts the wrapping, as does any indentation that might be in play. This is superficially simple but might prove to be a little obnoxious to get perfectly right. An interesting challenge. — tadman, Mar 20 '17 at 19:17

score 26 · Accepted Answer · edited Aug 09 '20 at 18:19

26

Looks like Rewrap does what you need. Not sure if there's a native way yet. They're still adding a lot of features.

edited Aug 09 '20 at 18:19

Sadman Sakib

360
2
8

answered Mar 20 '17 at 19:50

Captain Stack

3,572
5
31
56

Does not respect Python doc-string preexisting indentation. – Justin Solms Sep 06 '19 at 11:39
@JustinSolms I use it for python docstrings. Works great, even in item lists etc. – John Oct 18 '20 at 05:17

score 10 · Answer 2 · answered Mar 21 '17 at 01:00

10

VSCodeVim supports this feature. Just select a block of text and press gq. :)

answered Mar 21 '17 at 01:00

thedayturns

9,723
5
33
41

1

Can this be automated so that you dont have to `gq` ? Equivalent to `set textwidth` on vim ? – umayfindurself May 27 '17 at 11:23
@umayfindurself thats probably a vscode setting somewhere – thedayturns May 28 '17 at 22:29
@umayfindurself Since version 1.9.1 it is possible with [Rewrap](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap): `"rewrap.autoWrap.enabled": true` – john c. j. Jul 28 '18 at 14:46
I love the solution! Lean! – lkahtz Nov 30 '22 at 02:24
dang I forgot the gq command existed in vim for like a whole year until I found this answer – thatguyintech Dec 01 '22 at 07:03

VS Code: Rewrap block of text or comment

2 Answers2

Linked