check node engine is provided in package.json

Author: n1ru4l

src/commands/check.ts

@@ -28,6 +28,8 @@ const ExportsMapModel = zod.record(
   ]),
 );
 
+const EnginesModel = zod.record(zod.string(), zod.string());
+
 const BinModel = zod.record(zod.string());
 
 export const checkCommand = createCommand<{}, {}>(api => {
@@ -93,6 +95,9 @@ export const checkCommand = createCommand<{}, {}>(api => {
                 skipExports: new Set<string>(config?.check?.skip ?? []),
                 includesCommonJS: config?.commonjs ?? true,
               });
+              await checkEngines({
+                packageJSON: distPackageJSON,
+              });
             } catch (err) {
               api.reporter.error(`Integrity check of '${packageJSON.name}' failed.`);
               api.reporter.log(err);
@@ -316,6 +321,19 @@ async function checkExportsMapIntegrity(args: {
   }
 }
 
+async function checkEngines(args: {
+  packageJSON: {
+    name: string;
+    engines: unknown;
+  };
+}) {
+  console.log(args.packageJSON);
+  const engines = EnginesModel.safeParse(args.packageJSON.engines);
+  if (engines.success === false || engines.data['node'] === undefined) {
+    throw new Error('Please specify the node engine version in your package.json.');
+  }
+}
+
 const timeout = `;setTimeout(() => { throw new Error("The Node.js process hangs. There is probably some side-effects. All exports should be free of side effects.") }, 500).unref()`;
 
 function runRequireJSFileCommand(args: { cwd: string; path: string }): ExecaChildProcess {

test/__fixtures__/simple-esm-only/package.json

@@ -1,6 +1,9 @@
 {
   "name": "simple-esm-only",
   "type": "module",
+  "engines": {
+    "node": ">= 14.0.0"
+  },
   "main": "dist/esm/index.js",
   "module": "dist/esm/index.js",
   "exports": {

test/__fixtures__/simple-monorepo-pnpm/packages/a/package.json

@@ -1,6 +1,9 @@
 {
   "name": "a",
   "type": "module",
+  "engines": {
+    "node": ">= 14.0.0"
+  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {

test/__fixtures__/simple-monorepo-pnpm/packages/b/package.json

@@ -1,6 +1,9 @@
 {
   "name": "b",
   "type": "module",
+  "engines": {
+    "node": ">= 14.0.0"
+  },
   "bin": {
     "bbb": "dist/cjs/log-the-world.js"
   },

test/__fixtures__/simple-monorepo-pnpm/packages/c/package.json

@@ -1,5 +1,8 @@
 {
   "name": "c",
+  "engines": {
+    "node": ">= 14.0.0"
+  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {

test/__fixtures__/simple-monorepo/packages/a/package.json

@@ -1,6 +1,9 @@
 {
   "name": "a",
   "type": "module",
+  "engines": {
+    "node": ">= 14.0.0"
+  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {

test/__fixtures__/simple-monorepo/packages/b/package.json

@@ -1,6 +1,9 @@
 {
   "name": "b",
   "type": "module",
+  "engines": {
+    "node": ">= 14.0.0"
+  },
   "bin": {
     "bbb": "dist/cjs/log-the-world.js"
   },

test/__fixtures__/simple-monorepo/packages/c/package.json

@@ -1,5 +1,8 @@
 {
   "name": "c",
+  "engines": {
+    "node": ">= 14.0.0"
+  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {

test/__fixtures__/simple-types-only/package.json

@@ -1,6 +1,9 @@
 {
   "name": "simple-types-only",
   "type": "module",
+  "engines": {
+    "node": ">= 14.0.0"
+  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {

test/__fixtures__/simple/package.json

@@ -1,6 +1,9 @@
 {
   "name": "simple",
   "type": "module",
+  "engines": {
+    "node": ">= 12.0.0"
+  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {