Add :TerraformDoc and :TerraformDocBrowser

[iypetrov]

Language Server Version

v0.36.4

Problem Statement

In vim-go there are a really nice features like :GoDoc and :GoDocBrowser.

:GoDoc [word]

Open the relevant GoDoc in split window for either the word[s] passed to
the command or by default, the word under the cursor.

:GoDocBrowser [word]

Open the relevant GoDoc in browser for either the word[s] passed to the
command or by default, the word under the cursor. By default it opens the
documentation in `https://pkg.go.dev`. To change it see |'g:go_doc_url'|.

I wonder do you have such implementation in terraform-ls or do you plan to have it in a future?

Attempted Solutions

No response

Proposal

No response

Related LSP methods

No response

References

No response

Help Wanted

• I'm interested in contributing a fix myself

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

[iypetrov]

For anyone who wants this feature, I wrote a custom Vim script that is definitely not perfect but gets the job done(at least for me)

function! OpenURL(url)
  if a:url != ''
    let l:command = '!open ' . shellescape(a:url) . ' > /dev/null 2>&1 &'
    execute l:command
  endif
endfunction

function! ConvertProviderToFull(provider_short) abort
    let providers = {
        \ 'aws': 'hashicorp/aws',
        \ 'cloudflare': 'cloudflare/cloudflare',
        \ 'github': 'integrations/github',
    \ }
    return get(providers, a:provider_short, '')
endfunction

function! TerraformDocBrowser()
    let l:line = getline('.')

    let l:block_pattern = '^\s*\(resource\|data\)\s\+"\([^"]\+\)"\s\+"\([^"]\+\)"'
    let l:field_pattern = '^\s*\w\+\s*='
    let l:field_block_pattern = '^\s*\(\w\+\)\s*{'

    if l:line =~ l:block_pattern
        let l:block = matchstr(l:line, '^\s*\(resource\|data\)')
        if l:block == 'resource'
            let l:block_type = 'resources'
        elseif l:block == 'data'
            let l:block_type = 'data-sources'
        endif

        let l:resource_name = substitute(matchstr(l:line, l:block_pattern), '^\s*\(resource\|data\)\s\+"\([^"]\+\)"\s\+"\([^"]\+\)"', '\2', '')
        let l:provider_short = matchstr(l:resource_name, '^[^_]\+')
        let l:provider = ConvertProviderToFull(l:provider_short)
        let l:target = matchstr(l:resource_name, '_\zs.*')
        let l:url = 'https://registry.terraform.io/providers/' . l:provider . '/latest/docs/' . l:block_type . '/' . l:target
        call OpenURL(l:url)
    elseif l:line =~ l:field_pattern || l:line =~ l:field_block_pattern
        if l:line =~ l:field_pattern
            let l:field = matchstr(l:line, '^\s*\zs\w\+\ze\s*=')
        else
            let l:field = matchstr(l:line, '^\s*\zs\w\+\ze\s*{')
        endif

        let l:block_line_num = search(l:block_pattern, 'bnW')
        if l:block_line_num > 0
            let l:block_line = getline(l:block_line_num)
            let l:block = matchstr(l:block_line, '^\s*\(resource\|data\)')
            if l:block == 'resource'
                let l:block_type = 'resources'
            elseif l:block == 'data'
                let l:block_type = 'data-sources'
            endif

            let l:resource_name = substitute(matchstr(l:block_line, l:block_pattern), '^\s*\(resource\|data\)\s\+"\([^"]\+\)"\s\+"\([^"]\+\)"', '\2', '')
            let l:provider_short = matchstr(l:resource_name, '^[^_]\+')
            let l:provider = ConvertProviderToFull(l:provider_short)
            let l:target = matchstr(l:resource_name, '_\zs.*')
            let l:url = 'https://registry.terraform.io/providers/' . l:provider . '/latest/docs/' . l:block_type . '/' . l:target . '\#'. l:field . '-1'
            call OpenURL(l:url)
        endif
    endif
endfunction

augroup terraform_mappings
  autocmd!
  autocmd FileType terraform nnoremap <leader>dc :call TerraformDocBrowser()<CR><CR>
augroup END

P.S.: This script works on macOS, but you should tweak the OpenURL function to make it work on other operating systems