add primitive document symbol support

[jackielii]

try to fix #347

Currently it deals with Go symbols + parser.HTMLTemplate

TODOs:

1. deal with documentSymbol as well
2. add other symbols (css, script)?
3. add correct containerName?

[jackielii]

OK, I admit there is a big problem with my approach: I didn't convert the templ URI to the Go URI, yet somehow it worked.

It seems gopls is good at parsing partial results and skip over invalid block, therefore all the non templ elements are all returned. I then parsed and added the templ elements, namely parser.HTMLTemplate, making the result correct....

[joerdav]

Is this ready to be reviewed @jackielii ?

[joerdav]

I tested this on https://github.com/joerdav/shopping-list/blob/main/app/listsweb/list.templ

And I got the following symbols:

app/listsweb/list.templ|58 col 7| [Function] ListItems(list List, availableItems []Item)
app/listsweb/list.templ|96 col 7| [Function] ListPage(urlpath string, list List, availableRecipes []Recipe, availableItems []Item)
app/listsweb/list.templ|134 col 7| [Function] ListsPage(path string, lists []ListSummary)
app/listsweb/list.templ|18 col 7| [Function] ListRecipes( list List, availableRecipes []Recipe, )

I expected to also see the go functions there recipeInList and itemInList

[joerdav]

I spotted the TODO, oops! Thanks for the PR by the way, it's looking to be almost there!

[jackielii]

I've been using it, works most of the time. But because it uses gopls to parse the templ files directly. It has quite a few broken cases. I'll redo it using the proper way by converting to go files and find mapping symbols.

[a-h]

Legend. 😀

[jackielii]

@a-h @joerdav I have implemented the said approach: use go source to find the symbols and map them back to templ source ranges.

There are two issues I couldn't figure out:

1. The test I added only returns "SymbolInformation" whereas the actual lsp returns "DocumentSymbols", and also looking at the range for "Page" symbol the range is incorrect. i.e.

						Range: protocol.Range{
							Start: protocol.Position{
								Line:      11,
								Character: 0,
							},
							End: protocol.Position{
								Line:      50,
								Character: 1,
							},
						},

doesn't map to the actual templ source. However, in the actual run, it returns the "DocumentSymbol" and range is correct.

2. When I used it with nvim-lspconfig, there is always a "A" character inserted when I pull up document symbols. This could be my nvim-lspconfig, but I couldn't figure out why. This is because I have both HTML and templ lsp, disabling html fixes the problem

This is my relevant nvim config just in case it's useful to others:

  {
    "neovim/nvim-lspconfig",
    init = function()
      vim.filetype.add({ extension = { templ = "templ" } })
      vim.api.nvim_create_autocmd("FileType", {
        pattern = "templ",
        callback = function()
          vim.b.autoformat = true
          -- vim.o.commentstring = "// %s"
        end,
      })
    end,
    opts = {
      servers = {
        htmx = {
          filetypes = { "html", "templ" },
        },
        html = {
          filetypes = { "html", "htm", "templ" },
          -- filetypes = { "html", "htm" },
        },
        templ = {
          cmd = { "/Users/jackieli/go/bin/templ", "lsp", "-log", "/tmp/templ.log" },
          -- cmd = { "templ", "lsp" },
        },
        -- emmet_ls = {
        --   filetypes = { "html", "htm", "htmx", "templ" },
        -- },
      },
      setup = {
        html = function(_, opts)
          -- remove html documentSymbol and just use templ's document symbol
          LazyVim.lsp.on_attach(function(client, buffer)
            local ft = vim.api.nvim_get_option_value("filetype", { buf = buffer })
            if ft == "templ" then
              client.server_capabilities.documentSymbolProvider = false
            end
          end, "html")
        end,
      },
    },
  },

[jackielii]

@joerdav @a-h the PR is ready as is. Please feel free to review and comment.

[joerdav]

Thanks for the contribution!! I've tested this out and it works exactly as I would expect it.

[a-h]

Thanks a lot for seeing this through to completion. Much appreciated.