From 34929cd3868f2f175af64f4b07852315b273940a Mon Sep 17 00:00:00 2001
From: LukaDev <47296785+lukadev-0@users.noreply.github.com>
Date: Sat, 2 Nov 2024 21:15:32 +0100
Subject: [PATCH] docs: add workspace dependencies to reference
---
docs/src/content/docs/reference/manifest.mdx | 70 ++++++++++++--------
1 file changed, 44 insertions(+), 26 deletions(-)
diff --git a/docs/src/content/docs/reference/manifest.mdx b/docs/src/content/docs/reference/manifest.mdx
index c9abb9d..3bc7d89 100644
--- a/docs/src/content/docs/reference/manifest.mdx
+++ b/docs/src/content/docs/reference/manifest.mdx
@@ -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.
-
## `[target]`
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.
### `build_files`
@@ -183,15 +182,15 @@ You can find template scripts inside the
for various sync tools.
### `sourcemap_generator`
@@ -204,9 +203,9 @@ The script will receive the path to the package directory as the first argument
through `process.args`.
## `[indices]`
@@ -270,9 +269,9 @@ refers to the `baz` dependency of the `bar` package, which is a dependency of
the `foo` package.
## `[patches]`
@@ -295,9 +294,9 @@ patch.
The patches can be generated using the `pesde patch` command.
## `[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
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`.
+
+
+
## `[peer_dependencies]`
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" }
```
-
+