go.mod file support #1931

fatih · 2018-08-30T14:41:38Z

This adds initial support for the go.mod file. It adds the
followings:

Syntax highligthing. We highlight keywords, strings, operator and
semver version. It works pretty well for now.
Auto fmt on save. Command :GoModFmt or Plug(go-mod-fmt) for custom
mappings

Before we fully support the semantics of go.mod, I think this initially
will be helpful because I discovered that go.mod is read and edited a
lot. So going forward, this will make it easier experimenting with Go
modules.

Add documentation
Make sure auto modfmt toggle commands work fine
Add v1.11 guard for :GoModFmt

related: #1906

bhcleek

Good work @fatih. It's exciting to see this support being added. I've left a few comments; most of them are either about possibly mistakenly added files or trying to be consistent with other approaches around error and list handling.

bhcleek · 2018-08-30T16:22:45Z

autoload/go/fix.vim

@@ -0,0 +1 @@
+/Users/fatih/go/src/github.com/fatih/goautofix/vim/fix.vim


This looks like it was mistakenly committed.

Yeah, it was symlinked (I was lazy) from a personal project for a small tool I wrote and wanted to try out. Removed them :)

bhcleek · 2018-08-30T16:26:02Z

autoload/go/mod.vim

+  call go#list#Window(l:listtype, len(a:errors))
+endfunction
+
+function! go#mod#ToggleModfmtAutoSave() abort


fmt should probably be Fmt for consistency...

bhcleek · 2018-08-30T16:26:49Z

autoload/go/mod.vim

+  let l:listtype = go#list#Type("GoModFmt")
+  if !empty(a:errors)
+    call go#list#Populate(l:listtype, a:errors, 'Format')
+    echohl Error | echomsg "GoModFmt returned error" | echohl None


You can use go#util#EchoError instead...

bhcleek · 2018-08-30T16:29:01Z

autoload/go/mod.vim

+function! s:show_errors(errors) abort
+  let l:listtype = go#list#Type("GoModFmt")
+  if !empty(a:errors)
+    call go#list#Populate(l:listtype, a:errors, 'Format')


Instead of passing in the parsed errors and calling go#list#Populate manually, can you use an errorformat string and call go#list#ParseFormat?

I just tried it, but I think it'll not work because we run the command on a temporary file first (because go mod edit does an in-place edit). This means that the initial %f is the temporary filename. This is copied from fmt.vim and it's the same issue. I'll check if I can do something ( I would prefer ParseFormat indeed)

Hmmmm... If you know the temporary filename, then it should be easy enough to do a substitute(...) on a:errors before passing to ParseFormat.

I think at this point, this is too much a hack. We're having a working version and it really works fine. Not sure if it's worth doing it (same applies for gofmt).

bhcleek · 2018-08-30T16:31:26Z

autoload/go/mod.vim

+  " list of errors to be put into location list
+  let errors = []
+  for line in splitted
+    let tokens = matchlist(line, '^\(.\{-}\):\(\d\+\):\(\d\+\)\s*\(.*\)')


This regex is relatively easy to turn into an errorformat string. It looks like it follows the usual pattern, so the errorformat string would be %f:%l:%c:\ %m

bhcleek · 2018-08-30T16:31:55Z

ftplugin/go/commands-fix.vim

@@ -0,0 +1 @@
+/Users/fatih/go/src/github.com/fatih/goautofix/vim/commands-fix.vim


Is this another mistakenly added file?

arp242 · 2018-08-30T17:02:10Z

ftdetect/gofiletype.vim

@@ -31,4 +31,8 @@ au BufReadPost *.s call s:gofiletype_post()

 au BufRead,BufNewFile *.tmpl set filetype=gohtmltmpl

+au BufNewFile *.mod setfiletype gomod | setlocal fileencoding=utf-8 fileformat=unix
+au BufRead *.mod call s:gofiletype_pre("gomod")
+au BufReadPost *.mod call s:gofiletype_post()


This conflicts with a built-in filetype: https://github.com/vim/vim/blob/master/runtime/filetype.vim#L996-L1002

Would probably be better to explicitly use go.mod, and maybe even check if the first line matches module <ImportPath>?

Good catch @Carpetsmoker !

go.mod seems like the right call to me, maybe in conjunction with check the first line?

I'll add the checking line 👍 However, can I really use a . inside a ft? I checked the link martin gave and a filetype is always a single word. I think we keep it gomod. It's not that bad.

Nevermind. I misunderstood, gonna use explicit go.mod :)

This adds initial support for the `go.mod` file. It adds the followings: * Syntax highligthing. We highlight keywords, strings, operator and semver version. It works pretty well for now. * Auto fmt on save. Command `:GoModFmt` or `Plug(go-mod-fmt)` for custom mappings Before we fully support the semantics of go.mod, I think this initially will be helpful because I discovered that `go.mod` is read and edited a lot. So going forward, this will make it easier experimenting with Go modules. related: #1906

fatih · 2018-08-30T20:24:55Z

@bhcleek @Carpetsmoker fixed all review comments and added a couple of improvements. PTAL

bhcleek · 2018-08-30T22:26:24Z

lgtm, but there's linting problems.

voutasaurus · 2018-08-30T23:05:28Z

lgtm, but there's linting problems.
https://github.com/fatih/vim-go/pull/1931/files#diff-d7201d5be221f16a9b1825e6a48685e9R1905

It's just one line in the docs that's over the line limit (needs to be wrapped/rewritten). I'd fix it if you want (I don't have access though).

* Fix auto toggle command * Add guard agains Go versions lower than 1.11 * Add documentation * Fixed setting correct filetype * Fixed parsing errors * Changed variable names to be consistent

fatih · 2018-08-31T05:40:03Z

@bhcleek @voutasaurus thanks! It was late after I pushed it, so didn't check the Travis results. I fixed and force pushed it. I'll merge it once it's green.

fatih added the wip label Aug 30, 2018

fatih mentioned this pull request Aug 30, 2018

Support Go modules #1906

Closed

4 tasks

bhcleek reviewed Aug 30, 2018

View reviewed changes

arp242 reviewed Aug 30, 2018

View reviewed changes

fatih force-pushed the go-modules-syntax branch from dd1dd81 to 3d725eb Compare August 30, 2018 17:52

fatih removed the wip label Aug 30, 2018

fatih force-pushed the go-modules-syntax branch from ce4af06 to d13e1e7 Compare August 30, 2018 20:26

Fix review comments

3b04072

* Fix auto toggle command * Add guard agains Go versions lower than 1.11 * Add documentation * Fixed setting correct filetype * Fixed parsing errors * Changed variable names to be consistent

fatih force-pushed the go-modules-syntax branch from d13e1e7 to 3b04072 Compare August 31, 2018 05:39

fatih merged commit c1dd611 into master Aug 31, 2018

fatih deleted the go-modules-syntax branch August 31, 2018 05:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

go.mod file support #1931

go.mod file support #1931

fatih commented Aug 30, 2018 •

edited

Loading

bhcleek left a comment

bhcleek Aug 30, 2018

fatih Aug 30, 2018

bhcleek Aug 30, 2018

bhcleek Aug 30, 2018

bhcleek Aug 30, 2018

fatih Aug 30, 2018

bhcleek Aug 30, 2018

fatih Aug 30, 2018

bhcleek Aug 30, 2018 •

edited

Loading

bhcleek Aug 30, 2018

arp242 Aug 30, 2018

bhcleek Aug 30, 2018

fatih Aug 30, 2018

fatih Aug 30, 2018

fatih commented Aug 30, 2018

bhcleek commented Aug 30, 2018

voutasaurus commented Aug 30, 2018

fatih commented Aug 31, 2018

		@@ -0,0 +1 @@
		/Users/fatih/go/src/github.com/fatih/goautofix/vim/fix.vim

		@@ -0,0 +1 @@
		/Users/fatih/go/src/github.com/fatih/goautofix/vim/commands-fix.vim

go.mod file support #1931

go.mod file support #1931

Conversation

fatih commented Aug 30, 2018 • edited Loading

bhcleek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bhcleek Aug 30, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fatih commented Aug 30, 2018

bhcleek commented Aug 30, 2018

voutasaurus commented Aug 30, 2018

fatih commented Aug 31, 2018

fatih commented Aug 30, 2018 •

edited

Loading

bhcleek Aug 30, 2018 •

edited

Loading