check node engine is provided in package.json (#248)

kamilkisiela · Apr 24, 2023 · 20117cd · 20117cd
1 parent 0a5ff75
commit 20117cd
Show file tree

Hide file tree

Showing 15 changed files with 293 additions and 183 deletions.
diff --git a/.changeset/bob-the-bundler-247-dependencies.md b/.changeset/bob-the-bundler-247-dependencies.md
@@ -1,7 +1,13 @@
 ---
-"bob-the-bundler": patch
+'bob-the-bundler': patch
 ---
+
 dependencies updates:
-  - Removed dependency [`@vercel/ncc@^0.36.0` ↗︎](https://www.npmjs.com/package/@vercel/ncc/v/0.36.0) (from `dependencies`)
-  - Removed dependency [`dependency-graph@^0.11.0` ↗︎](https://www.npmjs.com/package/dependency-graph/v/0.11.0) (from `dependencies`)
-  - Removed dependency [`tsup@^6.5.0` ↗︎](https://www.npmjs.com/package/tsup/v/6.5.0) (from `dependencies`)
+
+- Removed dependency [`@vercel/ncc@^0.36.0` ↗︎](https://www.npmjs.com/package/@vercel/ncc/v/0.36.0)
+  (from `dependencies`)
+- Removed dependency
+  [`dependency-graph@^0.11.0` ↗︎](https://www.npmjs.com/package/dependency-graph/v/0.11.0) (from
+  `dependencies`)
+- Removed dependency [`tsup@^6.5.0` ↗︎](https://www.npmjs.com/package/tsup/v/6.5.0) (from
+  `dependencies`)
diff --git a/.changeset/mean-kings-jump.md b/.changeset/mean-kings-jump.md
@@ -0,0 +1,5 @@
+---
+'bob-the-bundler': major
+---
+
+Require `engines.node` entry with `bob check` command.
diff --git a/src/commands/check.ts b/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,18 @@ async function checkExportsMapIntegrity(args: {
   }
 }
 
+async function checkEngines(args: {
+  packageJSON: {
+    name: string;
+    engines: unknown;
+  };
+}) {
+  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 {

diff --git a/src/config.ts b/src/config.ts
@@ -1,30 +1,52 @@
 import zod from 'zod';
 
 const BobConfigModel = zod.optional(
-  zod.union([
-    zod.literal(false),
-    zod.object({
-      commonjs: zod.optional(zod.literal(false), {
-        description: 'Omit CommonJS output.',
-      }),
-      build: zod.union([
-        zod.literal(false),
-        zod.optional(
-          zod.object({
-            copy: zod.optional(zod.array(zod.string())),
-          }),
+  zod.union(
+    [
+      zod.literal(false),
+      zod.object({
+        commonjs: zod.optional(zod.literal(false), {
+          description: 'Omit CommonJS output.',
+        }),
+        build: zod.union(
+          [
+            zod.literal(false),
+            zod.optional(
+              zod.object({
+                copy: zod.optional(zod.array(zod.string()), {
+                  description:
+                    'Specify a list of files that should be copied the the output directory.',
+                }),
+              }),
+            ),
+          ],
+          {
+            description:
+              'Build configuration. Set to false for skipping the build of this package.',
+          },
+        ),
+        check: zod.optional(
+          zod.union([
+            zod.literal(false),
+            zod.object({
+              skip: zod.optional(zod.array(zod.string()), {
+                description:
+                  'Skip certain files from being checked. E.g. modules with side-effects.',
+              }),
+            }),
+          ]),
+          {
+            description:
+              'Check whether the built packages comply with the standards. (ESM & CJS compatible and loadable and Node.js engines specified)',
+          },
         ),
-      ]),
-      check: zod.optional(
-        zod.union([
-          zod.literal(false),
-          zod.object({
-            skip: zod.optional(zod.array(zod.string())),
-          }),
-        ]),
-      ),
-    }),
-  ]),
+      }),
+    ],
+    {
+      description:
+        'Bob configuration. Set this value to false in order to disable running bob on this package.',
+    },
+  ),
 );
 
 export type BobConfig = zod.TypeOf<typeof BobConfigModel>;

diff --git a/test/__fixtures__/simple-esm-only/package.json b/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": {

diff --git a/test/__fixtures__/simple-monorepo-pnpm/packages/a/package.json b/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": {

diff --git a/test/__fixtures__/simple-monorepo-pnpm/packages/b/package.json b/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"
   },

diff --git a/test/__fixtures__/simple-monorepo-pnpm/packages/c/package.json b/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": {

diff --git a/test/__fixtures__/simple-monorepo/packages/a/package.json b/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": {

diff --git a/test/__fixtures__/simple-monorepo/packages/b/package.json b/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"
   },

diff --git a/test/__fixtures__/simple-monorepo/packages/c/package.json b/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": {

diff --git a/test/__fixtures__/simple-types-only/package.json b/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": {

diff --git a/test/__fixtures__/simple/package.json b/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": {

diff --git a/test/__fixtures__/tsconfig-build-json/package.json b/test/__fixtures__/tsconfig-build-json/package.json
@@ -1,6 +1,9 @@
 {
   "name": "tsconfig-build-json",
   "type": "module",
+  "engines": {
+    "node": ">= 14.0.0"
+  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {