pesde-pkg/pesde
1
1
Fork 0
mirror of https://github.com/pesde-pkg/pesde.git synced 2024-12-12 11:00:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs(website): document exports field of manifest

Browse source
This commit is contained in:
daimond113 2024-03-31 14:13:38 +02:00
parent 7acbceb093
commit 5a8907c335
No known key found for this signature in database
GPG key ID: 3A8ECE51328B513C
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
website/src/routes/docs/+page.svelte
View file

@ -146,6 +146,10 @@ pesde patch-commit DIRECTORY"
ignored.</Note ignored.</Note
> >
<Codeblock code="pesde publish" /> <Codeblock code="pesde publish" />
<p>
Please look at the <a href="#cheatsheet">manifest format cheat sheet</a> for more information about
the pesde.yaml file before publishing.
</p>
</section> </section>
<section> <section>
@ -158,7 +162,7 @@ pesde patch-commit DIRECTORY"
</section> </section>
<section> <section>
<h2>Manifest format cheat sheet</h2> <h2 id="cheatsheet">Manifest format cheat sheet</h2>
<p> <p>
Here is a cheat sheet for the manifest format. This is the format of the pesde.yaml file. The Here is a cheat sheet for the manifest format. This is the format of the pesde.yaml file. The
`name` and `version` fields are required. All other fields are optional. `name` and `version` fields are required. All other fields are optional.
@ -185,7 +189,7 @@ pesde patch-commit DIRECTORY"
lang="yaml" lang="yaml"
code="name: STANDARD_PACKAGE_NAME code="name: STANDARD_PACKAGE_NAME
version: VERSION_REQ version: VERSION_REQ
# OPTIONAL (name in the `indices` field) # OPTIONAL (name in the `indices` field) - defaults to `default`
index: STRING" index: STRING"
/> />
</li> </li>
@ -234,6 +238,14 @@ overrides:
dependencies: DEPENDENCY_SPECIFIER[] dependencies: DEPENDENCY_SPECIFIER[]
peer_dependencies: DEPENDENCY_SPECIFIER[]" peer_dependencies: DEPENDENCY_SPECIFIER[]"
/> />
<p>The exports field is used to specify the paths of the package's exports:</p>
<ul>
<li>
The `lib` field is a path to the file which will become the ModuleScript of the package.
This is only used for reading the types of the package.
</li>
<li>The `bin` field is a path to the file which will be ran with the `run` command.</li>
</ul>
<p> <p>
If the realm field is not specified, it will default to `shared`. If it is another value, and If the realm field is not specified, it will default to `shared`. If it is another value, and
the package is to be installed in a different realm, pesde will error. the package is to be installed in a different realm, pesde will error.