@cubing/dev-config 0.6.3 → 0.6.5

package/bin/package.json.ts

@@ -260,8 +260,11 @@ function field<T>(
     optional?: boolean;
     additionalChecks?: { [requirementMessage: string]: (t: T) => boolean };
     skipPrintingSuccess?: boolean;
+    mustBePopulatedMessage?: string;
   },
 ) {
+  const mustBePopulatedMessage = () =>
+    options?.mustBePopulatedMessage ?? "Field must be populated.";
   const { breadcrumbString, maybeValue } = traverse(breadcrumbs);
   if (!maybeValue) {
     if (options?.optional) {
@@ -270,7 +273,7 @@ function field<T>(
       }
       return;
     } else {
-      console.log(`❌ ${breadcrumbString} — Must be present.`);
+      console.log(`❌ ${breadcrumbString} — ${mustBePopulatedMessage()}`);
       exitCode = 1;
       return;
     }
@@ -294,9 +297,11 @@ function field<T>(
     }
   } else {
     if (category === "undefined") {
-      console.log(`❌ ${breadcrumbString} — Must be present.`);
+      console.log(`❌ ${breadcrumbString} — ${mustBePopulatedMessage()}.`);
     } else if (type === "undefined") {
-      console.log(`❌ ${breadcrumbString} — Present (but must not be).`);
+      console.log(
+        `❌ ${breadcrumbString} — Field is populated (but must not be).`,
+      );
     } else {
       if (Array.isArray(type)) {
         console.log(
@@ -313,7 +318,7 @@ function field<T>(
   }
 }
 
-function mustNotBePresent(breadcrumbs: Breadcrumbs) {
+function mustNotBePopulated(breadcrumbs: Breadcrumbs) {
   const { breadcrumbString, maybeValue } = traverse(breadcrumbs);
   if (maybeValue) {
     console.log(`❌ ${breadcrumbString} — Must not be present.`);
@@ -393,6 +398,19 @@ field(["type"], "string", {
     'Type must be `"module"`.': (type: string) => type === "module",
   },
 });
+if ("main" in packageJSON || "types" in packageJSON) {
+  field(["main"], "string", {
+    mustBePopulatedMessage: 'Must be populated if "types" is populated.',
+  });
+  field(["types"], "string", {
+    mustBePopulatedMessage: 'Must be populated if "main" is populated.',
+  });
+} else {
+  console.log("☑️ .main");
+  console.log("☑️ .types");
+}
+mustNotBePopulated(["module"]);
+mustNotBePopulated(["browser"]);
 field(["exports"], "object");
 field(["bin"], "object", { optional: true });
 field(["dependencies"], "object", { optional: true });
@@ -407,15 +425,6 @@ field(["files"], "array");
 field(["scripts"], "object");
 // Set to `"# no-op"` if needed.
 field(["scripts", "prepublishOnly"], "string");
-if ("main" in packageJSON || "types" in packageJSON) {
-  field(["main"], "string");
-  field(["types"], "string");
-} else {
-  console.log("☑️ .main");
-  console.log("☑️ .types");
-}
-mustNotBePresent(["module"]);
-mustNotBePresent(["browser"]);
 
 console.log("Checking paths of binaries and exports:");
 
@@ -424,12 +433,17 @@ await using _ = {
   [Symbol.asyncDispose]: () => tempDir.rm_rf(),
 };
 const extractionDir = await tempDir.join("extracted").mkdir();
+// TODO: is there a 100% reliable way to test against paths that *will* be packed?
+// Note that this has to take into account `.gitignore`, `.npmignore`, and `"files"` — with globs and excludes.
+// For now, we print the command to make it clear that some heavy lifting is going on (and that it's not our fault that it's slow).
 const data: { filename: string }[] = await new PrintableShellCommand("npm", [
   "pack",
   "--json",
   "--ignore-scripts",
   ["--pack-destination", tempDir],
-]).json();
+])
+  .print()
+  .json();
 const tgzPath = tempDir.join(data[0].filename);
 await new PrintableShellCommand("tar", [
   ["-C", extractionDir],
@@ -500,14 +514,14 @@ function checkPath(
       // TODO: allow folders (with a required trailing slash)?
       if (!(await resolvedPath.existsAsFile())) {
         exitCode = 1;
-        return `❌ ${breadcrumbString} — Missing — ${value}`;
+        return `❌ ${breadcrumbString} — Path is not present on disk. — ${value}`;
       }
       if (options.mustBeExecutable) {
         if (!((await resolvedPath.stat()).mode ^ constants.X_OK)) {
           // This is not considered fixable because the binary may be the output
           // of a build process. In that case, the build process is responsible
           // for marking it as executable.
-          return `❌ ${breadcrumbString} — Must be executable — ${value}`;
+          return `❌ ${breadcrumbString} — File at path must be executable — ${value}`;
         }
       }
       return `✅ ${breadcrumbString} — OK — ${value}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubing/dev-config",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "Common dev configs for projects.",
   "author": {
     "name": "Lucas Garron",