[RFC] Set 'keywordprg' for vim and help filetypes. #3104

lithammer · 2015-07-26T15:04:18Z

Open the Vim help file instead of man when pressing K in normal mode.

lithammer · 2015-07-26T15:05:36Z

I guess this should have the defaults label.

vheon · 2015-07-26T17:05:13Z

I would prefer this behaviour from tpope/vim-scriptease as a default for vim files.

justinmk · 2015-07-26T17:26:30Z

Yeah, I was thinking scriptease should be a default plugin, actually. (Please don't send a PR for that, though...)

@vheon Any reason this PR would be a problem in the meantime? If users have scripttease they won't notice, and users that don't have scriptease get some benefit.

lithammer · 2015-07-26T17:29:55Z

What does that scriptease snippet actually do? It wasn't immediately obvious to me.

fmoralesc · 2015-07-26T17:31:01Z

@Renstrom It adjusts the help-topic depending on what's under the cursor.

lithammer · 2015-07-26T17:34:22Z

Ah, so it's just a bit more intelligent than this solution?

vheon · 2015-07-26T17:38:58Z

@Renstrom yes

@justinmk no, absolutely. I was just thinking to do it right once, since the solution is already available.

ghost · 2015-07-26T18:30:22Z

This should be mentioned in vim_diff.txt.

Besides that I've used this for a while, and while it mostly works fine I've always had the following issue:

open empty buffer, :setf help
create the buffer contents |help-context|
put cursor on first letter and press K, taken to *help* tag
put cursor on c and press K, taken to *:syn-context* tag

I just tried :set iskeyword+=- and it seems to fix it, but I'm not sure if it will work in all cases.

fmoralesc · 2015-07-26T18:59:09Z

@pyrohh It's weird you had to do that, since the help on 'iskeyword' says:

For a help file it is set to all non-blank printable characters except
'*', '"' and '|' (so that CTRL-] on a command finds the help for that
command).

I think that is not true.

lithammer · 2015-07-27T11:16:32Z

In the case of using the scriptease version, where would one put the s:helptopic() function?

fmoralesc · 2015-07-27T11:24:59Z

I would suggest you put it in some file in runtime/autoload, so you can call it from both vim and help files, and it only gets defined on demand.

You'll also need to modify it so it can work standalone, as it stands it uses some other stuff from scriptease.

lithammer · 2015-09-16T19:58:28Z

Ported the functionality from vim-scriptease.

ZyX-I · 2015-09-16T20:09:06Z

runtime/autoload/help.vim

+  return reverse(map(synstack(line, col), 'synIDattr(v:val,"name")'))
+endfunction
+
+function! HelpTopic()


Since you are using autoload file you must use help#topic() (help is because file is named {rtp}/autoload/help.vim).

Also missing abort.

ZyX-I · 2015-09-16T20:22:20Z

@neovim/core Also what about tests? In #3270 I assumed that it is bad idea to add any code without testing and put tests for runtime files into test/functional/plugin. I think it is needed to establish an agreement on this matter. E.g. for this issue it needs to test that K opened in help and vim files opens right topics.

ZyX-I · 2015-09-16T20:24:12Z

runtime/autoload/help.vim

+  let post = getline('.')[col : -1]
+  let syn = get(synnames(), 0, '')
+  let cword = expand('<cword>')
+  if syn ==# 'vimFuncName'


The entire function is for .vim files: this and the following conditions will never match in a help file. I think this needs to be altered: topic for functions should be opened if current word is immediately followed by a parenthesis in addition to syn check.

ZyX-I · 2015-09-16T20:36:09Z

runtime/autoload/help.vim

+    return ':'.cword
+  elseif pre =~# '\<v:$'
+    return 'v:'.cword
+  elseif cword ==# 'v' && post =~# ':\w\+'


ZyX-I · 2015-09-16T20:42:39Z

By the way, why using help#topic() for help files at all? Simple nnoremap <buffer> K <C-]> should be enough here.

justinmk · 2015-09-16T21:01:26Z

what about tests? In #3270 I assumed that it is bad idea to add any code without testing and put tests for runtime files into test/functional/plugin

Yes, we prefer tests. And test/functional/plugin/help_spec.lua would be a good place for it.

josephholsten · 2017-07-07T20:33:24Z

@justinmk @ZyX-I @Renstrom what's remaining to get this completed? I'm personally happy with autocmd Filetype vim setlocal keywordprg=:help, but this fancier impl seems close.

Open the Vim help file instead of 'man' when pressing 'K' in normal mode. Credits to Tim Pope for the original implementation in vim-scriptease.

lithammer · 2017-07-07T22:21:00Z

I tried to address some comments and rebased since this was two years old. Unfortunately I'm quite bad a Vimscript.

mhinz · 2017-07-08T00:34:16Z

runtime/autoload/help.vim

+    return "'" . cword . "'"
+  elseif pre =~# '&$' || pre =~# '&[lg]:$'
+    return "'" . cword . "'"
+  elseif pre =~# 'set\s\+$' || pre =~# '\vsetl(ocal)?\s+$' || pre =~# '\vsetg(lobal)?\s+$'


This matches setl and setlocal, but not setloc. Use this instead:

elseif pre =~# '\vset?\s+$' || pre =~# '\vsetl%[ocal]\s+$' || pre =~# '\vsetg%[lobal]\s+$'

josephholsten · 2017-07-08T01:43:52Z

runtime/autoload/help.vim

+endif
+let g:loaded_help = 1
+
+function! help#topic() abort


Is this function obvious enough that it doesn't need a comment? I'm too green to judge. Would it qualify as obvious if it had tests?

Honestly, I barely know myself since this was blatantly copied from https://github.com/tpope/vim-scriptease/blob/59a73a2415ea1b006ae3e91163ddde24e8540844/autoload/scriptease.vim#L693-L723. Initially this pull request only contained a simple keywordprg=:help, but then it was suggested to use vim-scriptease's more intelligent lookup.

But in short, this function looks at the word under the cursor (e.g. what syntax group it has), and on the word(s) coming before and after.

justinmk · 2017-07-08T11:10:43Z

Contrary to #3104 (comment) I think it's now a good time to include scriptease as a standard plugin. @tpope do you have any objection to that?

lithammer · 2017-07-08T11:36:56Z

What does it really mean to include as a standard plugin?

justinmk · 2017-07-08T12:44:47Z

@Renstrom It means include the plugin in runtime/pack/dist/start/scriptease

justinmk · 2017-07-08T13:23:59Z

6720fe2 includes a minimal version of this change.

A new PR including runtime/pack/dist/start/scriptease would be welcome. We would like to establish a workflow for including more plugins as standard plugins in runtime/pack/dist/*, possibly as git subtrees. Help there is welcome.

tpope · 2017-07-08T18:46:39Z

No objection. I would recommend sticking to stable releases rather than tracking master, though with Neovim still in development maybe that doesn't matter.

ZyX-I · 2017-07-08T19:47:43Z

Neovim is indeed in development and here we at least wait for CI before merging patches, so I would rather suggest master.

FEATURES: 0e873a3 Lua(Jit) built-in neovim#4411 5b32bce Windows: `:terminal` neovim#7007 7b0ceb3 UI/API: externalize cmdline neovim#7173 b67f58b UI/API: externalize wildmenu neovim#7454 b23aa1c UI: 'winhighlight' neovim#6597 17531ed UI: command-line coloring (`:help input()-highlight`) neovim#6364 244a1f9 API: execute lua directly from the remote api neovim#6704 45626de API: `get_keymap()` neovim#6236 db99982 API: `nvim_get_hl_by_name()`, `nvim_get_hl_by_id()` neovim#7082 dc68538 menu_get() function neovim#6322 9db42d4 :cquit : take an error code argument neovim#7336 9cc185d job-control: serverstart(): support ipv6 neovim#6680 1b7a9bf job-control: sockopen() neovim#6594 6efe84a clipboard: fallback to tmux clipboard neovim#6894 6016ac2 clipboard: customize clipboard with `g:clipboard` neovim#6030 3a86dd5 ruby: override ruby host via `g:ruby_host_prog` neovim#6841 16cce1a debug: $NVIM_LOG_FILE neovim#6827 0cba3da `:checkhealth` built-in, validates $VIMRUNTIME neovim#7399 FIXES: 105d680 TUI: more terminals, improve scroll/resize neovim#6816 cb912a3 :terminal : handle F1-F12, other keys neovim#7241 619838f inccommand: improve performance neovim#6949 04b3c32 inccommand: Fix matches for zero-width neovim#7487 60b1e8a inccommand: multiline, other fixes neovim#7315 f1f7f3b inccommand: Ignore leading modifiers in the command neovim#6967 1551f71 inccommand: fix 'gdefault' lockup neovim#7262 6338199 API: bufhl: support creating new groups neovim#7414 541dde3 API: allow K_EVENT during operator-pending 8c732f7 terminal: adjust for 'number' neovim#7440 5bec946 UI: preserve wildmenu during jobs/events neovim#7110 c349083 UI: disable 'lazyredraw' during ui_refresh. neovim#6259 51808a2 send FocusGained/FocusLost event instead of pseudokey neovim#7221 133f8bc shada: preserve unnamed register on restart neovim#4700 1b70a1d shada: avoid assertion on corrupt shada file neovim#6958 9f534f3 mksession: Restore tab-local working directory neovim#6859 de1084f fix buf_write() crash neovim#7140 7f76986 syntax: register 'Normal' highlight group neovim#6973 6e7a8c3 RPC: close channel if stream was closed neovim#7081 85f3084 clipboard: disallow recursion; show hint only once neovim#7203 8d1ccb6 clipboard: performance, avoid weird edge-cases neovim#7193 01487d4 'titleold' neovim#7358 01e53a5 Windows: better path-handling, separator (slash) hygiene neovim#7349 0f2873c Windows: multibyte startup arguments neovim#7060 CHANGES: 9ff0cc7 :terminal : start in normal-mode neovim#6808 032b088 lower priority of 'cursorcolumn', 'colorcolumn' neovim#7364 2a3bcd1 RPC: Don't delay notifications when request is pending neovim#6544 023f67c :terminal : Do not change 'number', 'relativenumber' neovim#6796 1ef2d76 socket.c: Disable Nagle's algorithm on TCP sockets neovim#6915 6720fe2 help: `K` tries Vim help instead of manpage neovim#3104 7068370 help, man.vim: change "outline" map to `gO` neovim#7405

fmoralesc added defaults Nvim defaults for options, colorscheme/theme, autocmds/events, etc. runtime funtime labels Jul 26, 2015

ghost changed the title ~~Set 'keywordprg' for vim and help filetypes.~~ [RFC] Set 'keywordprg' for vim and help filetypes. Jul 26, 2015

marvim added the RFC label Jul 26, 2015

lithammer force-pushed the set-keywordprg-for-vim-and-help branch 2 times, most recently from 949e950 to 34b9794 Compare September 16, 2015 19:57

ZyX-I reviewed Sep 16, 2015
View reviewed changes

lithammer mentioned this pull request Sep 23, 2015

use :Man instead of man for K #1878

Merged

6 tasks

lithammer force-pushed the set-keywordprg-for-vim-and-help branch from eaa1533 to ce6d317 Compare October 18, 2015 10:15

Peter Renström added 5 commits July 8, 2017 00:20

Set keywordprg for vim and help filetypes.

ce98dd6

Open the Vim help file instead of 'man' when pressing 'K' in normal mode. Credits to Tim Pope for the original implementation in vim-scriptease.

help: Add autoload guard (I think?)

8442850

help: Use correct function name

a33f027

help: Remove unneeded s:synnames

2800bfe

help: Improve logic for options and functions

a13ea1d

lithammer force-pushed the set-keywordprg-for-vim-and-help branch from 759316d to a13ea1d Compare July 7, 2017 22:20

mhinz reviewed Jul 8, 2017

View reviewed changes

josephholsten reviewed Jul 8, 2017

View reviewed changes

justinmk closed this Jul 8, 2017

justinmk removed the RFC label Jul 8, 2017

justinmk pushed a commit that referenced this pull request Jul 8, 2017

runtime: K: prefer Vim help instead of man #3104

6720fe2

lithammer deleted the set-keywordprg-for-vim-and-help branch July 8, 2017 14:13

justinmk mentioned this pull request Nov 8, 2017

NVIM v0.2.1 #7505

Merged

Uh oh!

[RFC] Set 'keywordprg' for vim and help filetypes. #3104

[RFC] Set 'keywordprg' for vim and help filetypes. #3104

Uh oh!

Conversation

lithammer commented Jul 26, 2015

Uh oh!

lithammer commented Jul 26, 2015

Uh oh!

vheon commented Jul 26, 2015

Uh oh!

justinmk commented Jul 26, 2015

Uh oh!

lithammer commented Jul 26, 2015

Uh oh!

fmoralesc commented Jul 26, 2015

Uh oh!

lithammer commented Jul 26, 2015

Uh oh!

vheon commented Jul 26, 2015

Uh oh!

ghost commented Jul 26, 2015

Uh oh!

fmoralesc commented Jul 26, 2015

Uh oh!

lithammer commented Jul 27, 2015

Uh oh!

fmoralesc commented Jul 27, 2015

Uh oh!

lithammer commented Sep 16, 2015

Uh oh!

ZyX-I Sep 16, 2015

Choose a reason for hiding this comment

Uh oh!

ZyX-I Sep 16, 2015

Choose a reason for hiding this comment

Uh oh!

ZyX-I commented Sep 16, 2015

Uh oh!

ZyX-I Sep 16, 2015

Choose a reason for hiding this comment

Uh oh!

ZyX-I Sep 16, 2015

Choose a reason for hiding this comment

Uh oh!

ZyX-I commented Sep 16, 2015

Uh oh!

justinmk commented Sep 16, 2015

Uh oh!

josephholsten commented Jul 7, 2017

Uh oh!

lithammer commented Jul 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mhinz Jul 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josephholsten Jul 8, 2017

Choose a reason for hiding this comment

Uh oh!

lithammer Jul 8, 2017

Choose a reason for hiding this comment

Uh oh!

justinmk commented Jul 8, 2017

Uh oh!

lithammer commented Jul 8, 2017

Uh oh!

justinmk commented Jul 8, 2017

Uh oh!

justinmk commented Jul 8, 2017

Uh oh!

tpope commented Jul 8, 2017

Uh oh!

ZyX-I commented Jul 8, 2017

Uh oh!

Uh oh!

lithammer commented Jul 7, 2017 •

edited

Loading

mhinz Jul 8, 2017 •

edited

Loading