UNPKG

@aws/pdk

Version:

All documentation is located at: https://aws.github.io/aws-pdk

github.com/aws/aws-pdk

aws/aws-pdk

59 lines (35 loc) • 1.62 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# @pnpm/lockfile-file > Read/write pnpm-lock.yaml files Reads and writes the wanted (`pnpm-lock.yaml`) and current (`node_modules/.pnpm-lock.yaml`) lockfile files of pnpm. Lockfile files are the state files of the `node_modules` installed via pnpm. They are like the `package-lock.json` of npm or the `yarn.lock` of Yarn. ## Install ``` pnpm add @pnpm/lockfile-file ``` ## API ### `readWantedLockfile(pkgPath, opts) => Promise<Lockfile>` Reads the `pnpm-lock.yaml` file from the root of the package. #### Arguments * `pkgPath` - *Path* - the path to the project * `opts.ignoreIncompatible` - *Boolean* - `false` by default. If `true`, throws an error if the lockfile file format is not compatible with the current library. ### `readCurrentLockfile(virtualStoreDir, opts) => Promise<Lockfile>` Reads the lockfile file from `<virtualStoreDir>/lock.yaml`. ### `existsNonEmptyWantedLockfile(pkgPath) => Promise<Boolean>` Returns `true` if a `pnpm-lock.yaml` exists in the root of the package. ### `writeLockfiles(opts) => Promise<void>` Writes the wanted/current lockfile files. When they are empty, removes them. #### Arguments * `opts.wantedLockfile` * `opts.wantedLockfileDir` * `opts.currentLockfile` * `opts.currentLockfileDir` * `[opts.forceSharedFormat]` ### `writeWantedLockfile(pkgPath, wantedLockfile) => Promise<void>` Writes the wanted lockfile file only. Sometimes it is needed just to update the wanted lockfile without touching `node_modules`. ### `writeCurrentLockfile(virtualStoreDir, currentLockfile) => Promise<void>` Writes the current lockfile file only. ## License [MIT](LICENSE)