fix: make lwc a peerDependency

Author: nolanlawson

README.md

@@ -2,40 +2,34 @@
 
 Run Jest against Lightning web components in a Salesforce DX workspace environment.
 
-## Versions
-
-To test against the latest Salesforce production instances, use the npm tag appropriate for the current release, e.g.:
+## Install
 
+```shell
+# npm
+npm install --save-dev @salesforce-sfdx-lwc-jest lwc
 ```
-yarn add -D @salesforce/sfdx-lwc-jest@winter22
-yarn add -D @salesforce/sfdx-lwc-jest@spring22
-```
-
-The npm `latest` tag corresponds to the latest version of this repo, not necessarily Salesforce production versions.
-
-To see a full list of available versions, and the tag that maps to the corresponding Salesforce release, see [the list of `npm` package versions](https://www.npmjs.com/package/@salesforce/sfdx-lwc-jest?activeTab=versions).
-
-## Invalid sourceApiVersion found in sfdx-project.json
-
-If you see this error while running tests in your Salesforce DX project, it most likely means you are using the incorrect version of this project.
 
-For example, the error message `Invalid sourceApiVersion found in sfdx-project.json. Expected 45.0, found 46.0` means this project is targeted to API version 45.0, which maps to Spring '19, but the Salesforce DX project the tests are run in is using API version 46.0, which maps to Summer '19. The version check is done against the projects `sourceApiVersion` field in the `sfdx-project.json` file at the top level of the project.
+```shell
+# yarn
+npm install --save-dev @salesforce-sfdx-lwc-jest lwc
+```
 
-To fix this issue, make sure the most recent version of this project is being used, or switch to the `prerelease` version, depending on what release your target org is on.
+As of version 6.0.0 of `@salesforce/sfdx-lwc-jest`, you must install `lwc` alongside the package.
 
-## Disabling the sourceApiVersion check
+## Versions
 
-The `sourceApiVersion` field check is not a perfect check. Projects may be targeting orgs that are on the current release, but still have an older `sourceApiVersion` value set in their `sfdx-project.json` file. To disable this check, run tests with the `--skipApiVersionCheck` flag set.
+To test against the latest Salesforce production instances, ensure that your `lwc` dependency corresponds to the Salesforce release you want to test against. For example:
 
-**Note that by doing this, you risk running with an old version of the test runner and your tests may be using an out of date version of the LWC framework. To ensure tests are always run with the proper framework version and configuration, make sure to be on the most recent `latest` or `prerelease` tagged version of this package.**
+```shell
+npm install --save-dev lwc@winter22
+npm install --save-dev lwc@spring22
+```
 
-## Installation
+The npm `latest` tag corresponds to the latest version of the [LWC open-source framework](https://github.com/salesforce/lwc), not necessarily Salesforce production versions.
 
-Add this project as a devDependency:
+To see a full list of available versions, and the tag that maps to the corresponding Salesforce release, see [the list of `npm` package versions](https://www.npmjs.com/package/lwc?activeTab=versions).
 
-```bash
-yarn add -D @salesforce/sfdx-lwc-jest
-```
+## Running tests
 
 Update your project's unit testing script in `package.json` to execute `sfdx-lwc-jest`:
 
@@ -72,13 +66,6 @@ Options:
       --debug                Run tests in debug mode
                              (https://jestjs.io/docs/en/troubleshooting)
                                                       [boolean] [default: false]
-      --skipApiVersionCheck  Disable the "sourceApiVersion" field check before
-                             running tests. **Warning** By disabling this check
-                             you risk running tests against stale versions of
-                             the framework. See details here:
-                             https://github.com/salesforce/sfdx-lwc-jest#disabli
-                             ng-the-sourceApiVersion-check
-                                                      [boolean] [default: false]
       --help                 Show help                                 [boolean]
 
 Examples:

package.json

@@ -33,20 +33,15 @@
         "test": "jest"
     },
     "dependencies": {
-        "@lwc/engine-dom": "6.5.1",
-        "@lwc/engine-server": "6.5.1",
-        "@lwc/jest-preset": "16.0.0",
-        "@lwc/jest-resolver": "16.0.0",
-        "@lwc/jest-serializer": "16.0.0",
-        "@lwc/jest-transformer": "16.0.0",
-        "@lwc/module-resolver": "6.5.1",
-        "@lwc/synthetic-shadow": "6.5.1",
-        "@lwc/wire-service": "6.5.1",
-        "@salesforce/wire-service-jest-util": "4.1.4",
+        "@lwc/jest-preset": "^16.0.0",
+        "@lwc/jest-resolver": "^16.0.0",
+        "@lwc/jest-serializer": "^16.0.0",
+        "@lwc/jest-transformer": "^16.0.0",
+        "@salesforce/wire-service-jest-util": "^4.1.4",
         "fast-glob": "^3.3.2",
-        "jest": "29.7.0",
-        "jest-environment-jsdom": "29.7.0",
-        "yargs": "~17.7.2"
+        "jest": "^29.7.0",
+        "jest-environment-jsdom": "^29.7.0",
+        "yargs": "^17.7.2"
     },
     "devDependencies": {
         "@babel/core": "^7.24.4",
@@ -58,6 +53,9 @@
         "lint-staged": "^15.2.2",
         "prettier": "^3.2.5"
     },
+    "peerDependencies": {
+        "lwc": ">=6"
+    },
     "volta": {
         "node": "20.12.1",
         "yarn": "1.22.22"

scripts/upgrade-lwc.sh

@@ -44,6 +44,4 @@ const jestConfig = {
     snapshotSerializers: [require.resolve('@lwc/jest-serializer')],
 };
 
-const expectedApiVersion = '61.0';
-
-module.exports = { jestConfig, expectedApiVersion };
+module.exports = { jestConfig };

src/config.js

@@ -37,13 +37,6 @@ const testOptions = {
         type: 'boolean',
         default: false,
     },
-
-    skipApiVersionCheck: {
-        description:
-            'Disable the "sourceApiVersion" field check before running tests. **Warning** By disabling this check you risk running tests against stale versions of the framework. See details here: https://github.com/salesforce/sfdx-lwc-jest#disabling-the-sourceApiVersion-check',
-        type: 'boolean',
-        default: false,
-    },
 };
 
 module.exports = testOptions;

src/options/options.js

@@ -6,12 +6,10 @@
  */
 'use strict';
 
-const { expectedApiVersion } = require('../../config');
-
 module.exports = {
     PROJECT_ROOT: 'projectRoot',
     getSfdxProjectJson: () => {
-        return { mock: true, sourceApiVersion: expectedApiVersion };
+        return { mock: true };
     },
     getModulePaths: () => ['force-app/main/unix/lwc', 'force-app\\main\\windows\\lwc'],
 };

src/utils/__mocks__/project.js

@@ -38,6 +38,5 @@ function getModulePaths() {
 
 module.exports = {
     PROJECT_ROOT,
-    getSfdxProjectJson,
     getModulePaths,
 };

src/utils/project.js

@@ -10,24 +10,14 @@ const fs = require('fs');
 const path = require('path');
 const { spawn } = require('child_process');
 
-const { PROJECT_ROOT, getSfdxProjectJson } = require('./project');
+const { PROJECT_ROOT } = require('./project');
 
-const { error, info } = require('../log');
-const { jestConfig, expectedApiVersion } = require('../config');
+const { info } = require('../log');
+const { jestConfig } = require('../config');
 
 // List of CLI options that should be passthrough to jest.
 const JEST_PASSTHROUGH_OPTIONS = new Set(['coverage', 'updateSnapshot', 'verbose', 'watch']);
 
-function validSourceApiVersion() {
-    const sfdxProjectJson = getSfdxProjectJson();
-    const apiVersion = sfdxProjectJson.sourceApiVersion;
-    if (apiVersion !== expectedApiVersion) {
-        error(
-            `Invalid sourceApiVersion found in sfdx-project.json. Expected ${expectedApiVersion}, found ${apiVersion}`,
-        );
-    }
-}
-
 function getJestPath() {
     const packageJsonPath = require.resolve('jest/package.json');
 
@@ -71,10 +61,6 @@ function getJestArgs(argv) {
 }
 
 async function testRunner(argv) {
-    if (!argv.skipApiVersionCheck) {
-        validSourceApiVersion();
-    }
-
     const spawnCommand = 'node';
     const spawnArgs = [getJestPath(), ...getJestArgs(argv)];
 

src/utils/test-runner.js

@@ -4,26 +4,19 @@ exports[`--help attribute shows help 1`] = `
 "\`sfdx-lwc-jest [options]\` runs Jest unit tests in SFDX workspace
 
 Options:
-      --version              Show version number                       [boolean]
-      --coverage             Collect coverage and display in output
+      --version         Show version number                            [boolean]
+      --coverage        Collect coverage and display in output
                                                       [boolean] [default: false]
-  -u, --updateSnapshot       Re-record every snapshot that fails during a test
-                             run                      [boolean] [default: false]
-      --verbose              Display individual test results with the test suite
-                             hierarchy                [boolean] [default: false]
-      --watch                Watch files for changes and rerun tests related to
-                             changed files            [boolean] [default: false]
-      --debug                Run tests in debug mode
-                             (https://jestjs.io/docs/en/troubleshooting)
+  -u, --updateSnapshot  Re-record every snapshot that fails during a test run
                                                       [boolean] [default: false]
-      --skipApiVersionCheck  Disable the "sourceApiVersion" field check before
-                             running tests. **Warning** By disabling this check
-                             you risk running tests against stale versions of
-                             the framework. See details here:
-                             https://github.com/salesforce/sfdx-lwc-jest#disabli
-                             ng-the-sourceApiVersion-check
+      --verbose         Display individual test results with the test suite
+                        hierarchy                     [boolean] [default: false]
+      --watch           Watch files for changes and rerun tests related to
+                        changed files                 [boolean] [default: false]
+      --debug           Run tests in debug mode
+                        (https://jestjs.io/docs/en/troubleshooting)
                                                       [boolean] [default: false]
-      --help                 Show help                                 [boolean]
+      --help            Show help                                      [boolean]
 
 Examples:
   sfdx-lwc-jest --coverage  Collect coverage and display in output