code review 4382053: misc/vim: add plugin with Fmt command.

misc/vim: add plugin with Fmt command.

Fmt command filters the current Go buffer through gofmt.
It tries to preserve cursor position and avoids replacing
the buffer with stderr output.

[dchest, 2011-04-12 12:03:24]

Hello golang-dev@googlegroups.com (cc: golang-dev@googlegroups.com),

I'd like you to review this change to
https://go.googlecode.com/hg/

[dchest, 2011-04-12 12:32:33]

Hello golang-dev@googlegroups.com (cc: golang-dev@googlegroups.com),

Please take another look.

[dsymonds, 2011-04-12 14:04:24]

I'm personally happy just running
  !gofmt -w %

which does almost exactly the same as this. Is it worth a special command?

http://codereview.appspot.com/4382053/diff/9001/misc/vim/ftplugin/go/fmt.vim
File misc/vim/ftplugin/go/fmt.vim (right):

http://codereview.appspot.com/4382053/diff/9001/misc/vim/ftplugin/go/fmt.vim#...
misc/vim/ftplugin/go/fmt.vim:9: "   :Fmt
maybe this should be :gofmt

:Fmt sounds too general.

[niemeyer, 2011-04-12 15:11:58]

>   !gofmt -w %
> 
> which does almost exactly the same as this. Is it worth a special command?

The command has the relevant advantage of preserving position.

> maybe this should be :gofmt
> 
> :Fmt sounds too general.

This is valid within a Go buffer only, so Fmt looks reasonable to me.

[dchest, 2011-04-12 15:13:36]

On 2011/04/12 14:04:24, dsymonds wrote:
> I'm personally happy just running
>   !gofmt -w %

I often forget to save buffer before running this command. Of course, I can do
"w | !gofmt -w %"  in this case, but the point of :Fmt is that it works on
buffers, not files, so it's useful for, for example, snippets of code in a new
buffer that you want to format and then paste somewhere.

Unfortunately, unlike !gofmt -w %, it doesn't display the errors yet (it just
tell that something's wrong), I'll try to make it show them. Any advice on how
to do this?

http://codereview.appspot.com/4382053/diff/9001/misc/vim/ftplugin/go/fmt.vim
File misc/vim/ftplugin/go/fmt.vim (right):

http://codereview.appspot.com/4382053/diff/9001/misc/vim/ftplugin/go/fmt.vim#...
misc/vim/ftplugin/go/fmt.vim:9: "   :Fmt
On 2011/04/12 14:04:24, dsymonds wrote:
> :Fmt sounds too general.

Since we're in Go context here, I think it better describes the function (we
don't have GoImport or GoDrop). It can be confused with "Import fmt", though, so
maybe Format?

[niemeyer, 2011-04-12 15:13:49]

http://codereview.appspot.com/4382053/diff/9001/misc/vim/ftplugin/go/fmt.vim
File misc/vim/ftplugin/go/fmt.vim (right):

http://codereview.appspot.com/4382053/diff/9001/misc/vim/ftplugin/go/fmt.vim#...
misc/vim/ftplugin/go/fmt.vim:25: call cursor(pos, 1)
There are better ways to save/restore the view.  Please check the import.vim
plugin.

[dchest, 2011-04-12 16:18:47]

Hello golang-dev@googlegroups.com, dsymonds, niemeyer (cc:
golang-dev@googlegroups.com),

Please take another look.

[dchest, 2011-04-12 16:19:03]

http://codereview.appspot.com/4382053/diff/9001/misc/vim/ftplugin/go/fmt.vim
File misc/vim/ftplugin/go/fmt.vim (right):

http://codereview.appspot.com/4382053/diff/9001/misc/vim/ftplugin/go/fmt.vim#...
misc/vim/ftplugin/go/fmt.vim:25: call cursor(pos, 1)
On 2011/04/12 15:13:49, niemeyer wrote:
> There are better ways to save/restore the view.  Please check the import.vim
> plugin.

Done, thanks!

[dsymonds, 2011-04-13 00:59:51]

LGTM

I'll let niemeyer take another quick look before submitting.

[niemeyer, 2011-04-13 01:52:03]

LGTM, and works well too. Thanks!

[dsymonds, 2011-04-13 01:55:50]

*** Submitted as http://code.google.com/p/go/source/detail?r=79173f40bb9d ***

misc/vim: add plugin with Fmt command.

Fmt command filters the current Go buffer through gofmt.
It tries to preserve cursor position and avoids replacing
the buffer with stderr output.

R=golang-dev, dsymonds, niemeyer
CC=golang-dev
http://codereview.appspot.com/4382053

Committer: David Symonds <dsymonds@golang.org>