diff options
| author | William Boman <william@redwill.se> | 2023-03-12 08:21:15 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-12 08:21:15 +0100 |
| commit | a01d02ad7f680aec98a1e2ec35b04cedd307cfa8 (patch) | |
| tree | 1a09e274a1f2a4da85b911abcbb182a211035501 /doc/reference.md | |
| parent | feat(golangci-lint): support linux_arm64 (#1089) (diff) | |
| download | mason-a01d02ad7f680aec98a1e2ec35b04cedd307cfa8.tar mason-a01d02ad7f680aec98a1e2ec35b04cedd307cfa8.tar.gz mason-a01d02ad7f680aec98a1e2ec35b04cedd307cfa8.tar.bz2 mason-a01d02ad7f680aec98a1e2ec35b04cedd307cfa8.tar.lz mason-a01d02ad7f680aec98a1e2ec35b04cedd307cfa8.tar.xz mason-a01d02ad7f680aec98a1e2ec35b04cedd307cfa8.tar.zst mason-a01d02ad7f680aec98a1e2ec35b04cedd307cfa8.zip | |
feat: add github registry source capabilities (#1091)
Diffstat (limited to 'doc/reference.md')
| -rw-r--r-- | doc/reference.md | 27 |
1 files changed, 23 insertions, 4 deletions
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})` |