Neovim central thread

willl · August 3, 2022, 8:29pm

There probably aren't that many people using neovim, but it has great LSP support. And also since all the plugins and configuration are in lua these days, it's been pretty easy to get going with lua for playdate. So I figured to make a central thread here for anyone to talk about using Neovim, vs just one-off threads that the rest of the playdate community probably wouldn't care about.

To start off, I was able to get the sumneko_lua LSP server to pull in the sdk files but only when editing a playdate project directory, otherwise keep with completing all the neovim APIs. I'm still on lsp installer, and not the new maven replacement, but you can probably figure out how to make this work with maven just as easily.

local path = require "plenary.path"
local exists = function(name) return path:new(vim.fn.getcwd() .. "/" .. name):exists() end

lsp_installer.on_server_ready(function(server)
  local setup = true
  local opts = {
    on_attach = require("user.lsp.handlers").on_attach,
    -- You can disable features with this function
    capabilities = require("user.lsp.handlers").capabilities,
  }
  if server.name == "sumneko_lua" then
    if exists "source/main.lua" then -- playdate
      opts = vim.tbl_deep_extend("force", {
        settings = {
          Lua = {
            completion = { callSnippet = "Replace" },
            runtime = { nonstandardSymbol = { "+=", "-=", "*=", "/=" } },
            telemetry = { enable = false },
            diagnostics = { globals = { "playdate" } },
            workspace = {
              library = { os.getenv("HOME") .. "/Developer/PlaydateSDK/CoreLibs/" },
            },
          },
        },
      }, opts)
    else
      local luadev = prequire "lua-dev"
      if luadev then opts = vim.tbl_deep_extend("force", luadev.setup(), opts) end
    end
  end
end

Seems to be working great with just that!

One thing I wish that the __stub.lua file had comments above each function with documentation. Maybe even EmmyLua styled comments with the expected types of all the params. Then it'd show up in the cmp popups. Maybe the panic staff will add that one day?

matt · August 3, 2022, 8:33pm

Add a feature request

willl · August 3, 2022, 9:42pm

Good idea, I opened a dicussion for that. Thanks!

mogita · August 19, 2022, 4:12pm

Hi Will, neovim user here. Thank you so much for sharing your config. However it seems there's a syntax error in the snippet, or somehow I messed up copying/pasting.

On the other hand, according to a topic on nvim-lsp-installer project, on_server_ready() is deprecating.

I tried modifying the code but didn't work out how to make sumneko_lua recognize Playdate SDK using just the on_attach function. Could you share your code if possible?

willl · August 22, 2022, 7:55pm

Hi, this is my current full lsp-installer file if you can get help from that lsp-installer.lua · GitHub

The only strange thing in there is my prequire which is

---@diagnostic disable-next-line: lowercase-global
function prequire(package)
  local status, lib = pcall(require, package)
  if status then
    return lib
  else
    vim.notify("Failed to require '" .. package .. "' from " .. debug.getinfo(2).source)
    return nil
  end
end

mogita · August 23, 2022, 9:06am

Hi Will, thanks a lot for sharing! The Gist looked great!

afk · May 27, 2023, 5:01am

This was really helpful!

Here is my final .luarc.json at the root of the project

{
  "telemetry.enable": false,
  "runtime.version": "Lua 5.4",
  "runtime.special": {
    "import": "require"
  },
  "runtime.nonstandardSymbol": ["+=", "-=", "*=", "/="],
  "diagnostics.globals": [
    "playdate",
    "json"
  ],
  "diagnostics.disable": ["redefined-local"],
  "diagnostics.neededFileStatus": {
    "codestyle-check": "Any"
  },
  "diagnostics.libraryFiles": "Disable",
  "completion.callSnippet": "Replace",
  "workspace.library": ["$PLAYDATE_SDK_PATH/CoreLibs"],
  "workspace.ignoreDir": ["Source/external"]
}

jlipps · September 11, 2023, 4:35pm

Hi all, thanks for this helpful guide! I've got neovim set up for playdate dev now, using coc-lua and the helpful configs posted here. I'm new to playdate, and new to lua, so I'm struggling now to figure out if this issue is one that can be resolved:

I'm guessing this may be because the language server doesn't know about playdate's special object orientation 'library'? Has anyone else run into this issue and got it working? It's not the end of the world, but it does litter my code with these diagnostic errors, and I'm not really clear if the 'objects' returned by the call to .new actually have the correct methods available on them.

afk · September 11, 2023, 9:56pm

Just checked and I have the same issue

afk · September 14, 2023, 5:32pm

I got annoyed by the amount of warning the LSP diagnostics was throwing so I disabled the rule on my localconfig

"diagnostics.disable": ["redefined-local", "undefined-field"],

It seems is a change on the 3.0 version of the LSP server

github.com/LuaLS/lua-language-server

Breaking changes in 3.X

opened 11:22AM - 10 Mar 22 UTC

sumneko

plan

# Introduce I'm working on the 3.X version, the purpose is to add a more comple…te type system, and use this to implement features such as type checking. In previous versions I tried to keep the type system compatible with `EmmyLua`, but I will make some breaking changes after version 3.X, so the type system may not be suitable to continue to be called `EmmyLua` in the future, but I haven't thought about it yet, ~I will call it `LuaDoc` for now~. # Breaking changes ## Always trace local set ```lua local x x = 1 x = true print(x) --> x is `integer|boolean` ``` ```lua ---@type string local x x = 1 x = true print(x) --> x is `string` ``` ```lua local x = 'str' x = 1 x = true print(x) --> x is `string` ``` ## Dose not trace field inject ```lua local x = {} local y = x y.field = 1 print(x.field) --> undefined field `field` ``` use `---@class` instead ```lua ---@class MyClass local x = {} ---@class MyClass local y = x y.field = 1 print(x.field) --> `x.field` is `1` ``` ## Finding definition does not recurse ```lua local t = {} t.x = 1 t.y = t.x print(t.y) --> t.y is `1` ``` Find definition of `t.y` will not find out `t.x` ```lua ---@class C local mt = {} ---@type C local o ``` Find definition of `o` will not find out `mt` ## Type `unknown` ```lua local t = {} print(t.x) --> t.x is `unknown` instead of `any` ``` ## Types can be used in doc-table keys ```lua ---@type { [number]: string } local t print(t[1]) --> t[1] is `string` print(t.x) --> t.x is `unknown` ``` ## boolean type `true` and `false` You can use `---@type { [string]: true }` now. ## `class` and `alias` support generic inheritance ```lua ---@class table<K, V>: { [K]: V } --> this is builtin ---@alias mark<K> { [K]: true } ``` ## ~`table<integer, string>` can not convert to `string[]`~ ## Default value of `unrary` and `binary` ```lua ---@type unknown local x local y = - x --> y is `number` instead of `unknown` ``` ## `unknown` can form union types with other types ```lua function f() if x then return y else return nil end end local n = f() --> n is `unknown|nil` ``` ## Integer type ```lua ---@type 1|2|3|4|5 local v ``` ## `doc-enum` must be a string ```lua ---@param x 'aaa'|'bbb' function f(x) print(x) --> x is `"aaa"` or `"bbb"` end ``` This means you can no longer use `---@param x '1024'|'true'|'function () end'` to represent a specific number, boolean or function. Use `---@param x 1024|true|fun()` instead. For compatibility, I will continue to recognize `'"xxx"'` as the string `xxx` instead of `"xxx"`. ## `integer` is a class in `Lua 5.1` and `Lua 5.2` ```lua ---@type integer local v print(v) --> v is `integer` instead of `number` ``` Although `Lua 5.1` and `Lua 5.2` runtimes do not have integer, many API parameters require a number that can be converted to an integer, so adding integer to the type system can help you handle this part. # Not supported for now ## search metatable in this case ```lua setmetatable(object, { __index = { default = 1 } }) print(object.default) --> undefined field `default` ``` This turns the reference into a definition, and checking the reference in order to search for a definition is too expensive. Please use `---@class` or use this: ```lua object = setmetatable(object, { __index = { default = 1 } }) print(object.default) --> this is OK ``` > Maybe can be resolved by indexing `setmetable`

pacha · September 17, 2023, 12:04pm

Glad to see I'm not the only one struggling with this same issue... developing only with a TUI is possible ? How do you do when testing on the Playdate? The simulator is cool but when we have no GUI..

afk · September 18, 2023, 2:24am

I try to use print statements until I fail, then I launch VSCode only for debugging haha