diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mason.txt | 13 | ||||
| -rw-r--r-- | doc/reference.md | 27 |
2 files changed, 30 insertions, 10 deletions
diff --git a/doc/mason.txt b/doc/mason.txt index 8bb8b762..1c2ba506 100644 --- a/doc/mason.txt +++ b/doc/mason.txt @@ -239,12 +239,6 @@ Example: ---@type '"prepend"' | '"append"' | '"skip"' PATH = "prepend", - -- The registries to source packages from. Accepts multiple entries. Should a package with the same name exist in - -- multiple registries, the registry listed first will be used. - registries = { - "lua:mason-registry.index", - }, - -- Controls to which degree logs are written to the log file. It's useful to set this to vim.log.levels.DEBUG when -- debugging issues with package installations. log_level = vim.log.levels.INFO, @@ -253,6 +247,13 @@ Example: -- packages that are requested to be installed will be put in a queue. max_concurrent_installers = 4, + -- [Advanced setting] + -- The registries to source packages from. Accepts multiple entries. Should a package with the same name exist in + -- multiple registries, the registry listed first will be used. + registries = { + "lua:mason-registry.index", + }, + -- The provider implementations to use for resolving supplementary package metadata (e.g., all available versions). -- Accepts multiple entries, where later entries will be used as fallback should prior providers fail. -- Builtin providers are: diff --git a/doc/reference.md b/doc/reference.md index e51ba57e..ba121423 100644 --- a/doc/reference.md +++ b/doc/reference.md @@ -26,6 +26,7 @@ RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as de - [Architecture diagram](#architecture-diagram) - [Registry events](#registry-events) - [`PackageSpec`](#packagespec) +- [`RegistryPackageSpec`](#registrypackagespec) - [`Package`](#package) - [`Package.Parse({package_identifier})`](#packageparsepackage_identifier) - [`Package.Lang`](#packagelang) @@ -65,7 +66,9 @@ RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as de ## Architecture diagram - +<!-- https://excalidraw.com/#json=vbTmp7nM8H5odJDiaw7Ue,TghucvHHAw8bl7sgX1VuvA --> + + ## Registry events @@ -107,10 +110,26 @@ registry:on( | name | `string` | | desc | `string` | | homepage | `string` | -| categories | [`PackageCategory[]`](#package-cat) | -| languages | [`PackageLanguage[]`](#package-lang) | +| categories | [`PackageCategory[]`](#packagecat) | +| languages | [`PackageLanguage[]`](#packagelang) | | install | `async fun(ctx: InstallContext)` | +## `RegistryPackageSpec` + +| Key | Value | +| ----------- | ------------------------------------ | +| schema | `"registry+v1"` | +| name | `string` | +| description | `string` | +| homepage | `string` | +| licenses | `string` | +| categories | [`PackageCategory[]`](#packagecat) | +| languages | [`PackageLanguage[]`](#packagelang) | +| source | `table` | +| bin | `table<string, string>?` | +| share | `table<string, string>?` | +| opt | `table<string, string>?` | + ## `Package` Module: [`"mason-core.package"`](../lua/mason-core/package/init.lua) @@ -175,7 +194,7 @@ All the available categories a package can be tagged with. ### `Package.spec` -**Type**: [`PackageSpec`](#packagespec) +**Type**: [`PackageSpec`](#packagespec) or [`RegistryPackageSpec`](#registrypackagespec) ### `Package:install({opts})` |