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) ``` --- tests/mason-core/result_spec.lua | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'tests/mason-core/result_spec.lua') diff --git a/tests/mason-core/result_spec.lua b/tests/mason-core/result_spec.lua index 227e53ae..017f8297 100644 --- a/tests/mason-core/result_spec.lua +++ b/tests/mason-core/result_spec.lua @@ -4,7 +4,7 @@ local a = require "mason-core.async" local match = require "luassert.match" local spy = require "luassert.spy" -describe("result", function() +describe("Result ::", function() it("should create success", function() local result = Result.success "Hello!" assert.is_true(result:is_success()) -- cgit v1.2.3-70-g09d2