Add "engines" field to all packages to indicate minimum Node JS version

robhogan · facebook-github-bot · commit c3e453ede576 · 2023-02-01T04:08:26.000-08:00
Summary: We currently have a minimum supported Node version of 14.17.0, and we (correctly) report a breaking change whenever we bump that requirement (eg, [0.73 release notes](https://github.com/facebook/metro/releases/tag/v0.73.0)), but we don't properly declare it in the package manifest. That means users of older Node JS versions may encounter obscure and unhelpful parsing or runtime errors. By using the `"engines"` spec, we give the package manager the best chance of steering them towards an upgrade. This will also serve as a reference for contributors. Changelog: **[Breaking]** Formalise minimum Node JS requirement at 14.17.0 via `package.json#engines` Reviewed By: huntie Differential Revision: D42904112 fbshipit-source-id: c1b546d32924e471c3ec2013a58a6d0ea43e4815
diff --git a/package.json b/package.json
@@ -86,5 +86,8 @@
     ]
   },
   "license": "MIT",
-  "dependencies": {}
+  "dependencies": {},
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/packages/buck-worker-tool/package.json b/packages/buck-worker-tool/package.json
@@ -18,5 +18,8 @@
   "scripts": {
     "prepare-release": "test -d build && rm -rf src.real && mv src src.real && mv build src",
     "cleanup-release": "test ! -e build && mv src build && mv src.real src"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-babel-register/package.json b/packages/metro-babel-register/package.json
@@ -23,5 +23,8 @@
     "prepare-release": "test -d build && rm -rf src.real && mv src src.real && mv build src",
     "cleanup-release": "test ! -e build && mv src build && mv src.real src"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/packages/metro-babel-transformer/package.json b/packages/metro-babel-transformer/package.json
@@ -21,5 +21,8 @@
     "hermes-parser": "0.8.0",
     "metro-source-map": "0.74.1",
     "nullthrows": "^1.1.1"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-cache-key/package.json b/packages/metro-cache-key/package.json
@@ -14,5 +14,8 @@
   "license": "MIT",
   "devDependencies": {
     "metro-memory-fs": "0.74.1"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-cache/package.json b/packages/metro-cache/package.json
@@ -18,5 +18,8 @@
   "devDependencies": {
     "metro-memory-fs": "0.74.1"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/packages/metro-config/package.json b/packages/metro-config/package.json
@@ -23,5 +23,8 @@
   "devDependencies": {
     "pretty-format": "^26.5.2",
     "strip-ansi": "^6.0.0"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-core/package.json b/packages/metro-core/package.json
@@ -15,5 +15,8 @@
     "lodash.throttle": "^4.1.1",
     "metro-resolver": "0.74.1"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/packages/metro-file-map/package.json b/packages/metro-file-map/package.json
@@ -32,5 +32,8 @@
   },
   "optionalDependencies": {
     "fsevents": "^2.3.2"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-hermes-compiler/package.json b/packages/metro-hermes-compiler/package.json
@@ -11,5 +11,8 @@
     "prepare-release": "test -d build && rm -rf src.real && mv src src.real && mv build src",
     "cleanup-release": "test ! -e build && mv src build && mv src.real src"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/packages/metro-inspector-proxy/package.json b/packages/metro-inspector-proxy/package.json
@@ -21,5 +21,8 @@
     "debug": "^2.2.0",
     "ws": "^7.5.1",
     "yargs": "^17.5.1"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-memory-fs/package.json b/packages/metro-memory-fs/package.json
@@ -11,5 +11,8 @@
     "prepare-release": "test -d build && rm -rf src.real && mv src src.real && mv build src",
     "cleanup-release": "test ! -e build && mv src build && mv src.real src"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/packages/metro-minify-terser/package.json b/packages/metro-minify-terser/package.json
@@ -14,5 +14,8 @@
   "license": "MIT",
   "dependencies": {
     "terser": "^5.15.0"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-minify-uglify/package.json b/packages/metro-minify-uglify/package.json
@@ -14,5 +14,8 @@
   "license": "MIT",
   "dependencies": {
     "uglify-es": "^3.1.9"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-react-native-babel-preset/package.json b/packages/metro-react-native-babel-preset/package.json
@@ -59,5 +59,8 @@
   },
   "peerDependencies": {
     "@babel/core": "*"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-react-native-babel-transformer/package.json b/packages/metro-react-native-babel-transformer/package.json
@@ -28,5 +28,8 @@
   },
   "peerDependencies": {
     "@babel/core": "*"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-react-native-interop-tools/package.json b/packages/metro-react-native-interop-tools/package.json
@@ -17,5 +17,8 @@
     "hermes-parser": "0.8.0",
     "nullthrows": "^1.1.1"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/packages/metro-resolver/package.json b/packages/metro-resolver/package.json
@@ -14,5 +14,8 @@
   "dependencies": {
     "absolute-path": "^0.0.0"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/packages/metro-runtime/package.json b/packages/metro-runtime/package.json
@@ -20,5 +20,8 @@
     "@babel/core": "^7.20.0",
     "react": "^18.2.0",
     "react-test-renderer": "^18.2.0"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-source-map/package.json b/packages/metro-source-map/package.json
@@ -26,5 +26,8 @@
     "@babel/core": "^7.20.0",
     "@babel/parser": "^7.20.0",
     "uglify-es": "^3.1.9"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-symbolicate/package.json b/packages/metro-symbolicate/package.json
@@ -26,5 +26,8 @@
     "source-map": "^0.5.6",
     "through2": "^2.0.1",
     "vlq": "^1.0.0"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-transform-plugins/package.json b/packages/metro-transform-plugins/package.json
@@ -25,5 +25,8 @@
     "@babel/plugin-transform-flow-strip-types": "^7.0.0",
     "@babel/types": "^7.20.0",
     "metro": "0.74.1"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro-transform-worker/package.json b/packages/metro-transform-worker/package.json
@@ -31,5 +31,8 @@
     "metro-memory-fs": "0.74.1",
     "metro-minify-terser": "0.74.1",
     "metro-react-native-babel-transformer": "0.74.1"
+  },
+  "engines": {
+    "node": ">=14.17.0"
   }
 }
diff --git a/packages/metro/package.json b/packages/metro/package.json
@@ -78,5 +78,8 @@
     "mock-res": "^0.6.0",
     "stack-trace": "^0.0.10"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/packages/ob1/package.json b/packages/ob1/package.json
@@ -15,5 +15,8 @@
     "metro"
   ],
   "license": "MIT",
-  "dependencies": {}
+  "dependencies": {},
+  "engines": {
+    "node": ">=14.17.0"
+  }
 }
diff --git a/scripts/__tests__/subpackages-test.js b/scripts/__tests__/subpackages-test.js
@@ -12,6 +12,7 @@
 
 const getPackages = require('../_getPackages');
 const METRO_VERSION = require('../../lerna.json').version;
+const ENGINES = require('../../package.json').engines;
 const fs = require('fs');
 const path = require('path');
 
@@ -46,6 +47,12 @@ it('forces all packages to use the main metro version', () => {
   });
 });
 
+it('forces all packages to use the root "engines" spec', () => {
+  checkAssertionInPackages(getPackages(), packagePath => {
+    expect(readPackageJson(packagePath).engines).toEqual(ENGINES);
+  });
+});
+
 it('forces all metro dependencies to be fixed to the main version', () => {
   const packages = getPackages();
   const packageNames = new Set(

Original file line number	Diff line number	Diff line change
`@@ -86,5 +86,8 @@`
`86`	`86`	`]`
`87`	`87`	`},`
`88`	`88`	`"license": "MIT",`
`89`		`- "dependencies": {}`
	`89`	`+ "dependencies": {},`
	`90`	`+ "engines": {`
	`91`	`+ "node": ">=14.17.0"`
	`92`	`+ }`
`90`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,8 @@`
`18`	`18`	`"scripts": {`
`19`	`19`	`"prepare-release": "test -d build && rm -rf src.real && mv src src.real && mv build src",`
`20`	`20`	`"cleanup-release": "test ! -e build && mv src build && mv src.real src"`
	`21`	`+ },`
	`22`	`+ "engines": {`
	`23`	`+ "node": ">=14.17.0"`
`21`	`24`	`}`
`22`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,8 @@`
`21`	`21`	`"hermes-parser": "0.8.0",`
`22`	`22`	`"metro-source-map": "0.74.1",`
`23`	`23`	`"nullthrows": "^1.1.1"`
	`24`	`+ },`
	`25`	`+ "engines": {`
	`26`	`+ "node": ">=14.17.0"`
`24`	`27`	`}`
`25`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,8 @@`
`14`	`14`	`"license": "MIT",`
`15`	`15`	`"devDependencies": {`
`16`	`16`	`"metro-memory-fs": "0.74.1"`
	`17`	`+ },`
	`18`	`+ "engines": {`
	`19`	`+ "node": ">=14.17.0"`
`17`	`20`	`}`
`18`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,8 @@`
`23`	`23`	`"devDependencies": {`
`24`	`24`	`"pretty-format": "^26.5.2",`
`25`	`25`	`"strip-ansi": "^6.0.0"`
	`26`	`+ },`
	`27`	`+ "engines": {`
	`28`	`+ "node": ">=14.17.0"`
`26`	`29`	`}`
`27`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,5 +32,8 @@`
`32`	`32`	`},`
`33`	`33`	`"optionalDependencies": {`
`34`	`34`	`"fsevents": "^2.3.2"`
	`35`	`+ },`
	`36`	`+ "engines": {`
	`37`	`+ "node": ">=14.17.0"`
`35`	`38`	`}`
`36`	`39`	`}`