pesde-pkg/pesde
1
1
Fork 0
mirror of https://github.com/pesde-pkg/pesde.git synced 2025-05-04 10:33:47 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: add workspace dependencies to reference

Browse source
This commit is contained in:
LukaDev 2024-11-02 21:15:32 +01:00
parent c7a1b5328c
commit 34929cd386
1 changed files with 44 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
docs/src/content/docs/reference/manifest.mdx
View file

@ -94,12 +94,11 @@ this field and run the correct version of pesde for this project.
A list of globs containing the members of this workspace. A list of globs containing the members of this workspace.
<LinkCard <LinkCard
title="Workspaces" title="Workspaces"
description="Learn more about workspaces in pesde." description="Learn more about workspaces in pesde."
href="/guides/workspaces/" href="/guides/workspaces/"
/> />
## `[target]` ## `[target]`
The `[target]` section contains information about the target platform for the The `[target]` section contains information about the target platform for the
@ -135,9 +134,9 @@ The entry point of the binary exported by the package. This file is what will be
run when the package is executed as a binary. run when the package is executed as a binary.
<LinkCard <LinkCard
title="Using Binary Packages" title="Using Binary Packages"
description="Learn more about using binary packages in pesde." description="Learn more about using binary packages in pesde."
href="/guides/binary-packages/" href="/guides/binary-packages/"
/> />
### `build_files` ### `build_files`
@ -183,15 +182,15 @@ You can find template scripts inside the
for various sync tools. for various sync tools.
<LinkCard <LinkCard
title="Roblox" title="Roblox"
description="Learn more about using pesde in Roblox projects." description="Learn more about using pesde in Roblox projects."
href="/guides/roblox/" href="/guides/roblox/"
/> />
<LinkCard <LinkCard
title="Example script for Rojo" title="Example script for Rojo"
description="An example script for generating configuration for Rojo." description="An example script for generating configuration for Rojo."
href="https://github.com/daimond113/pesde-scripts/blob/master/lune/rojo/roblox_sync_config_generator.luau" href="https://github.com/daimond113/pesde-scripts/blob/master/lune/rojo/roblox_sync_config_generator.luau"
/> />
### `sourcemap_generator` ### `sourcemap_generator`
@ -204,9 +203,9 @@ The script will receive the path to the package directory as the first argument
through `process.args`. through `process.args`.
<LinkCard <LinkCard
title="Example script for Rojo" title="Example script for Rojo"
description="An example script for generating configuration for Rojo." description="An example script for generating configuration for Rojo."
href="https://github.com/daimond113/pesde-scripts/blob/master/lune/rojo/sourcemap_generator.luau" href="https://github.com/daimond113/pesde-scripts/blob/master/lune/rojo/sourcemap_generator.luau"
/> />
## `[indices]` ## `[indices]`
@ -270,9 +269,9 @@ refers to the `baz` dependency of the `bar` package, which is a dependency of
the `foo` package. the `foo` package.
<LinkCard <LinkCard
title="Overrides" title="Overrides"
description="Learn more about overriding and patching packages." description="Learn more about overriding and patching packages."
href="/guides/overrides/" href="/guides/overrides/"
/> />
## `[patches]` ## `[patches]`
@ -295,9 +294,9 @@ patch.
The patches can be generated using the `pesde patch` command. The patches can be generated using the `pesde patch` command.
<LinkCard <LinkCard
title="Overrides" title="Overrides"
description="Learn more about overriding and patching packages." description="Learn more about overriding and patching packages."
href="/guides/overrides/" href="/guides/overrides/"
/> />
## `[place]` ## `[place]`
@ -372,6 +371,25 @@ foo = { repo = "acme/packages", rev = "main", path = "foo" }
- `path`: The path within the repository to install. If not specified, the root - `path`: The path within the repository to install. If not specified, the root
of the repository is used. of the repository is used.
### Workspace
```toml
[dependencies]
foo = { workspace = "acme/foo", version = "^" }
```
**Workspace dependencies** contain the following fields:
- `workspace`: The name of the package in the workspace.
- `version`: The version requirement for the package. This can be `^`, `*`, `=`,
`~`, or a specific version requirement such as `^1.2.3`.
<LinkCard
title="Workspaces"
description="Learn more about workspace dependencies in pesde."
href="/guides/workspaces/#workspace-dependencies"
/>
## `[peer_dependencies]` ## `[peer_dependencies]`
The `[peer_dependencies]` section contains a list of peer dependencies for the The `[peer_dependencies]` section contains a list of peer dependencies for the
@ -396,10 +414,10 @@ package is used by another package.
foo = { name = "acme/foo", version = "1.2.3" } foo = { name = "acme/foo", version = "1.2.3" }
``` ```
<br/> <br />
<LinkCard <LinkCard
title="Specifying Dependencies" title="Specifying Dependencies"
description="Learn more about specifying dependencies in pesde." description="Learn more about specifying dependencies in pesde."
href="/guides/dependencies/" href="/guides/dependencies/"
/> />