Merge pull request #64 from saucelabs/devx-2573-peer

feat: Set legacy-peer-deps npm config

Author: mhan83

src/types.ts

@@ -21,6 +21,7 @@ export type NpmConfig = {
   strictSSL?: boolean | string | null;
   packageLock?: boolean | string | null;
   packages?: { [key: string]: string | number };
+  legacyPeerDeps?: boolean | string | null;
 }
 
 export interface PathContainer {
@@ -38,4 +39,4 @@ export interface SuitesContainer {
 export interface NodeContext {
   nodePath: string;
   npmPath: string;
-}
+}

src/utils.ts

@@ -113,7 +113,9 @@ export function getNpmConfig (runnerConfig: NpmConfigContainer) {
     registry: runnerConfig.npm.registry || getDefaultRegistry(),
     'strict-ssl': runnerConfig.npm.strictSSL !== false,
     // Setting to false to avoid dealing with the generated file.
-    'package-lock': runnerConfig.npm.packageLock === true
+    'package-lock': runnerConfig.npm.packageLock === true,
+    'legacy-peer-deps': (runnerConfig.npm.legacyPeerDeps !== 'false' &&
+      runnerConfig.npm.legacyPeerDeps !== false),
   };
 
   // As npm config accepts only key-value pairs, we do the translation

tests/unit/src/__snapshots__/utils.spec.ts.snap

@@ -27,6 +27,7 @@ Array [
     "audit": false,
     "fund": false,
     "json": false,
+    "legacy-peer-deps": true,
     "noproxy": "registry.npmjs.org",
     "package-lock": false,
     "registry": "test.strictSSL.false",
@@ -47,6 +48,7 @@ Array [
     "audit": false,
     "fund": false,
     "json": false,
+    "legacy-peer-deps": true,
     "noproxy": "registry.npmjs.org",
     "package-lock": false,
     "registry": "test.strictSSL.true",
@@ -99,6 +101,7 @@ Array [
     "audit": false,
     "fund": false,
     "json": false,
+    "legacy-peer-deps": true,
     "noproxy": "registry.npmjs.org",
     "package-lock": false,
     "registry": "https://registry.npmjs.org",
@@ -119,6 +122,7 @@ Array [
     "audit": false,
     "fund": false,
     "json": false,
+    "legacy-peer-deps": true,
     "noproxy": "registry.npmjs.org",
     "package-lock": false,
     "registry": "npmland.io",
@@ -161,6 +165,7 @@ Array [
     "audit": false,
     "fund": false,
     "json": false,
+    "legacy-peer-deps": true,
     "noproxy": "registry.npmjs.org",
     "package-lock": false,
     "registry": "https://registry.npmjs.org",
@@ -181,6 +186,7 @@ Array [
     "audit": false,
     "fund": false,
     "json": false,
+    "legacy-peer-deps": true,
     "noproxy": "registry.npmjs.org",
     "package-lock": false,
     "registry": "https://registry.npmjs.org",
@@ -201,6 +207,7 @@ Array [
     "audit": false,
     "fund": false,
     "json": false,
+    "legacy-peer-deps": true,
     "noproxy": "registry.npmjs.org",
     "package-lock": false,
     "registry": "registryland.io",

tests/unit/src/utils.spec.ts

@@ -110,6 +110,26 @@ describe('utils', function () {
 
       expect(npmConfig).toHaveProperty('registry', 'http://my-private-registry.com');
     });
+
+    describe.each([
+      { value: undefined, expected: true },
+      { value: null, expected: true },
+      { value: '', expected: true },
+      { value: 'true', expected: true },
+      { value: true, expected: true },
+      { value: 'false', expected: false },
+      { value: false, expected: false },
+    ])('legacy-peer-deps', function ({ value, expected }) {
+      test(`set to ${expected} when given ${value}`, function () {
+        const config = getNpmConfig({
+          npm: {
+            legacyPeerDeps: value,
+          },
+        });
+
+        expect(config['legacy-peer-deps']).toBe(expected);
+      });
+    });
   });
 
   describe('.prepareNpmEnv', function () {