Merge pull request #150 from ext/bugfix/types-node-maxbuffer

fix: ignore @types/node when verifying transitive engine constraints

src/rules/verify-engine-constraint.spec.ts

@@ -1,4 +1,5 @@
 import PackageJson from "../types/package-json";
+import * as npmInfoModule from "../utils/npm-info";
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import { npmInfoMockClear, npmInfoMockAdd } from "../utils/npm-info";
@@ -104,3 +105,16 @@ it("should not return error if all dependencies have matching constraints", asyn
 	npmInfoMockAdd("bar@1.0.0", { name: "bar", version: "1.0.0", engines: { node: ">= 12" } });
 	expect(await verifyEngineConstraint(pkg)).toEqual([]);
 });
+
+it("should ignore @types/node", async () => {
+	expect.assertions(1);
+	const pkg: PackageJson = {
+		name: "my-app",
+		version: "1.0.0",
+		dependencies: { "@types/node": "*" },
+		engines: { node: ">= 10" },
+	};
+	const npmInfo = jest.spyOn(npmInfoModule, "npmInfo");
+	await verifyEngineConstraint(pkg);
+	expect(npmInfo).not.toHaveBeenCalled();
+});

src/rules/verify-engine-constraint.ts

@@ -8,6 +8,14 @@ const ruleId = "invalid-engine-constraint";
 async function* getDeepDependencies(pkg: PackageJson, dependency?: string): AsyncGenerator<string> {
 	const pkgData = dependency ? await npmInfo(dependency) : pkg;
 	for (const [key, value] of Object.entries(pkgData.dependencies ?? {})) {
+		/* ignore this as this package is sometimes is present as version "*" which
+		 * just yields way to many versions to handle causing MaxBuffer errors and
+		 * there is another rule to make sure the outermost @types/node package
+		 * matches the configured engines */
+		if (key === "@types/node") {
+			continue;
+		}
+
 		const deep = `${key}@${value}`;
 		yield deep;
 		yield* await getDeepDependencies(pkg, deep);