@vltpkg/graph 0.0.0-3 → 0.0.0-4
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 -12
- package/package.json +16 -16
package/README.md
CHANGED
|
@@ -2,24 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
# @vltpkg/graph
|
|
4
4
|
|
|
5
|
-
This is the graph library responsible for representing the packages
|
|
5
|
+
This is the graph library responsible for representing the packages
|
|
6
|
+
that are involved in a given install.
|
|
6
7
|
|
|
7
|
-
**[API](#api)**
|
|
8
|
-
·
|
|
9
|
-
**[Usage](#usage)**
|
|
8
|
+
**[API](#api)** · **[Usage](#usage)**
|
|
10
9
|
|
|
11
10
|
## API
|
|
12
11
|
|
|
13
12
|
### `actual.load({ projectRoot: string }): Graph`
|
|
14
13
|
|
|
15
|
-
Recursively loads the `node_modules` folder found at `projectRoot` in
|
|
16
|
-
create a graph representation of the current installed
|
|
14
|
+
Recursively loads the `node_modules` folder found at `projectRoot` in
|
|
15
|
+
order to create a graph representation of the current installed
|
|
16
|
+
packages.
|
|
17
17
|
|
|
18
18
|
### `async ideal.build({ projectRoot: string }): Promise<Graph>`
|
|
19
19
|
|
|
20
|
-
This method returns a new `Graph` object, reading from the
|
|
21
|
-
file located at `projectRoot` dir and building up the
|
|
22
|
-
of nodes and edges from the files read from the
|
|
20
|
+
This method returns a new `Graph` object, reading from the
|
|
21
|
+
`package.json` file located at `projectRoot` dir and building up the
|
|
22
|
+
graph representation of nodes and edges from the files read from the
|
|
23
|
+
local file system.
|
|
23
24
|
|
|
24
25
|
### `lockfile.load({ mainManifest: Manifest, projectRoot: string }): Graph`
|
|
25
26
|
|
|
@@ -27,9 +28,9 @@ Loads the lockfile file found at `projectRoot` and returns the graph.
|
|
|
27
28
|
|
|
28
29
|
## Usage
|
|
29
30
|
|
|
30
|
-
Here's a quick example of how to use the `@vltpkg/graph.ideal.build`
|
|
31
|
-
build a graph representation of the install defined at the
|
|
32
|
-
directory.
|
|
31
|
+
Here's a quick example of how to use the `@vltpkg/graph.ideal.build`
|
|
32
|
+
method to build a graph representation of the install defined at the
|
|
33
|
+
`projectRoot` directory.
|
|
33
34
|
|
|
34
35
|
```
|
|
35
36
|
import { ideal } from '@vltpkg/graph'
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vltpkg/graph",
|
|
3
3
|
"description": "A library that helps understanding & expressing what happens on an install",
|
|
4
|
-
"version": "0.0.0-
|
|
4
|
+
"version": "0.0.0-4",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
7
|
"url": "git+https://github.com/vltpkg/vltpkg.git",
|
|
@@ -23,21 +23,21 @@
|
|
|
23
23
|
"graph-run": "^1.0.4",
|
|
24
24
|
"path-scurry": "^2.0.0",
|
|
25
25
|
"promise-call-limit": "^3.0.2",
|
|
26
|
-
"@vltpkg/
|
|
27
|
-
"@vltpkg/
|
|
28
|
-
"@vltpkg/
|
|
29
|
-
"@vltpkg/
|
|
30
|
-
"@vltpkg/
|
|
31
|
-
"@vltpkg/pick-manifest": "0.0.0-
|
|
32
|
-
"@vltpkg/
|
|
33
|
-
"@vltpkg/registry-client": "0.0.0-
|
|
34
|
-
"@vltpkg/rollback-remove": "0.0.0-
|
|
35
|
-
"@vltpkg/run": "0.0.0-
|
|
36
|
-
"@vltpkg/
|
|
37
|
-
"@vltpkg/
|
|
38
|
-
"@vltpkg/
|
|
39
|
-
"@vltpkg/workspaces": "0.0.0-
|
|
40
|
-
"@vltpkg/
|
|
26
|
+
"@vltpkg/error-cause": "0.0.0-4",
|
|
27
|
+
"@vltpkg/dep-id": "0.0.0-4",
|
|
28
|
+
"@vltpkg/fast-split": "0.0.0-4",
|
|
29
|
+
"@vltpkg/package-info": "0.0.0-4",
|
|
30
|
+
"@vltpkg/package-json": "0.0.0-4",
|
|
31
|
+
"@vltpkg/pick-manifest": "0.0.0-4",
|
|
32
|
+
"@vltpkg/output": "0.0.0-4",
|
|
33
|
+
"@vltpkg/registry-client": "0.0.0-4",
|
|
34
|
+
"@vltpkg/rollback-remove": "0.0.0-4",
|
|
35
|
+
"@vltpkg/run": "0.0.0-4",
|
|
36
|
+
"@vltpkg/semver": "0.0.0-4",
|
|
37
|
+
"@vltpkg/satisfies": "0.0.0-4",
|
|
38
|
+
"@vltpkg/spec": "0.0.0-4",
|
|
39
|
+
"@vltpkg/workspaces": "0.0.0-4",
|
|
40
|
+
"@vltpkg/types": "0.0.0-4"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@eslint/js": "^9.20.0",
|