1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
local registry = require "mason-registry"
local a = require "mason-core.async"
local _ = require "mason-core.functional"
local installer = require "mason-core.installer"
local InstallationHandle = require "mason-core.installer.handle"
local Optional = require "mason-core.optional"
local log = require "mason-core.log"
local EventEmitter = require "mason-core.EventEmitter"
local receipt = require "mason-core.receipt"
local fs = require "mason-core.fs"
local path = require "mason-core.path"
local linker = require "mason-core.installer.linker"
local version_checks = require "mason-core.package.version-check"
---@class Package : EventEmitter
---@field name string
---@field spec PackageSpec
---@field private handle InstallHandle The currently associated handle.
local Package = setmetatable({}, { __index = EventEmitter })
---@param package_identifier string
---@return string, string?
Package.Parse = function(package_identifier)
local name, version = unpack(vim.split(package_identifier, "@"))
return name, version
end
---@alias PackageLanguage string
---@type table<PackageLanguage, PackageLanguage>
Package.Lang = setmetatable({}, {
__index = function(s, lang)
s[lang] = lang
return s[lang]
end,
})
---@enum PackageCategory
Package.Cat = {
Compiler = "Compiler",
Runtime = "Runtime",
DAP = "DAP",
LSP = "LSP",
Linter = "Linter",
Formatter = "Formatter",
}
local PackageMt = { __index = Package }
---@class PackageSpec
---@field name string
---@field desc string
---@field homepage string
---@field categories PackageCategory[]
---@field languages PackageLanguage[]
---@field install async fun(ctx: InstallContext)
---@param spec PackageSpec
function Package.new(spec)
vim.validate {
name = { spec.name, "s" },
desc = { spec.desc, "s" },
homepage = { spec.homepage, "s" },
categories = { spec.categories, "t" },
languages = { spec.languages, "t" },
install = { spec.install, "f" },
}
return EventEmitter.init(setmetatable({
name = spec.name, -- for convenient access
spec = spec,
}, PackageMt))
end
function Package:new_handle()
self:get_handle():if_present(function(handle)
assert(handle:is_closed(), "Cannot create new handle because existing handle is not closed.")
end)
log.fmt_trace("Creating new handle for %s", self)
local handle = InstallationHandle.new(self)
self.handle = handle
-- Ideally we'd decouple this and leverage Mason's event system, but to allow loading as little as possible during
-- setup (i.e. not load modules related to Mason's event system) of the mason.nvim plugin we explicitly call into
-- terminator here.
require("mason-core.terminator").register(handle)
self:emit("handle", handle)
registry:emit("package:handle", self, handle)
return handle
end
---@alias PackageInstallOpts { version?: string, debug?: boolean, target?: string, force?: boolean }
---@param opts? PackageInstallOpts
---@return InstallHandle
function Package:install(opts)
opts = opts or {}
return self:get_handle()
:map(function(handle)
if not handle:is_closed() then
log.fmt_debug("Handle %s already exist for package %s", handle, self)
return handle
end
end)
:or_else_get(function()
local handle = self:new_handle()
-- This function is not expected to be run in async scope, so we create
-- a new scope here and handle the result callback-style.
a.run(
function(...)
-- we wrap installer.execute for testing purposes (to allow spy objects)
return installer.execute(...)
end,
---@param success boolean
---@param result Result
function(success, result)
if not success then
log.error("Unexpected error", result)
self:emit("install:failed", handle)
return
end
result
:on_success(function()
self:emit("install:success", handle)
registry:emit("package:install:success", self, handle)
end)
:on_failure(function()
self:emit("install:failed", handle)
registry:emit("package:install:failed", self, handle)
end)
end,
handle,
opts
)
return handle
end)
end
function Package:uninstall()
local was_unlinked = self:unlink()
if was_unlinked then
self:emit "uninstall:success"
registry:emit("package:uninstall:success", self)
end
return was_unlinked
end
function Package:unlink()
log.fmt_trace("Unlinking %s", self)
local install_path = self:get_install_path()
-- 1. Unlink
self:get_receipt():if_present(function(receipt)
linker.unlink(self, receipt):get_or_throw()
end)
-- 2. Remove installation artifacts
if fs.sync.dir_exists(install_path) then
fs.sync.rmrf(install_path)
return true
end
return false
end
function Package:is_installed()
return registry.is_installed(self.name)
end
function Package:get_handle()
return Optional.of_nilable(self.handle)
end
function Package:get_install_path()
return path.package_prefix(self.name)
end
---@return Optional # Optional<InstallReceipt>
function Package:get_receipt()
local receipt_path = path.concat { self:get_install_path(), "mason-receipt.json" }
if fs.sync.file_exists(receipt_path) then
return Optional.of(receipt.InstallReceipt.from_json(vim.json.decode(fs.sync.read_file(receipt_path))))
end
return Optional.empty()
end
---@param callback fun(success: boolean, version_or_err: string)
function Package:get_installed_version(callback)
a.run(function()
local receipt = self:get_receipt():or_else_throw "Unable to get receipt."
return version_checks.get_installed_version(receipt, self:get_install_path()):get_or_throw()
end, callback)
end
---@param callback fun(success: boolean, result_or_err: NewPackageVersion)
function Package:check_new_version(callback)
a.run(function()
local receipt = self:get_receipt():or_else_throw "Unable to get receipt."
return version_checks.get_new_version(receipt, self:get_install_path()):get_or_throw()
end, callback)
end
function Package:get_lsp_settings_schema()
local ok, schema = pcall(require, ("mason-schemas.lsp.%s"):format(self.name))
if not ok then
return Optional.empty()
end
return Optional.of(schema)
end
function PackageMt.__tostring(self)
return ("Package(name=%s)"):format(self.name)
end
return Package
|
