fix(vim.ui)!: change open() to return result|nil, errmsg|nil #28612

reverts e0d92b9cc2 #28502

Problem:
`vim.ui.open()` has a `pcall()` like signature, under the assumption
that this is the Lua idiom for returning result-or-error. However, the
`result|nil, errmsg|nil` pattern:
- has precedent in:
  - `io.open`
  - `vim.uv` (`:help luv-error-handling`)
- has these advantages:
  - Can be used with `assert()`:
    ```
    local result, err = assert(foobar())
    ```
  - Allows LuaLS to infer the type of `result`:
    ```
    local result, err = foobar()
    if err then
      ...
    elseif result then
      ...
    end
    ```

Solution:
- Revert to the `result|nil, errmsg|nil` pattern.
- Document the pattern in our guidelines.
This commit is contained in:
Justin M. Keyes
2024-05-03 03:20:03 -07:00
committed by GitHub
parent d44ed3a885
commit 40ce857797
7 changed files with 28 additions and 24 deletions

View File

@@ -654,15 +654,15 @@ M[ms.window_showDocument] = function(_, result, ctx, _)
if result.external then
-- TODO(lvimuser): ask the user for confirmation
local ok, cmd_or_err = vim.ui.open(uri)
local ret = ok and (cmd_or_err --[[@as vim.SystemObj]]):wait(2000) or nil
local cmd, err = vim.ui.open(uri)
local ret = cmd and cmd:wait(2000) or nil
if ret == nil or ret.code ~= 0 then
return {
success = false,
error = {
code = protocol.ErrorCodes.UnknownErrorCode,
message = ret and ret.stderr or cmd_or_err,
message = ret and ret.stderr or err,
},
}
end