Fix missing peerDependency on react-dom (#5002)

wojtekmaj · snowystinger · web-flow · commit 7fe63ab6c943 · 2023-09-01T15:25:42.000-05:00
* Fix missing peerDependency on react-dom Fixes #4934 * add a package lint for peer deps --------- Co-authored-by: Robert Snow <rsnow@adobe.com>
diff --git a/packages/@react-aria/autocomplete/package.json b/packages/@react-aria/autocomplete/package.json
@@ -42,7 +42,8 @@
     "@swc/helpers": "^0.5.0"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
   },
   "publishConfig": {
     "access": "public"
diff --git a/packages/@react-aria/dialog/package.json b/packages/@react-aria/dialog/package.json
@@ -22,7 +22,8 @@
     "url": "https://github.com/adobe/react-spectrum"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
   },
   "dependencies": {
     "@react-aria/focus": "^3.14.0",
diff --git a/packages/@react-aria/gridlist/package.json b/packages/@react-aria/gridlist/package.json
@@ -34,7 +34,8 @@
     "@swc/helpers": "^0.5.0"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
   },
   "publishConfig": {
     "access": "public"
diff --git a/packages/@react-aria/tag/package.json b/packages/@react-aria/tag/package.json
@@ -34,7 +34,8 @@
     "@swc/helpers": "^0.5.0"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
   },
   "publishConfig": {
     "access": "public"
diff --git a/packages/@react-spectrum/autocomplete/package.json b/packages/@react-spectrum/autocomplete/package.json
@@ -68,6 +68,7 @@
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
     "@react-spectrum/provider": "^3.0.0"
   },
   "publishConfig": {
diff --git a/packages/@react-spectrum/card/package.json b/packages/@react-spectrum/card/package.json
@@ -62,6 +62,7 @@
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
     "@react-spectrum/provider": "^3.0.0"
   },
   "publishConfig": {
diff --git a/packages/@react-spectrum/contextualhelp/package.json b/packages/@react-spectrum/contextualhelp/package.json
@@ -53,6 +53,7 @@
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
     "@react-spectrum/provider": "^3.0.0"
   },
   "publishConfig": {
diff --git a/packages/@react-spectrum/dnd/package.json b/packages/@react-spectrum/dnd/package.json
@@ -46,6 +46,7 @@
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
     "@react-spectrum/provider": "^3.0.0"
   },
   "publishConfig": {
diff --git a/packages/@react-spectrum/tag/package.json b/packages/@react-spectrum/tag/package.json
@@ -57,6 +57,7 @@
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
     "@react-spectrum/provider": "^3.0.0"
   },
   "publishConfig": {
diff --git a/packages/@react-types/list/package.json b/packages/@react-types/list/package.json
@@ -13,7 +13,9 @@
     "@react-spectrum/list": "^3.6.1"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "@react-spectrum/provider": "^3.0.0"
   },
   "publishConfig": {
     "access": "public"
diff --git a/packages/@spectrum-icons/illustrations/package.json b/packages/@spectrum-icons/illustrations/package.json
@@ -29,7 +29,8 @@
     "@spectrum-icons/build-tools": "3.0.0-alpha.1"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0",
+    "@react-spectrum/provider": "^3.0.0"
   },
   "publishConfig": {
     "access": "public"
diff --git a/scripts/lint-packages.js b/scripts/lint-packages.js
@@ -15,7 +15,7 @@ const fs = require('fs');
 const assert = require('assert');
 const chalk = require('chalk');
 let path = require('path');
-let packages = glob.sync(path.dirname(__dirname) + '/packages/@{react,spectrum}-*/*/package.json');
+let packagePaths = glob.sync(path.dirname(__dirname) + '/packages/@{react,spectrum}-*/*/package.json');
 let errors = false;
 
 // soft assert won't fail the whole thing, allowing us to accumulate all errors at once
@@ -63,9 +63,34 @@ function isDepUsed(dep, src) {
 }
 
 let pkgNames = {};
-for (let pkg of packages) {
-  let json = JSON.parse(fs.readFileSync(pkg));
+let packages = {};
+for (let pkgPath of packagePaths) {
+  let json = JSON.parse(fs.readFileSync(pkgPath));
+  packages[pkgPath] = json;
   pkgNames[json.name] = true;
+}
+
+let missingPeers = {};
+
+for (let pkg of packagePaths) {
+  let json = packages[pkg];
+  // check that all packages which depend on a package with a peerDependency also have that peerDependency
+  if (json.peerDependencies) {
+    for (let dep of Object.keys(json.peerDependencies)) {
+      for (let pkgUpstream of packagePaths) {
+        let pkgu = packages[pkgUpstream];
+        // if the upstream package doesn't also include the peerDependency, then fail
+        if (pkgu.dependencies && pkgu.dependencies[json.name] && pkgu.peerDependencies && !pkgu.peerDependencies[dep]) {
+          let key = `${pkgu.name} missing a peerDependency on ${dep}`
+          if (!missingPeers[key]) {
+            missingPeers[key] = {pkg: pkgu.name, pkgPath: pkgUpstream, missing: dep, deps: [json.name]};
+          } else {
+            missingPeers[key].deps.push(json.name);
+          }
+        }
+      }
+    }
+  }
 
   if (!pkg.includes('@react-types') && !pkg.includes('@spectrum-icons')) {
     softAssert(json.main, `${pkg} did not have "main"`);
@@ -131,7 +156,7 @@ for (let pkg of packages) {
 }
 
 
-for (let pkg of packages) {
+for (let pkg of packagePaths) {
   let globSrc = pkg.replace('package.json', '**/*.{js,ts,tsx}');
   let json = JSON.parse(fs.readFileSync(pkg));
   let [scope, basename] = json.name.split('/');
@@ -157,6 +182,36 @@ for (let pkg of packages) {
   }
 }
 
+function findMoreMissingPeers() {
+  let foundMore = false;
+  for (let val of Object.entries(missingPeers)) {
+    let {pkg, pkgPath, missing, deps} = val[1];
+    let json = packages[pkgPath];
+    for (let pkgUpstream of packagePaths) {
+      let pkgu = packages[pkgUpstream];
+      // if the upstream package doesn't also include the peerDependency, then fail
+      if (pkgu.dependencies && pkgu.dependencies[pkg] && pkgu.peerDependencies && !pkgu.peerDependencies[missing]) {
+        let key = `${pkgu.name} missing a peerDependency on ${missing}`;
+        if (!missingPeers[key]) {
+          missingPeers[key] = {pkg: pkgu.name, pkgPath: pkgUpstream, missing, deps: [json.name]};
+          foundMore = true;
+        } else {
+          missingPeers[key].deps.push(json.name);
+        }
+      }
+    }
+  }
+  if (foundMore) {
+    findMoreMissingPeers();
+  }
+}
+findMoreMissingPeers();
+
+// for each entry in missing peers, fail
+for (let key of Object.keys(missingPeers)) {
+  softAssert(false, `${key} via ${missingPeers[key].deps.reverse().join(', ')}.`);
+}
+
 if (errors) {
   return process.exit(1);
 }
