feat: Add gopls.sh

[richardlarocque]

Adds a gopls.sh script that provides a asdf-aware way to start a
gopls LSP server. This script helps my Emacs load and run the right
gopls for any given project.

To my fellow Emacs users, I offer these configs as an example:

(defun find-stencil-root ()
  "Finds the directory that contains stencil.lock"
  ()
  (message "evaluating find-stencil-root")
  (locate-dominating-file "." "stencil.lock"))

(defun stencil-go-setup ()
  "A go-mode hook for Outreach stencil projects"
  ()
  (let
      ((stencil-root (find-stencil-root)))
    (if stencil-root
        (progn
          (setq-local go-command (concat stencil-root ".bootstrap/shell/go.sh"))
          (setq-local gofmt-command (concat stencil-root ".bootstrap/shell/gofmt.sh"))
          (setq-local godoc-command (concat stencil-root ".bootstrap/shell/go.sh doc"))
          (setq-local go-test-command (concat stencil-root ".bootstrap/shell/go.sh test -ldflags '-X github.com/getoutreach/go-outreach/v2/pkg/app.Version=testing -X github.com/getoutreach/gobox/pkg/app.Version=testing' -tags=or_test"))

          (setq-local lsp-go-gopls-server-path (concat stencil-root ".bootstrap/shell/gopls.sh"))
          (setq-local lsp-go-env '((GOFLAGS . "-tags=or_test,or_e2e")))

          (setq-local flycheck-go-test-executable (concat stencil-root ".bootstrap/shell/go.sh") )
          (setq-local flycheck-go-vet-executable (concat stencil-root ".bootstrap/shell/go.sh") )
          (setq-local flycheck-go-gofmt-executable (concat stencil-root ".bootstrap/shell/gofmt.sh") )
          (setq-local flycheck-go-build-executable (concat stencil-root ".bootstrap/shell/go.sh") )
          )
          ()
          )
      )
    )

(add-hook 'go-mode-hook 'stencil-go-setup)

(Note the gopls.sh references in the middle there.)

Folks using a different editor might not benefit from this specific
advice, but I'm hoping the gopls.sh script will be of some use to
them, too.

[malept]

I have a bunch of opinions on this which I will write down in the morning. Marking as "requested changes" so it doesn't accidentally get merged.

[malept]

So I'm generally not inclined to add this for a few reasons:

• At least at Outreach, gopls is installed/updated every time a new Go version is installed, via functionality in asdf.
• We shouldn't put the gopls version in the script itself, if we need to track that, it should go into versions.yaml and the script should use the get_tool_version function (see other scripts for its use).
• Per the script docs, I don't know if we want to add gopls to services' .tool-versions - it would be yet another item for DT to track, particularly when there may be breaking changes, and those changes would only affect a small minority of developers who don't use VSCode (VSCode installs gopls automatically, just for VSCode as I understand it).

[richardlarocque]

gopls is installed/updated every time a new Go version is installed, via functionality in asdf.

For whatever reason, this doesn't seem to be working for me. I always have to install and reshim the first time I encounter a new Go in a .tool-version. I can try to track it down next time that happens.

We shouldn't put the gopls version in the script itself

Yeah, fair point. I personally would be OK with @latest, though I could see issues with that, too.

[malept]

gopls is installed/updated every time a new Go version is installed, via functionality in asdf.

For whatever reason, this doesn't seem to be working for me. I always have to install and reshim the first time I encounter a new Go in a .tool-version. I can try to track it down next time that happens.

FWIW this is what it looks like (details omitted) when I install a previously uninstalled Go version:

❯ asdf install golang 1.23.1
Platform 'linux' supported!
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 70.1M  100 70.1M    0     0  49.4M      0  0:00:01  0:00:01 --:--:-- 49.3M
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    64  100    64    0     0    380      0 --:--:-- --:--:-- --:--:--   383
verifying checksum
~/.asdf/downloads/golang/1.23.1/archive.tar.gz: OK
checksum verified

Installing github.com/go-delve/delve/cmd/dlv@latest go pkg... go: downloading github.com/go-delve/delve v1.23.1
go: downloading [... output truncated ...]
SUCCESS

Installing golang.org/x/tools/gopls@latest go pkg... go: downloading golang.org/x/tools/gopls v0.16.2
go: downloading [... output truncated ...]
SUCCESS