From 6a7662760c515c74f2c37fc825776ead65d307f9 Mon Sep 17 00:00:00 2001 From: William Boman Date: Tue, 7 Nov 2023 00:29:18 +0100 Subject: refactor!: change Package API This changes the following public APIs: **(_breaking_) Events on the `Package` class** The `uninstall:success` event on the `Package` class now receives an `InstallReceipt` as argument, instead of an `InstallHandle`. This receipt is an in-memory representation of what was uninstalled. There's also a new `uninstall:failed` event for situations where uninstallation for some reason fails. Note: this also applies to the registry events (i.e. `package:uninstall:success` and `package:uninstall:failed`). --- **(_breaking_) `Package:uninstall()` is now asynchronous and receives two new arguments, similarly to `Package:install()`** While package uninstallations remain synchronous under the hood, the public API has been changed from synchronous -> asynchronous. Users of this method are recommended to provide a callback in situations where code needs to execute after uninstallation fully completes. --- **(_breaking_) `Package:get_install_path()` has been removed. --- **`Package:install()` now takes an optional callback** This callback allows consumers to be informed whether installation was successful or not without having to go through a different, low-level, API. See below for a comparison between the old and new APIs: ```lua -- before local handle = pkg:install() handle:once("closed", function () -- ... end) -- after pkg:install({}, function (success, result) -- ... end) ``` --- lua/mason-registry/sources/github.lua | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lua/mason-registry/sources/github.lua') diff --git a/lua/mason-registry/sources/github.lua b/lua/mason-registry/sources/github.lua index d0a782fb..b314d690 100644 --- a/lua/mason-registry/sources/github.lua +++ b/lua/mason-registry/sources/github.lua @@ -1,4 +1,4 @@ -local InstallLocation = require "mason-core.installer.location" +local InstallLocation = require "mason-core.installer.InstallLocation" local Optional = require "mason-core.optional" local Result = require "mason-core.result" local _ = require "mason-core.functional" -- cgit v1.2.3-70-g09d2