@vltpkg/workspaces 0.0.0-3 → 0.0.0-5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -18
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -4,9 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Utilities for working with vlt workspaces.
|
|
6
6
|
|
|
7
|
-
**[Usage](#usage)**
|
|
8
|
-
·
|
|
9
|
-
**[Run Order](#run-order)**
|
|
7
|
+
**[Usage](#usage)** · **[Run Order](#run-order)**
|
|
10
8
|
|
|
11
9
|
## Usage
|
|
12
10
|
|
|
@@ -71,9 +69,8 @@ for (const path of m.paths()) {
|
|
|
71
69
|
}
|
|
72
70
|
```
|
|
73
71
|
|
|
74
|
-
Configuration is stored in the project root at
|
|
75
|
-
|
|
76
|
-
be:
|
|
72
|
+
Configuration is stored in the project root at `vlt-workspaces.json`.
|
|
73
|
+
The type of the object in the file must be:
|
|
77
74
|
|
|
78
75
|
```ts
|
|
79
76
|
type WorkspaceConfiguration =
|
|
@@ -82,17 +79,16 @@ type WorkspaceConfiguration =
|
|
|
82
79
|
| { [group: string]: string | string[] }
|
|
83
80
|
```
|
|
84
81
|
|
|
85
|
-
If it's an object, each key is a group name, and each value is a
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
file.
|
|
82
|
+
If it's an object, each key is a group name, and each value is a path,
|
|
83
|
+
glob, or array of paths and globs, which specify the location of the
|
|
84
|
+
workspace projects. Glob matches are only considered if they are a
|
|
85
|
+
directory containing a `package.json` file.
|
|
90
86
|
|
|
91
87
|
A `string` or `string[]` in the file is interpreted as
|
|
92
88
|
`{"packages": <value>}`. Ie, the default group is `packages`.
|
|
93
89
|
|
|
94
|
-
Workspaces are allowed to be in multiple groups, so something
|
|
95
|
-
|
|
90
|
+
Workspaces are allowed to be in multiple groups, so something like
|
|
91
|
+
this is fine:
|
|
96
92
|
|
|
97
93
|
```json
|
|
98
94
|
{
|
|
@@ -102,14 +98,13 @@ like this is fine:
|
|
|
102
98
|
}
|
|
103
99
|
```
|
|
104
100
|
|
|
105
|
-
If the glob patterns result in a situation where one workspace
|
|
106
|
-
|
|
107
|
-
will be raised.
|
|
101
|
+
If the glob patterns result in a situation where one workspace folder
|
|
102
|
+
is contained within another workspace folder, an error will be raised.
|
|
108
103
|
|
|
109
104
|
## Run Order
|
|
110
105
|
|
|
111
|
-
The `monorepo.run` method can run an async function for each
|
|
112
|
-
|
|
106
|
+
The `monorepo.run` method can run an async function for each workspace
|
|
107
|
+
in the project, visiting each exactly once.
|
|
113
108
|
|
|
114
109
|
When workspaces depend on one another, it will walk dependencies
|
|
115
110
|
before dependents, _unless_ there is a cycle, as that would be
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vltpkg/workspaces",
|
|
3
3
|
"description": "Utility for working with vlt workspaces",
|
|
4
|
-
"version": "0.0.0-
|
|
4
|
+
"version": "0.0.0-5",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
7
|
"url": "git+https://github.com/vltpkg/vltpkg.git",
|
|
@@ -25,10 +25,10 @@
|
|
|
25
25
|
"path-scurry": "^2.0.0",
|
|
26
26
|
"polite-json": "^5.0.0",
|
|
27
27
|
"walk-up-path": "^4.0.0",
|
|
28
|
-
"@vltpkg/dep-id": "0.0.0-
|
|
29
|
-
"@vltpkg/
|
|
30
|
-
"@vltpkg/
|
|
31
|
-
"@vltpkg/
|
|
28
|
+
"@vltpkg/dep-id": "0.0.0-5",
|
|
29
|
+
"@vltpkg/error-cause": "0.0.0-5",
|
|
30
|
+
"@vltpkg/package-json": "0.0.0-5",
|
|
31
|
+
"@vltpkg/types": "0.0.0-5"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
34
|
"@eslint/js": "^9.20.0",
|