diff options
| author | William Boman <william@redwill.se> | 2023-11-07 00:29:18 +0100 |
|---|---|---|
| committer | William Boman <william@redwill.se> | 2025-02-19 12:15:48 +0100 |
| commit | 6a7662760c515c74f2c37fc825776ead65d307f9 (patch) | |
| tree | 0f4496d0678c7029b10236cbf48cc0f5ff63c1dc /tests/fixtures | |
| parent | fix(pypi): remove -U flag and fix log message (diff) | |
| download | mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.gz mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.bz2 mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.lz mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.xz mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.zst mason-6a7662760c515c74f2c37fc825776ead65d307f9.zip | |
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)
```
Diffstat (limited to 'tests/fixtures')
| -rw-r--r-- | tests/fixtures/receipts/1.2.json | 19 | ||||
| -rw-r--r-- | tests/fixtures/receipts/2.0.json | 30 |
2 files changed, 30 insertions, 19 deletions
diff --git a/tests/fixtures/receipts/1.2.json b/tests/fixtures/receipts/1.2.json deleted file mode 100644 index 75a14f09..00000000 --- a/tests/fixtures/receipts/1.2.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "name": "angular-language-server", - "links": { - "bin": { - "ngserver": "node_modules/.bin/ngserver" - }, - "opt": {}, - "share": {} - }, - "metrics": { - "completion_time": 1694752770559, - "start_time": 1694752764840 - }, - "schema_version": "1.2", - "source": { - "type": "registry+v1", - "id": "pkg:npm/%40angular/language-server@16.1.8" - } -} diff --git a/tests/fixtures/receipts/2.0.json b/tests/fixtures/receipts/2.0.json new file mode 100644 index 00000000..b0c9e2f1 --- /dev/null +++ b/tests/fixtures/receipts/2.0.json @@ -0,0 +1,30 @@ +{ + "links": { + "bin": { + "ngserver": "node_modules/.bin/ngserver" + }, + "share": {}, + "opt": {} + }, + "name": "angular-language-server", + "schema_version": "2.0", + "metrics": { + "start_time": 1739692587948, + "completion_time": 1739692591360 + }, + "source": { + "id": "pkg:npm/%40angular/language-server@19.1.0", + "raw": { + "id": "pkg:npm/%40angular/language-server@19.1.0", + "extra_packages": [ + "typescript@5.4.5" + ] + }, + "type": "registry+v1" + }, + "install_options": { + "debug": false, + "strict": false, + "force": false + } +} |
