lsp: Support goToDefinition from a Go file to a templ file #387

guettli · 2024-01-02T19:41:13Z

If I ctrl-click on page() then ...

then I get to the autogenerated Go code:

It would be great if I could get to the templ-file instead:

The text was updated successfully, but these errors were encountered:

a-h · 2024-01-02T20:36:07Z

Yes, that would be much more useful!

If you're in a *.templ file, then the templ LSP is operating and will carry out a remapping operation from templ position -> go file position -> gopls -> templ position, as per here:

templ/cmd/templ/lspcmd/proxy/server.go

Lines 507 to 512 in c674f64

    
           for i := 0; i < len(result); i++ { 
        
           	if isTemplGoFile, templURI := convertTemplGoToTemplURI(result[i].URI); isTemplGoFile { 
        
           		result[i].URI = templURI 
        
           		result[i].Range = p.convertGoRangeToTemplRange(templURI, result[i].Range) 
        
           	} 
        
           }

But currently, if you start from a *.go file, then gopls is operating and there's no templ code running at all. To rewrite the responses from gopls, templ would have to proxy all Go LSP operations (i.e. for all *.go files) and work out that if a _templ.go file was being referenced, then, it should look up the various source code mapping positions and switch it to *.templ instead. I'm not sure if replacing (as a proxy) gopls for all projects is ideal (higher risk?), but it would work.

It may also possible for the templ LSP to capture *_templ.go file usage too, and be able to ctrl+click on the function name to get to the *.templ file. (Worse UX, but maybe a good first step)

joerdav · 2024-01-03T09:24:10Z

I know you can have multiple LSPs attached to a file, but I wonder what would happen if you had 2 trying to respond to a jump to definition request.

guettli · 2024-01-07T10:35:39Z

I asked the gopls maintainers. Maybe they know a hook which templ could implement: golang/go#65001

joerdav · 2024-01-30T13:57:43Z

We have the following issue to implement the line directive #415, and then I think it's a case of closing this ticket and helping the gopls team implement golang/go#65001

guettli · 2024-01-31T09:57:16Z

@joerdav thank you for your work! This is great!

joerdav · 2024-01-31T10:00:31Z

Thank @af-md !

meistertigran · 2024-02-20T19:51:12Z

Here's a quick and dirty fix for anyone using neovim. It doesn't go directly to the location of the definition in the file, but at least it opens the correct file.

local go_to_definition = function()
    if vim.bo.filetype == "go" then
        vim.lsp.buf.definition({
            on_list = function(options)
                if options == nil or options.items == nil or #options.items == 0 then
                    return
                end

                local targetFile = options.items[1].filename
                local prefix = string.match(targetFile, "(.-)_templ%.go$")

                if prefix then
                    options.items[1].filename = prefix .. ".templ"
                end

                vim.fn.setqflist({}, ' ', options)
                vim.api.nvim_command('cfirst')
            end
        })
    else
        vim.lsp.buf.definition()
    end
end

and then in your key map

vim.keymap.set("n", "gd", go_to_definition)

Note that the check for being in a go buffer will run every time you try to go to definition. You probably would want to add this modification only if you are using templ a lot and should remember to remove it once the actual fix is implemented.

lobsterchan27 · 2024-08-16T03:59:22Z

does anyone have a workaround in vscode? its not a big deal but a little annoying.

Kody-Quintana · 2024-08-24T23:35:26Z

Quick and dirty addition to @meistertigran's quick and dirty fix, this'll attempt to search for the the line in the templ file

local go_to_definition = function()
  if vim.bo.filetype == "go" then

    vim.lsp.buf.definition({
      on_list = function(options)
        if options == nil or options.items == nil or #options.items == 0 then
          return
        end

        local targetFile = options.items[1].filename
        local prefix = string.match(targetFile, "(.-)_templ%.go$")

        if prefix then
          local function_name = vim.fn.expand('<cword>')
          options.items[1].filename = prefix .. ".templ"

          vim.fn.setqflist({}, ' ', options)
          vim.api.nvim_command('cfirst')

          vim.api.nvim_command('silent! /templ ' .. function_name)
        else
          vim.lsp.buf.definition()
        end

      end
    })
  else
    vim.lsp.buf.definition()
  end
end

Smithx10 · 2024-08-28T18:59:23Z

In Neovim I use Telescope. This works decent enough for me... I might change it since I'm annoyed that the telescope window pops up for a few ms.

  vim.keymap.set('n', '<leader>gm', function()
    local ts_utils = require 'nvim-treesitter.ts_utils'
    local node = ts_utils.get_node_at_cursor()
    if node == nil then
      return
    end
    if vim.bo.filetype == "go" then
      if node:parent():type() == "call_expression" then
        local funcName = vim.fn.expand("<cword>")
        require("telescope.builtin").live_grep {
          default_text = 'templ ' .. funcName .. "\\(",
          glob_pattern = '*.templ',
          on_complete = {
            function(picker)
              if picker.manager.linked_states.size == 1 then
                require("telescope.actions").select_default(picker.prompt_bufnr)
              end
            end
          }
        }
      end
    end
  end),

Razvan00Rusu · 2024-08-31T11:48:48Z

Given that the line compiler directive MR has been closed, is there any work being done to address this / new ideas on how this could be tackled properly?

In the meantime for VSCode users, I have quickly created a very small extension (with the help of ChatGPT) to redirect definitions in _templ.go files to .templ in the same directory - which should cover the large majority of cases (mine at least). Sharing it here in case it is useful to others, the repo and VSIX file to install the extension is here

catgoose · 2024-09-07T23:49:37Z

Quick and dirty addition to @meistertigran's quick and dirty fix, this'll attempt to search for the the line in the templ file

local go_to_definition = function()
  if vim.bo.filetype == "go" then

    vim.lsp.buf.definition({
      on_list = function(options)
        if options == nil or options.items == nil or #options.items == 0 then
          return
        end

        local targetFile = options.items[1].filename
        local prefix = string.match(targetFile, "(.-)_templ%.go$")

        if prefix then
          local function_name = vim.fn.expand('<cword>')
          options.items[1].filename = prefix .. ".templ"

          vim.fn.setqflist({}, ' ', options)
          vim.api.nvim_command('cfirst')

          vim.api.nvim_command('silent! /templ ' .. function_name)
        else
          vim.lsp.buf.definition()
        end

      end
    })
  else
    vim.lsp.buf.definition()
  end
end

My approach is to override vim.lsp.buf.definition for go filetype in LspAttach event:

  local function go_goto_def()
    local old = vim.lsp.buf.definition
    local opts = {
      on_list = function(options)
        if options == nil or options.items == nil or #options.items == 0 then
          return
        end
        local targetFile = options.items[1].filename
        local prefix = string.match(targetFile, "(.-)_templ%.go$")
        if prefix then
          local function_name = vim.fn.expand("<cword>")
          options.items[1].filename = prefix .. ".templ"
          vim.fn.setqflist({}, " ", options)
          vim.api.nvim_command("cfirst")
          vim.api.nvim_command("silent! /templ " .. function_name)
        else
          old()
        end
      end,
    }
    vim.lsp.buf.definition = function(o)
      o = o or {}
      o = vim.tbl_extend("keep", o, opts)
      old(o)
    end
  end

  vim.api.nvim_create_autocmd("LspAttach", {
    group = vim.api.nvim_create_augroup("UserLspConfig", {}),
    callback = function(event)
      local bufopts = { noremap = true, silent = true, buffer = event.buf }
      if vim.bo.filetype == "go" then
        go_goto_def()
      end
      vim.keymap.set, ("n", "gd", vim.lsp.buf.definition, bufopts)
    end
  }

catgoose · 2024-09-08T14:08:57Z

https://github.com/catgoose/templ-goto-definition

I made this plugin if it makes it easier for anyone.

AlexanderHott · 2024-09-14T00:35:22Z

I am looking into a different approach. I think it might be easier (and more useful for other tools) to extend your editor to be able to respond to multiple textDocument/definition providers. If a single LSP responds with multiple places (such as typescript showing both the react component and memoed component), it will put them in a list where you can select between them. Here is a very basic lua script for collecting all the responses from definition requests. you can run it with :luafile <file>.lua in neovim (same thing as pressing gd)

local pickers = require("telescope.pickers")
local finders = require("telescope.finders")
local conf = require("telescope.config").values
local actions = require("telescope.actions")
local action_state = require("telescope.actions.state")

local locations = {}

local params = vim.lsp.util.make_position_params()
local results_lsp = {}
local results = {}
local timeout = 1000 -- ms

for _, client in pairs(vim.lsp.get_active_clients()) do
	if client.server_capabilities.definitionProvider then
		local request_result =
			client.request_sync("textDocument/definition", params, timeout, vim.api.nvim_get_current_buf())
		if request_result and request_result.result then
			table.insert(results_lsp, request_result.result)
		end
	end
end

for _, lsp_result in ipairs(results_lsp) do
	if lsp_result then
		vim.list_extend(results, lsp_result)
	end
end

for _, result in ipairs(results) do
	if result.targetUri then
		table.insert(locations, {
			filename = vim.uri_to_fname(result.targetUri),
			lnum = result.targetRange.start.line + 1,
			col = result.targetRange.start.character + 1,
			text = "Definition",
		})
	elseif result.uri then
		table.insert(locations, {
			filename = vim.uri_to_fname(result.uri),
			lnum = result.range.start.line + 1,
			col = result.range.start.character + 1,
			text = "Definition",
		})
	end
end

pickers
	.new({}, {
		prompt_title = "LSP Definitions",
		finder = finders.new_table({
			results = locations,
			entry_maker = function(entry)
				return {
					value = entry,
					display = entry.filename .. ":" .. entry.lnum .. ":" .. entry.col .. " " .. entry.text,
					ordinal = entry.filename .. " " .. entry.lnum .. " " .. entry.col .. " " .. entry.text,
					filename = entry.filename,
					lnum = entry.lnum,
					col = entry.col,
				}
			end,
		}),
		sorter = conf.generic_sorter({}),
		attach_mappings = function(prompt_bufnr, map)
			actions.select_default:replace(function()
				actions.close(prompt_bufnr)
				local selection = action_state.get_selected_entry()
				vim.api.nvim_command("edit " .. selection.filename)
				vim.api.nvim_win_set_cursor(0, { selection.lnum, selection.col - 1 })
			end)
			return true
		end,
	})
	:find()

catgoose · 2024-09-14T00:40:41Z

But when would you ever want the generated go from a templ file? It should just take you to the templ definition and not the go file. I made a plug-in like that for vue: https://github.com/catgoose/vue-goto-definition.nvim And one for templ: https://github.com/catgoose/templ-goto-definition I know a choice is good, but I prefer to just gd and be where I need to go.

…

On Fri, Sep 13, 2024 at 7:35 PM Alex Ott ***@***.***> wrote: I am looking into a different approach. I think it might be easier (and more useful for other tools) to extend your editor to be able to respond to multiple textDocument/definition providers. If a single LSP responds with multiple places (such as typescript showing both the react component and memoed component), it will put them in a list where you can select between them. Here is a very basic lua script for collecting all the responses from definition requests. you can run it with :luafile <file>.lua in neovim (same thing as pressing gd) local pickers = require("telescope.pickers")local finders = require("telescope.finders")local conf = require("telescope.config").valueslocal actions = require("telescope.actions")local action_state = require("telescope.actions.state") local locations = {} local params = vim.lsp.util.make_position_params()local results_lsp = {}local results = {}local timeout = 1000 -- ms for _, client in pairs(vim.lsp.get_active_clients()) do if client.server_capabilities.definitionProvider then local request_result = client.request_sync("textDocument/definition", params, timeout, vim.api.nvim_get_current_buf()) if request_result and request_result.result then table.insert(results_lsp, request_result.result) end endend for _, lsp_result in ipairs(results_lsp) do if lsp_result then vim.list_extend(results, lsp_result) endend for _, result in ipairs(results) do if result.targetUri then table.insert(locations, { filename = vim.uri_to_fname(result.targetUri), lnum = result.targetRange.start.line + 1, col = result.targetRange.start.character + 1, text = "Definition", }) elseif result.uri then table.insert(locations, { filename = vim.uri_to_fname(result.uri), lnum = result.range.start.line + 1, col = result.range.start.character + 1, text = "Definition", }) endend pickers .new({}, { prompt_title = "LSP Definitions", finder = finders.new_table({ results = locations, entry_maker = function(entry) return { value = entry, display = entry.filename .. ":" .. entry.lnum .. ":" .. entry.col .. " " .. entry.text, ordinal = entry.filename .. " " .. entry.lnum .. " " .. entry.col .. " " .. entry.text, filename = entry.filename, lnum = entry.lnum, col = entry.col, } end, }), sorter = conf.generic_sorter({}), attach_mappings = function(prompt_bufnr, map) actions.select_default:replace(function() actions.close(prompt_bufnr) local selection = action_state.get_selected_entry() vim.api.nvim_command("edit " .. selection.filename) vim.api.nvim_win_set_cursor(0, { selection.lnum, selection.col - 1 }) end) return true end, }) :find() — Reply to this email directly, view it on GitHub <#387 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFAJNGFO2BRCXPW5KC37L5LZWOAGDAVCNFSM6AAAAABBKOZJ7CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNJQG42DEMRUGU> . You are receiving this because you commented.Message ID: ***@***.***>

AlexanderHott · 2024-09-14T00:44:05Z

I'm making an LSP that can jump from generated typescript http functions to the respective api route in go (inspired by how in https://trpc.io/ you can see type errors quickly when you make changes) and thought it was a similar use case. I do agree that in this specific case, you probably wouldn't want to jump to the generated code, but it seemed like a similar problem.

lsl · 2024-09-14T17:43:30Z

Another vscode extension, this one nests definition providers and jumps to the templ definition if it finds one.

https://marketplace.visualstudio.com/items?itemName=lsl.vscode-templ-go-to-definition

https://github.com/lsl/vscode-templ-go-to-definition

ext install lsl.vscode-templ-go-to-definition

noor-tg · 2024-09-24T07:53:10Z

I use helix. And it only depends on lsp. So how to implement this line option with templ and go lsp ? @joerdav

joerdav · 2024-09-24T08:46:38Z

I saw your comment in #476

@noor-tg I think the answer will be to run templ lsp on go files. I've been playing around with it to see if that's viable. At the moment the behaviour is odd, a goToDefinition request is handled by both templ lsp and gopls, so you end up with 2 new files open! I imagine there would be similar cases for other LSP actions, but I think this will be the answer.

Does helix support assigning multiple lsps to a file?

noor-tg · 2024-09-24T08:49:38Z

I saw your comment in #476

@noor-tg I think the answer will be to run templ lsp on go files. I've been playing around with it to see if that's viable. At the moment the behaviour is odd, a goToDefinition request is handled by both templ lsp and gopls, so you end up with 2 new files open! I imagine there would be similar cases for other LSP actions, but I think this will be the answer.

Does helix support assigning multiple lsps to a file?

Yes helix support multiple lsp to file type

noor-tg · 2024-09-24T09:02:31Z

But when I add templ lsp last it use golsp and go to generated file. And if I set it first, it shows error def not found

joerdav · 2024-09-24T09:08:58Z

But when I add templ lsp last it use golsp and go to generated file. And if I set it first, it shows error def not found

Yes, currently templ lsp rejects gotodefenition requests from anything but templ files.

templ/cmd/templ/lspcmd/proxy/server.go

Line 619 in 9b77eee

if !ok {

I had to remove this in my local version to get this working, but I think there is more testing to be done to ensure running on go files doesn't have other odd effects.

noor-tg · 2024-09-24T09:24:04Z

But when I add templ lsp last it use golsp and go to generated file. And if I set it first, it shows error def not found

Yes, currently templ lsp rejects gotodefenition requests from anything but templ files.

templ/cmd/templ/lspcmd/proxy/server.go

Line 619 in 9b77eee

if !ok {

I had to remove this in my local version to get this working, but I think there is more testing to be done to ensure running on go files doesn't have other odd effects.

I used the same . and it working correctly. thanks @joerdav

noor-tg · 2024-09-24T09:36:08Z

I'm making an LSP that can jump from generated typescript http functions to the respective api route in go (inspired by how in https://trpc.io/ you can see type errors quickly when you make changes) and thought it was a similar use case. I do agree that in this specific case, you probably wouldn't want to jump to the generated code, but it seemed like a similar problem.

@AlexanderHott any link to the mentioned project ?

AlexanderHott · 2024-09-28T14:18:49Z

I'm making an LSP that can jump from generated typescript http functions to the respective api route in go (inspired by how in https://trpc.io/ you can see type errors quickly when you make changes) and thought it was a similar use case. I do agree that in this specific case, you probably wouldn't want to jump to the generated code, but it seemed like a similar problem.

@AlexanderHott any link to the mentioned project ?

It's on the back burner right now, and not very done. My team paused our migration to a go backend, but when that picks up again, I think I'll start working on it. https://github.com/AlexanderHOtt/longjump

mkote · 2024-11-30T15:15:21Z

Quick and di

For any LazyVim users who could not get catgoose's plugin to work, here's a solution that works for me. Put the following in lua/plugins/lsp.lua:

return {
  "neovim/nvim-lspconfig",
  opts = function(args)
    local go_to_definition = function()
      if vim.bo.filetype == "go" then
        vim.lsp.buf.definition({
          on_list = function(options)
            if options == nil or options.items == nil or #options.items == 0 then
              return
            end

            local targetFile = options.items[1].filename
            local prefix = string.match(targetFile, "(.-)_templ%.go$")

            if prefix then
              local function_name = vim.fn.expand("<cword>")
              options.items[1].filename = prefix .. ".templ"

              vim.fn.setqflist({}, " ", options)
              vim.api.nvim_command("cfirst")

              vim.api.nvim_command("silent! /templ " .. function_name)
            else
              vim.lsp.buf.definition()
            end
          end,
        })
      else
        vim.lsp.buf.definition()
      end
    end
    local function go_goto_def()
      if vim.bo.filetype == "go" then
        return go_to_definition()
      else
        return vim.lsp.buf.definition()
      end
    end
    local keys = require("lazyvim.plugins.lsp.keymaps").get()
    keys[#keys + 1] = { "gd", go_goto_def }
  end,
}

guettli mentioned this issue Jan 7, 2024

x/tools/gopls: ctrl-click should jump to source, not to autogenerated code golang/go#65001

Open

joerdav changed the title ~~Hyperlink from Go code to templ file.~~ lsp: Support goToDefinition from a Go file to a templ file Jan 30, 2024

joerdav added enhancement New feature or request lsp NeedsFix Needs implementing labels Jan 30, 2024

embiem mentioned this issue Aug 16, 2024

feat: Implement the go line compiler directive #476

Closed

joerdav mentioned this issue Aug 28, 2024

GoToDef .Templ templ() instead of .go func () #898

Closed

linear bot added Migrated and removed NeedsFix Needs implementing enhancement New feature or request Migrated lsp labels Sep 4, 2024

tris203 linked a pull request Sep 24, 2024 that will close this issue

feat(lsp): Support gotoDefinition from go->templ #932

Open

noor-tg mentioned this issue Dec 8, 2024

Add Steel as an optional plugin system helix-editor/helix#8675

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lsp: Support goToDefinition from a Go file to a templ file #387

lsp: Support goToDefinition from a Go file to a templ file #387

guettli commented Jan 2, 2024 •

edited

Loading

a-h commented Jan 2, 2024

joerdav commented Jan 3, 2024

guettli commented Jan 7, 2024

joerdav commented Jan 30, 2024

guettli commented Jan 31, 2024

joerdav commented Jan 31, 2024

meistertigran commented Feb 20, 2024

lobsterchan27 commented Aug 16, 2024

Kody-Quintana commented Aug 24, 2024 •

edited

Loading

Smithx10 commented Aug 28, 2024

Razvan00Rusu commented Aug 31, 2024

catgoose commented Sep 7, 2024 •

edited

Loading

catgoose commented Sep 8, 2024

AlexanderHott commented Sep 14, 2024

catgoose commented Sep 14, 2024 via email

AlexanderHott commented Sep 14, 2024

lsl commented Sep 14, 2024

noor-tg commented Sep 24, 2024 •

edited

Loading

joerdav commented Sep 24, 2024

noor-tg commented Sep 24, 2024

noor-tg commented Sep 24, 2024

joerdav commented Sep 24, 2024

noor-tg commented Sep 24, 2024

noor-tg commented Sep 24, 2024

AlexanderHott commented Sep 28, 2024

mkote commented Nov 30, 2024

lsp: Support goToDefinition from a Go file to a templ file #387

lsp: Support goToDefinition from a Go file to a templ file #387

Comments

guettli commented Jan 2, 2024 • edited Loading

a-h commented Jan 2, 2024

joerdav commented Jan 3, 2024

guettli commented Jan 7, 2024

joerdav commented Jan 30, 2024

guettli commented Jan 31, 2024

joerdav commented Jan 31, 2024

meistertigran commented Feb 20, 2024

lobsterchan27 commented Aug 16, 2024

Kody-Quintana commented Aug 24, 2024 • edited Loading

Smithx10 commented Aug 28, 2024

Razvan00Rusu commented Aug 31, 2024

catgoose commented Sep 7, 2024 • edited Loading

catgoose commented Sep 8, 2024

AlexanderHott commented Sep 14, 2024

catgoose commented Sep 14, 2024 via email

AlexanderHott commented Sep 14, 2024

lsl commented Sep 14, 2024

noor-tg commented Sep 24, 2024 • edited Loading

joerdav commented Sep 24, 2024

noor-tg commented Sep 24, 2024

noor-tg commented Sep 24, 2024

joerdav commented Sep 24, 2024

noor-tg commented Sep 24, 2024

noor-tg commented Sep 24, 2024

AlexanderHott commented Sep 28, 2024

mkote commented Nov 30, 2024

guettli commented Jan 2, 2024 •

edited

Loading

Kody-Quintana commented Aug 24, 2024 •

edited

Loading

catgoose commented Sep 7, 2024 •

edited

Loading

noor-tg commented Sep 24, 2024 •

edited

Loading