build: replace luacheck with selene, add nix devshell and pre-commit (#20)

* build: replace luacheck with selene

Problem: luacheck is unmaintained (last release 2018) and required
suppressing four warning classes to avoid false positives. It also
lacks first-class vim/neovim awareness.

Solution: switch to selene with std='vim' for vim-aware linting.
Replace the luacheck CI job with selene, update the Makefile lint
target, and delete .luacheckrc.

* build: add nix devshell and pre-commit hooks

Problem: oil.nvim had no reproducible dev environment. The .envrc
set up a Python venv for the now-removed docgen pipeline, and there
were no pre-commit hooks for local formatting checks.

Solution: add flake.nix with stylua, selene, and prettier in the
devshell. Replace the stale Python .envrc with 'use flake'. Add
.pre-commit-config.yaml with stylua and prettier hooks matching
other plugins in the repo collection.

* fix: format with stylua

* build(selene): configure lints and add inline suppressions

Problem: selene fails on 5 errors and 3 warnings from upstream code
patterns that are intentional (mixed tables in config API, unused
callback parameters, identical if branches for readability).

Solution: globally allow mixed_table and unused_variable (high volume,
inherent to the codebase design). Add inline selene:allow directives
for the 8 remaining issues: if_same_then_else (4), mismatched_arg_count
(1), empty_if (2), global_usage (1). Remove .envrc from tracking.

* build: switch typecheck action to mrcjkb/lua-typecheck-action

Problem: oil.nvim used stevearc/nvim-typecheck-action, which required
cloning the action repo locally for the Makefile lint target. All
other plugins in the collection use mrcjkb/lua-typecheck-action.

Solution: swap to mrcjkb/lua-typecheck-action@v0 for consistency.
Remove the nvim-typecheck-action git clone from the Makefile and
.gitignore. Drop LuaLS from the local lint target since it requires
a full language server install — CI handles it.
This commit is contained in:
Barrett Ruth 2026-02-21 23:52:27 -05:00 committed by GitHub
parent df53b172a9
commit 86f553cd0a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
72 changed files with 2762 additions and 2649 deletions

View file

@ -1,16 +1,16 @@
local fs = require("oil.fs")
local test_util = require("tests.test_util")
local fs = require('oil.fs')
local test_util = require('tests.test_util')
local await = test_util.await
---@param path string
---@param cb fun(err: nil|string)
local function touch(path, cb)
vim.loop.fs_open(path, "w", 420, function(err, fd) -- 0644
vim.loop.fs_open(path, 'w', 420, function(err, fd) -- 0644
if err then
cb(err)
else
local shortpath = path:gsub("^[^" .. fs.sep .. "]*" .. fs.sep, "")
local shortpath = path:gsub('^[^' .. fs.sep .. ']*' .. fs.sep, '')
vim.loop.fs_write(fd, shortpath, nil, function(err2)
if err2 then
cb(err2)
@ -31,7 +31,7 @@ end
local TmpDir = {}
TmpDir.new = function()
local path = await(vim.loop.fs_mkdtemp, 2, "oil_test_XXXXXXXXX")
local path = await(vim.loop.fs_mkdtemp, 2, 'oil_test_XXXXXXXXX')
a.util.scheduler()
return setmetatable({ path = path }, {
__index = TmpDir,
@ -58,7 +58,7 @@ end
---@param filepath string
---@return string?
local read_file = function(filepath)
local fd = vim.loop.fs_open(filepath, "r", 420)
local fd = vim.loop.fs_open(filepath, 'r', 420)
if not fd then
return nil
end
@ -79,7 +79,7 @@ local function walk(dir)
type = type,
root = dir,
})
if type == "directory" then
if type == 'directory' then
vim.list_extend(ret, walk(fs.join(dir, name)))
end
end
@ -90,10 +90,10 @@ end
local assert_fs = function(root, paths)
local unlisted_dirs = {}
for k in pairs(paths) do
local pieces = vim.split(k, "/")
local partial_path = ""
local pieces = vim.split(k, '/')
local partial_path = ''
for i, piece in ipairs(pieces) do
partial_path = partial_path .. piece .. "/"
partial_path = partial_path .. piece .. '/'
if i ~= #pieces then
unlisted_dirs[partial_path] = true
end
@ -107,13 +107,13 @@ local assert_fs = function(root, paths)
for _, entry in ipairs(entries) do
local fullpath = fs.join(entry.root, entry.name)
local shortpath = fullpath:sub(root:len() + 2)
if entry.type == "directory" then
shortpath = shortpath .. "/"
if entry.type == 'directory' then
shortpath = shortpath .. '/'
end
local expected_content = paths[shortpath]
paths[shortpath] = nil
assert.truthy(expected_content, string.format("Unexpected entry '%s'", shortpath))
if entry.type == "file" then
if entry.type == 'file' then
local data = read_file(fullpath)
assert.equals(
expected_content,
@ -133,7 +133,7 @@ local assert_fs = function(root, paths)
k,
string.format(
"Expected %s '%s', but it was not found",
v == true and "directory" or "file",
v == true and 'directory' or 'file',
k
)
)
@ -161,7 +161,7 @@ function TmpDir:assert_not_exists(path)
end
function TmpDir:dispose()
await(fs.recursive_delete, 3, "directory", self.path)
await(fs.recursive_delete, 3, 'directory', self.path)
a.util.scheduler()
end