Fold import, var, and const blocks #1339
Conversation
This adds `foldmethod=syntax` folding for `import`, `var`, and `const` blocks.
I added a new `g:go_fold_enable` setting to selectively enable which regions get
folded. I find this useful personally as I only want to fold `import` blocks.
Future extension to this might be:
- `struct` and `interface`, to selectively fold `type foo struct { .. }` and
`type foo interface { .. }` definitions;
- `package`, to fold the package-level comment.
But that's another PR for another day ;-)
Fixes: #963
There was a problem hiding this comment.
Thanks @Carpetsmoker This looks awesome. There are some things that needs to be taken care of. Once we have these I think it's good to go
doc/vim-go.txt
Outdated
| Enable folding of only imports: | ||
| > | ||
| let g:go_fold = ['import'] | ||
| < |
There was a problem hiding this comment.
I don't like changing variables to two different types. I would rather have two settings than one. One of enabling/disabling and one for changing the settings.
There was a problem hiding this comment.
Could also just make the default be let g:go_fold = ['import', 'block', 'varconst']? The 1 was just a shortcut for this.
I'm not sure if we need two variables, and it will confuse things if they're both set.
There was a problem hiding this comment.
Ok that works. But can you add a piece of text on how to disable it (i.e: setting to empty list) so people know it.
| @@ -1589,6 +1588,23 @@ By default "snakecase" is used. Current values are: ["snakecase", | |||
| > | |||
| let g:go_addtags_transform = 'snakecase' | |||
| < | |||
| *'g:go_fold_enable'* | |||
There was a problem hiding this comment.
I think we should add a line explaining that they get this when they also add set foldmethod=syntax to their vimrc
syntax/go.vim
Outdated
| syn keyword goDeclaration var const | ||
| syn keyword goPackage package | ||
| syn keyword goImport import contained | ||
| syn keyword goVarConst var const contained |
There was a problem hiding this comment.
This changes the semantics of the syntax settings. In go const, var and type all are declarations, so goDeclaration is the correct setting here. Actually things like import or func are also declarations. I'm not sure why they were added as goDirective back then. If you need to access them, I think the better way would be using goVar and goConst, instead of combining them. At least that would give it a correct meaning (even if it's more fine grained now)
syntax/go.vim
Outdated
| endif | ||
|
|
||
| " Single-line var, const, and import. | ||
| syn match goSingleImport /\(import\|var\|const\) [^(]\@=/ contains=goImport,goVarConst |
syntax/go.vim
Outdated
| " Single-line var, const, and import. | ||
| syn match goSingleImport /\(import\|var\|const\) [^(]\@=/ contains=goImport,goVarConst | ||
|
|
||
| "syn region goImport start='var ' end=''contains=goVarConst |
This adds
foldmethod=syntaxfolding forimport,var, andconstblocks.I added a new
g:go_fold_enablesetting to selectively enable which regions getfolded. I find this useful personally as I only want to fold
importblocks.Future extension to this might be:
structandinterface, to selectively foldtype foo struct { .. }andtype foo interface { .. }definitions;package, to fold the package-level comment.But that's another PR for another day ;-)
Fixes: #963