Skip to content

Commit 57b3711

Browse files
committed
Document pnpm options, behavior
1 parent 00c17a9 commit 57b3711

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,11 @@ module.exports = async function() {
120120
dependencies will be restored to their prior state.
121121
*/
122122
useYarn: true,
123+
/*
124+
If set to true, all npm scenarios will use `pnpm` for install with the `--frozen-lockfile=false` option. At cleanup, your
125+
dependencies will be restored to their prior state.
126+
*/
127+
usePnpm: true,
123128

124129
/*
125130
buildManagerOptions allows you to opt-out of the default options such as `--ignore-engines --no-lockfile`.
@@ -144,7 +149,7 @@ module.exports = async function() {
144149
'ember-source': '2.11.0'
145150
},
146151
/*
147-
You can optionally define npm overrides to enforce a specific dependency version
152+
You can optionally define npm or pnpm overrides to enforce a specific dependency version
148153
to be installed. This is useful if other libraries you depend on include different
149154
versions of a package. This does nothing if `useYarn` is true;
150155
*/
@@ -206,9 +211,14 @@ The `name` can be used to try just one scenario using the `ember try:one` comman
206211

207212
If you include `useYarn: true` in your `ember-try` config, all npm scenarios will use `yarn` for install with the `--no-lockfile` option. At cleanup, your dependencies will be restored to their prior state.
208213

214+
##### Pnpm
215+
216+
If you include `usePnpm: true` in your `ember-try` config, all npm scenarios will use `pnpm` for install with the `--frozen-lockfile=false` option. At cleanup, your dependencies will be restored to their prior state.
217+
218+
209219
##### A note on npm scenarios with lockfiles
210220

211-
Lockfiles are ignored by `ember-try`. (`yarn` will run with `--no-lockfile` and `npm` will be run with `--no-shrinkwrap`).
221+
Lockfiles are ignored by `ember-try`. (`yarn` will run with `--no-lockfile` and `npm` will be run with `--no-shrinkwrap` and `pnpm` will be run with `--frozen-lockfile=false`).
212222
When testing various scenarios, it's important to "float" dependencies so that the scenarios are run with the latest satisfying versions of dependencies a user of the project would get.
213223

214224
##### Workspaces

0 commit comments

Comments
 (0)