refactor: introduce selene, harden type defs, and use proper EmmyLua syntax (#296)

15 files changed, 36 insertions, 38 deletions

diff --git a/tests/helpers/lua/luassertx.lua b/tests/helpers/lua/luassertx.lua
index 55ea0d72..3eba3fa4 100644
--- a/tests/helpers/lua/luassertx.lua
+++ b/tests/helpers/lua/luassertx.lua
@@ -3,9 +3,9 @@ local match = require "luassert.match"
 local a = require "mason-core.async"
 
 local function wait_for(_, arguments)
-    ---@type (fun()): Function to execute until it does not error.
+    ---@type (fun()) Function to execute until it does not error.
     local assertions_fn = arguments[1]
-    ---@type number: Timeout in milliseconds. Defaults to 5000.
+    ---@type number Timeout in milliseconds. Defaults to 5000.
     local timeout = arguments[2]
     timeout = timeout or 15000
 
diff --git a/tests/helpers/lua/test_helpers.lua b/tests/helpers/lua/test_helpers.lua
index 57c0b4fe..fcb6a608 100644
--- a/tests/helpers/lua/test_helpers.lua
+++ b/tests/helpers/lua/test_helpers.lua
@@ -7,6 +7,7 @@ local InstallHandle = require "mason-core.installer.handle"
 local InstallContext = require "mason-core.installer.context"
 local registry = require "mason-registry"
 
+-- selene: allow(unused_variable)
 function async_test(suspend_fn)
     return function()
         local ok, err = pcall(a.run_blocking, suspend_fn)
@@ -16,6 +17,7 @@ function async_test(suspend_fn)
     end
 end
 
+-- selene: allow(unscoped_variables, incorrect_standard_library_use)
 mockx = {
     just_runs = function() end,
     returns = function(val)
@@ -30,13 +32,15 @@ mockx = {
     end,
 }
 
+-- selene: allow(unused_variable)
 ---@param package_name string
 function InstallHandleGenerator(package_name)
     return InstallHandle.new(registry.get_package(package_name))
 end
 
+-- selene: allow(unused_variable)
 ---@param handle InstallHandle
----@param opts InstallContextOpts | nil
+---@param opts InstallContextOpts?
 function InstallContextGenerator(handle, opts)
     local context = InstallContext.new(handle, opts or {})
     context.spawn = setmetatable({}, {
diff --git a/tests/mason-core/fs_spec.lua b/tests/mason-core/fs_spec.lua
index c3d5fea7..38f97eeb 100644
--- a/tests/mason-core/fs_spec.lua
+++ b/tests/mason-core/fs_spec.lua
@@ -11,11 +11,11 @@ describe("fs", function()
     it(
         "refuses to rmrf paths outside of boundary",
         async_test(function()
-            local e = assert.has.errors(function()
+            local e = assert.has_error(function()
                 fs.async.rmrf "/thisisa/path"
             end)
 
-            assert.equal(
+            assert.equals(
                 [[Refusing to rmrf "/thisisa/path" which is outside of the allowed boundary "/foo". Please report this error at https://github.com/williamboman/mason.nvim/issues/new]],
                 e
             )
diff --git a/tests/mason-core/functional/function_spec.lua b/tests/mason-core/functional/function_spec.lua
index 8c4b41ef..4da41d40 100644
--- a/tests/mason-core/functional/function_spec.lua
+++ b/tests/mason-core/functional/function_spec.lua
@@ -28,7 +28,7 @@ describe("functional: function", function()
     end)
 
     it("coalesces first non-nil value", function()
-        assert.equal("Hello World!", _.coalesce(nil, nil, "Hello World!", ""))
+        assert.equals("Hello World!", _.coalesce(nil, nil, "Hello World!", ""))
     end)
 
     it("should compose functions", function()
@@ -54,7 +54,7 @@ describe("functional: function", function()
     end)
 
     it("should not allow composing no functions", function()
-        local e = assert.error(function()
+        local e = assert.has_error(function()
             _.compose()
         end)
         assert.equals("compose requires at least one function", e)
@@ -79,9 +79,9 @@ describe("functional: function", function()
             return s
         end)
         local memoized_fn = _.memoize(expensive_function)
-        assert.equal("key", memoized_fn "key")
-        assert.equal("key", memoized_fn "key")
-        assert.equal("new_key", memoized_fn "new_key")
+        assert.equals("key", memoized_fn "key")
+        assert.equals("key", memoized_fn "key")
+        assert.equals("new_key", memoized_fn "new_key")
         assert.spy(expensive_function).was_called(2)
     end)
 
@@ -92,9 +92,9 @@ describe("functional: function", function()
         local memoized_fn = _.memoize(expensive_function, function(arg1, arg2)
             return arg1 .. arg2
         end)
-        assert.equal("key1key2", memoized_fn("key1", "key2"))
-        assert.equal("key1key2", memoized_fn("key1", "key2"))
-        assert.equal("key1key3", memoized_fn("key1", "key3"))
+        assert.equals("key1key2", memoized_fn("key1", "key2"))
+        assert.equals("key1key2", memoized_fn("key1", "key2"))
+        assert.equals("key1key3", memoized_fn("key1", "key3"))
         assert.spy(expensive_function).was_called(2)
     end)
 
@@ -120,7 +120,7 @@ describe("functional: function", function()
         end)
         local a, b = lazy_fn()
         assert.is_nil(a)
-        assert.equal(2, b)
+        assert.equals(2, b)
     end)
 
     it("should provide identity value", function()
diff --git a/tests/mason-core/functional/list_spec.lua b/tests/mason-core/functional/list_spec.lua
index ce0c285f..029396e3 100644
--- a/tests/mason-core/functional/list_spec.lua
+++ b/tests/mason-core/functional/list_spec.lua
@@ -11,7 +11,7 @@ describe("functional: list", function()
         local list = { "BLUE", { nested = "TABLE" }, "RED" }
         local list_copy = _.list_copy(list)
         assert.same({ "BLUE", { nested = "TABLE" }, "RED" }, list_copy)
-        assert.is_not.is_true(list == list_copy)
+        assert.is_false(list == list_copy)
         assert.is_true(list[2] == list_copy[2])
     end)
 
@@ -65,7 +65,7 @@ describe("functional: list", function()
             return item == "Waldo"
         end)
 
-        assert.equal(
+        assert.equals(
             "Waldo",
             _.find_first(predicate, {
                 "Where",
diff --git a/tests/mason-core/installer/handle_spec.lua b/tests/mason-core/installer/handle_spec.lua
index 02fcc358..b1c75763 100644
--- a/tests/mason-core/installer/handle_spec.lua
+++ b/tests/mason-core/installer/handle_spec.lua
@@ -1,4 +1,3 @@
-local a = require "mason-core.async"
 local mock = require "luassert.mock"
 local stub = require "luassert.stub"
 local spy = require "luassert.spy"
diff --git a/tests/mason-core/managers/cargo_spec.lua b/tests/mason-core/managers/cargo_spec.lua
index a938452b..31a54ae7 100644
--- a/tests/mason-core/managers/cargo_spec.lua
+++ b/tests/mason-core/managers/cargo_spec.lua
@@ -1,7 +1,6 @@
 local spy = require "luassert.spy"
 local match = require "luassert.match"
 local mock = require "luassert.mock"
-local Optional = require "mason-core.optional"
 local installer = require "mason-core.installer"
 local cargo = require "mason-core.managers.cargo"
 local Result = require "mason-core.result"
diff --git a/tests/mason-core/managers/composer_spec.lua b/tests/mason-core/managers/composer_spec.lua
index eccaf1c5..d4d07934 100644
--- a/tests/mason-core/managers/composer_spec.lua
+++ b/tests/mason-core/managers/composer_spec.lua
@@ -1,7 +1,6 @@
 local spy = require "luassert.spy"
 local mock = require "luassert.mock"
 local installer = require "mason-core.installer"
-local Optional = require "mason-core.optional"
 local composer = require "mason-core.managers.composer"
 local Result = require "mason-core.result"
 local spawn = require "mason-core.spawn"
diff --git a/tests/mason-core/managers/gem_spec.lua b/tests/mason-core/managers/gem_spec.lua
index 82ad35e5..4cc7705b 100644
--- a/tests/mason-core/managers/gem_spec.lua
+++ b/tests/mason-core/managers/gem_spec.lua
@@ -2,7 +2,6 @@ local spy = require "luassert.spy"
 local match = require "luassert.match"
 local mock = require "luassert.mock"
 local installer = require "mason-core.installer"
-local Optional = require "mason-core.optional"
 local gem = require "mason-core.managers.gem"
 local Result = require "mason-core.result"
 local spawn = require "mason-core.spawn"
diff --git a/tests/mason-core/managers/git_spec.lua b/tests/mason-core/managers/git_spec.lua
index b7da068e..bf3bee30 100644
--- a/tests/mason-core/managers/git_spec.lua
+++ b/tests/mason-core/managers/git_spec.lua
@@ -5,7 +5,6 @@ local Result = require "mason-core.result"
 local installer = require "mason-core.installer"
 
 local git = require "mason-core.managers.git"
-local Optional = require "mason-core.optional"
 
 describe("git manager", function()
     it(
@@ -13,7 +12,7 @@ describe("git manager", function()
         async_test(function()
             local handle = InstallHandleGenerator "dummy"
             local ctx = InstallContextGenerator(handle)
-            local err = assert.has_errors(function()
+            local err = assert.has_error(function()
                 installer.run_installer(ctx, function()
                     git.clone {}
                 end)
diff --git a/tests/mason-core/managers/opam_spec.lua b/tests/mason-core/managers/opam_spec.lua
index 143e4dac..d82eabc1 100644
--- a/tests/mason-core/managers/opam_spec.lua
+++ b/tests/mason-core/managers/opam_spec.lua
@@ -1,6 +1,4 @@
 local match = require "luassert.match"
-local mock = require "luassert.mock"
-local Optional = require "mason-core.optional"
 local installer = require "mason-core.installer"
 local opam = require "mason-core.managers.opam"
 
diff --git a/tests/mason-core/managers/pip3_spec.lua b/tests/mason-core/managers/pip3_spec.lua
index 60bb373a..0d78d708 100644
--- a/tests/mason-core/managers/pip3_spec.lua
+++ b/tests/mason-core/managers/pip3_spec.lua
@@ -3,7 +3,6 @@ local spy = require "luassert.spy"
 local path = require "mason-core.path"
 
 local pip3 = require "mason-core.managers.pip3"
-local Optional = require "mason-core.optional"
 local installer = require "mason-core.installer"
 local Result = require "mason-core.result"
 local settings = require "mason.settings"
@@ -12,9 +11,9 @@ local spawn = require "mason-core.spawn"
 describe("pip3 manager", function()
     it("normalizes pip3 packages", function()
         local normalize = pip3.normalize_package
-        assert.equal("python-lsp-server", normalize "python-lsp-server[all]")
-        assert.equal("python-lsp-server", normalize "python-lsp-server[]")
-        assert.equal("python-lsp-server", normalize "python-lsp-server[[]]")
+        assert.equals("python-lsp-server", normalize "python-lsp-server[all]")
+        assert.equals("python-lsp-server", normalize "python-lsp-server[]")
+        assert.equals("python-lsp-server", normalize "python-lsp-server[[]]")
     end)
 
     it(
diff --git a/tests/mason-core/package/package_spec.lua b/tests/mason-core/package/package_spec.lua
index 113d8d1b..875ce3c6 100644
--- a/tests/mason-core/package/package_spec.lua
+++ b/tests/mason-core/package/package_spec.lua
@@ -36,42 +36,42 @@ describe("package", function()
         end
         assert.equals(
             "name: expected string, got number",
-            assert.error(function()
+            assert.has_error(function()
                 Pkg.new(spec { name = 23 })
             end)
         )
 
         assert.equals(
             "desc: expected string, got number",
-            assert.error(function()
+            assert.has_error(function()
                 Pkg.new(spec { desc = 23 })
             end)
         )
 
         assert.equals(
             "homepage: expected string, got number",
-            assert.error(function()
+            assert.has_error(function()
                 Pkg.new(spec { homepage = 23 })
             end)
         )
 
         assert.equals(
             "categories: expected table, got number",
-            assert.error(function()
+            assert.has_error(function()
                 Pkg.new(spec { categories = 23 })
             end)
         )
 
         assert.equals(
             "languages: expected table, got number",
-            assert.error(function()
+            assert.has_error(function()
                 Pkg.new(spec { languages = 23 })
             end)
         )
 
         assert.equals(
             "install: expected function, got number",
-            assert.error(function()
+            assert.has_error(function()
                 Pkg.new(spec { install = 23 })
             end)
         )
@@ -96,7 +96,7 @@ describe("package", function()
         }
         local handle_handler = spy.new()
         dummy:once("handle", handle_handler)
-        local err = assert.error(function()
+        local err = assert.has_error(function()
             dummy:new_handle()
         end)
         assert.equals("Cannot create new handle because existing handle is not closed.", err)
diff --git a/tests/mason-core/path_spec.lua b/tests/mason-core/path_spec.lua
index 7c7d417f..3d0c2e25 100644
--- a/tests/mason-core/path_spec.lua
+++ b/tests/mason-core/path_spec.lua
@@ -2,15 +2,17 @@ local path = require "mason-core.path"
 
 describe("path", function()
     it("concatenates paths", function()
-        assert.equal("foo/bar/baz/~", path.concat { "foo", "bar", "baz", "~" })
+        assert.equals("foo/bar/baz/~", path.concat { "foo", "bar", "baz", "~" })
     end)
 
     it("concatenates paths on Windows", function()
         local old_os = jit.os
+        -- selene: allow(incorrect_standard_library_use)
         jit.os = "windows"
         package.loaded["mason-core.path"] = nil
         local path = require "mason-core.path"
-        assert.equal([[foo\bar\baz\~]], path.concat { "foo", "bar", "baz", "~" })
+        assert.equals([[foo\bar\baz\~]], path.concat { "foo", "bar", "baz", "~" })
+        -- selene: allow(incorrect_standard_library_use)
         jit.os = old_os
     end)
 
diff --git a/tests/mason-core/process_spec.lua b/tests/mason-core/process_spec.lua
index f3c00385..4a438731 100644
--- a/tests/mason-core/process_spec.lua
+++ b/tests/mason-core/process_spec.lua
@@ -21,7 +21,7 @@ describe("process.spawn", function()
             assert.wait_for(function()
                 assert.spy(callback).was_called(1)
                 assert.spy(callback).was_called_with(true, 0, match.is_number())
-                assert.equal(table.concat(stdio.buffers.stdout, ""), "HELLO=world\nMY_ENV=var\n")
+                assert.equals(table.concat(stdio.buffers.stdout, ""), "HELLO=world\nMY_ENV=var\n")
             end)
         end)
     )