salesforce / sfdx-lwc-jest

Run Jest against LWC components in SFDX workspace environment
MIT License
162 stars 81 forks source link

Peer dependencies issue when installing sfdx-lwc-jest v3.0.0 #336

Closed ogardnercertinia closed 11 months ago

ogardnercertinia commented 12 months ago

Description

We install sfdx-lwc-jest using pnpm with the strict-peer-dependencies option set to true. When installing version 3.0.0 of sfdx-lwc-jest, we are greeted with the following error:

  └─┬ @salesforce/sfdx-lwc-jest 3.0.0
    ├─┬ @lwc/jest-preset 13.0.0
    │ ├── ✕ unmet peer @lwc/compiler@^2.48.0: found 3.1.3 in @salesforce/sfdx-lwc-jest
    │ ├── ✕ unmet peer @lwc/engine-dom@^2.48.0: found 3.1.3 in @salesforce/sfdx-lwc-jest
    │ ├── ✕ unmet peer @lwc/engine-server@^2.48.0: found 3.1.3 in @salesforce/sfdx-lwc-jest
    │ ├── ✕ unmet peer @lwc/synthetic-shadow@^2.48.0: found 3.1.3 in @salesforce/sfdx-lwc-jest
    │ └─┬ @lwc/jest-transformer 13.0.0
    │   └── ✕ unmet peer @lwc/compiler@^2.48.0: found 3.1.3 in @salesforce/sfdx-lwc-jest
    └─┬ @salesforce/wire-service-jest-util 4.0.1
      └── ✕ unmet peer @lwc/engine-dom@^2.0.0: found 3.1.3 in @salesforce/sfdx-lwc-jest

Steps to Reproduce

Install sfdx-lwc-jest version 3.0.0 via pnpm with the strict-peer-dependencies option set to true.

Expected Results

sfdx-lwc-jest dependency is installed correctly.

Actual Results

Error is thrown. See above.

Version

Possible Solution

It seems that the peer dependency issue was fixed in version 14 of @lwc/jest-preset / @lwc/jest-transformer, and version 4.0.2 of @salesforce/wire-service-jest-util. We should upgrade sfdx-lwc-jest's dependencies to match.

Additional context/Screenshots

N/A

ogardnercertinia commented 12 months ago

I just cloned this repo and ran yarn install and there are warnings in my terminal:

[1/4] 🔍  Resolving packages...
[2/4] 🚚  Fetching packages...
[3/4] 🔗  Linking dependencies...
warning " > @lwc/jest-preset@13.0.0" has incorrect peer dependency "@lwc/compiler@^2.48.0".
warning " > @lwc/jest-preset@13.0.0" has incorrect peer dependency "@lwc/engine-dom@^2.48.0".
warning " > @lwc/jest-preset@13.0.0" has incorrect peer dependency "@lwc/engine-server@^2.48.0".
warning " > @lwc/jest-preset@13.0.0" has incorrect peer dependency "@lwc/synthetic-shadow@^2.48.0".
warning " > @lwc/jest-transformer@13.0.0" has incorrect peer dependency "@lwc/compiler@^2.48.0".
warning " > @salesforce/wire-service-jest-util@4.0.1" has incorrect peer dependency "@lwc/engine-dom@^2.0.0".
[4/4] 🔨  Building fresh packages...
nolanlawson commented 11 months ago

Updating deps fixes it ^

ogardnercertinia commented 11 months ago

Hey @nolanlawson, thanks for merging a fix for this! Do you know when we can expect a patch of sfdx-lwc-jest to be released? This issue is currently blocking us from adopting version 3. Thanks!

jmsjtu commented 11 months ago

@ogardnercertinia I'll do a release today.

jmsjtu commented 11 months ago

@ogardnercertinia release is out now.