llscheck fails with lua-language-server version 3.13.6 + the future of this repository

[ColinKennedy]

I tried out the new pretty formatter from neovim/neovim#29073 (comment), lua-language-server version 3.13.6. In short it works but breaks llscheck.

git clone git@github.com:ColinKennedy/nvim-best-practices-plugin-template.git
make llscheck

This works with older lua-language-server versions (e.g. 3.7.4) but in 3.13.6, this error comes up

Command failed: lua-language-server --check . --checklevel Warning --logpath /tmp/lua_GwSJZL --configpath .luarc.json

So with that said I wanted to mention two separate things

1. Will this repository get archived / deprecated?
2. If so, are you open to suggestions for the output of --check_format=pretty?

If the intent is to deprecate it'd be helpful if the two produce similar output. For example

llscheck

VIMRUNTIME="`nvim --clean --headless --cmd 'lua io.write(os.getenv("VIMRUNTIME"))' --cmd 'quit'`" llscheck --configpath $(CONFIGURATION) .

lua/plugin_template/_commands/hello_world/say/runner.lua:104:25-28: param-type-mismatch: Cannot assign `string?` to parameter `string`.
- Optional type cannot match `string`
- Type `nil` cannot match `string`

Total 1: 1 Warnings in 1 files

lua-language-server

VIMRUNTIME="`nvim --clean --headless --cmd 'lua io.write(os.getenv("VIMRUNTIME"))' --cmd 'quit'`" lua-language-server --check_format=pretty --check=.

./lua/plugin_template/_commands/hello_world/say/runner.lua:104:25 [Warning] Cannot assign `string?` to parameter `string`.
- Optional type cannot match `string`
- Type `nil` cannot match `string` (param-type-mismatch)
        word = vim.fn.split(word, " ")[1] -- Make sure it's only one word
                            ^^^^
Diagnosis complete, 1 problems found

The llscheck version includes the error code in the same line as the path:line:column: description line. Which makes it easier to integrate with existing tools (e.g. Vim). It also summarizes the number of files affected and severities. It'd be nice if lua-language-server does that too.

Anyway if the intent is to keep this repository around it'd be great to fix it for later lua-language-server versions

[jeffzi]

Which version of llscheck did you try? Version 0.7.0, which I released yesterday, already fixes the incompatibility with lua-language-server 3.13.6. This version also slightly modifies the output format. I had been working on these changes before lua-language-server introduced the pretty format, so I decided to release them as they were.

Regarding your questions:

1. Will this repository get archived/deprecated?

Not archived, but I am considering whether to deprecate it.

2. If so, are you open to suggestions for the output of --check_format=pretty?

I'm open to suggestions for improving llscheck's output. Ideally, improvements should go directly into lua-language-server, but I have reservations about contributing there. The maintainer tends to accept PRs without code review, testing, or discussion. When the pretty format was being worked on, I proposed improvements here; they were met with a simple 👍, and the PR was quickly merged without further input.

That said, I do think lua-language-server's pretty format has some useful aspects, like displaying the line with the highlighted error, which llscheck currently lacks.

My current plan is to refine a better format within llscheck if others are interested, and if it proves useful, I may submit a PR to lua-language-server later. I'm open to discussions and PRs, but I don’t plan to make further improvements myself in the near future.

[jeffzi]

Something that might be useful for Neovim users—but isn’t currently documented—is that llscheck can be used as a library. While the primary goal was to facilitate testing, it might turn out to be useful in a broader context:

local llscheck = require("llscheck")
local diagnosis = llscheck.check_workspace(".", "Hint")
local report, stats = llscheck.generate_report(diagnosis)

[ColinKennedy]

I was using llscheck 0.5.0. Confirmed that 0.7.0 is working, thank you for clarifying, I should've checked that first. And I agree showing the line with the highlighted error is helpful. Though I think llscheck is better at summarizing overall. For now I think I'll stick with llscheck while lua-language-server gets more updates

[ColinKennedy]

Since all questions are answered let's close this issue!