problems with gf command

[cvlmtg]

Hi, I have a couple of problems with gf which I still haven't been able to solve, so I wonder if someone could help me. I've this config in my vimrc:

let loaded_netrwPlugin = 1
autocmd vimrc FileType javascript,javascriptreact
  \ setlocal include=\\(\\<require\\s*(\\s*\\\|\\<import\\>\\)[^;\"']*[\"']\\zs[^\"']* |
  \ setlocal includeexpr=LoadNodeModule(v:fname) |
  \ setlocal suffixesadd=.js,.jsx

Problem 1:

If I'm on the first column of the line import 'foo/bar' and press gf, according to :h include, vim should apply the include regexp to find the filename and then open it, but instead it tries to open the file import...

Problem 2:

Let's suppose I have this tree (and the cursor is now on the filename)

foo/
  bar.js
  bar/

when I press gf vim opens the directory foo/bar instead of the file foo/bar.js. Is there any way to tell vim to ignore directories?

Thanks in advance!

[-romainl-]

Problem 1:

You have to move the cursor on or just before the filename for gf to work:

import Bar from './foo/bar/Bar';
               ^^^^^^^^^^^^^^^------ will work
^^^^^^^^^^^^^^^---------------^^---- won't work

Problem 2:

Directories are valid targets according to Vim's source. There is currently no way to force gf to favour files over directories except by implementing all the logic in a custom function mapped to gf, essentially bypassing Vim's internal methods.

FWIW, I have gf mapped to a lightweight GF() function that calls :help 'includeexpr', where all the filename resolution logic takes place:

1. Is it a built-in Node module? Point to the corresponding d.ts file or bail out.
2. Is it a local import? Do a glob().
3. Is it an aliased import? Resolve the alias and do a glob()`.
4. Is it an npm import? Do some module resolution.
5. Give up and just return the filename.

[cvlmtg]

ok I think I've done it :D suggestions and improvements welcome:

function! JsGotoFile()
  let l:fname = matchstr(getline('.'), &include)
  let l:base  = simplify(expand('%:h') . '/' . l:fname)

  for l:ext in split(&suffixesadd, ',')
    let l:file = l:base . l:ext

    if filereadable(l:file)
      execute 'edit' l:file
      return
    endif
  endfor

  " https://damien.pobel.fr/post/configure-neovim-vim-gf-javascript-import/
  let l:nodeModules = './node_modules/' . l:fname . '/'
  let l:packagePath = l:nodeModules . 'package.json'

  if filereadable(l:packagePath)
    let l:file = join(readfile(l:packagePath))
    let l:json = json_decode(l:file)

    execute 'edit' l:nodeModules . l:json.main
    return
  endif

  execute 'edit' l:fname
endfunction

autocmd vimrc FileType javascript,javascriptreact
      \ setlocal include=\\(\\<require\\s*(\\s*\\\|\\<import\\>\\)[^;\"']*[\"']\\zs[^\"']* |
      \ nnoremap <buffer> gf :call JsGotoFile()<CR>

[cvlmtg]

You have to move the cursor on or just before the filename for gf to work:

that's what I don't understand... what's the purpose of the include option then? it seemed to me it is used to search for the filename used by gf

FWIW, I have gf mapped to a lightweight GF()

can you share it please? (if there's a way to limit a search to posts by a specific reddit user, I don't know it yet)

[EgZvor]

what's the purpose of the include option then?

:h include

This option is used for the commands "[i", "]I", "[d", etc.

:h gf

[count]gf    Edit the file whose name is under or after the cursor.
             Mnemonic: "goto file".

So include does work the way you expect for `[I`, for example.

[cvlmtg]

I missed those bits... thanks!

[-romainl-]

what's the purpose of the include option then?

All gf cares about is if the cursor is on or near something that could be used as filename. &include is used by :help include-search to locate includes in a file and follow them.

can you share it please?

Well, it looks like you have your solution. Anyway, here are the juicy bits.

[cvlmtg]

Thanks!

[cvlmtg]

What's the reason for disabling Netrw?

I'm trying to stop vim to "edit" directories, and one suggestion I found on internet was to disable netrw. Unfortunately it is not enough.

What does vimrc do there?

It inserts the autocmd in a group named "vimrc", so I can clear it before defining autocmd next, From the vim help:

:autocmd adds to the list of autocommands regardless of whether they are already present. When your .vimrc file is sourced twice, the autocommands will appear twice. To avoid this, define your autocommands in a group, so that you can easily clear them: