@cubing/dev-config 0.6.0 → 0.6.2

package/bin/package.json.ts

@@ -255,7 +255,7 @@ function traverse<T>(
 
 function field<T>(
   breadcrumbs: Breadcrumbs,
-  type: Categorization,
+  type: Categorization | Categorization[],
   options?: {
     optional?: boolean;
     additionalChecks?: { [requirementMessage: string]: (t: T) => boolean };
@@ -277,8 +277,9 @@ function field<T>(
   }
   const [value] = maybeValue;
 
+  const typeArray = Array.isArray(type) ? type : [type];
   const category = categorize(value);
-  if (category === type) {
+  if (typeArray.includes(category)) {
     for (const [failureMessage, fn] of Object.entries(
       options?.additionalChecks ?? {},
     )) {
@@ -297,9 +298,15 @@ function field<T>(
     } else if (type === "undefined") {
       console.log(`❌ ${breadcrumbString} — Present (but must not be).`);
     } else {
-      console.log(
-        `❌ ${breadcrumbString} — Does not match expected type: ${type}`,
-      );
+      if (Array.isArray(type)) {
+        console.log(
+          `❌ ${breadcrumbString} — Does not match an expected type: ${type.join(", ")}`,
+        );
+      } else {
+        console.log(
+          `❌ ${breadcrumbString} — Does not match expected type: ${type}`,
+        );
+      }
     }
     exitCode = 1;
     return;
@@ -327,10 +334,8 @@ field(["version"], "string", {
 field(["homepage"], "string", { optional: true });
 field(["description"], "string");
 // TODO: format author.
-if (categorize(packageJSON["author"]) === "string") {
-  field(["author"], "object");
-} else {
-  field(["author"], "object");
+field(["author"], ["string", "object"]);
+if (categorize(packageJSON["author"]) === "object") {
   field(["author", "name"], "string");
   field(["author", "email"], "string");
   field(["author", "url"], "string", {
@@ -521,6 +526,7 @@ if (packageJSON.exports) {
       // biome-ignore lint/complexity/noUselessContinue: Explicit control flow.
       continue;
     } else if (typeof value === "string") {
+      // TODO: error?
       checkPath(["exports", [exportPath]], {
         expectPrefix: ResolutionPrefix.Relative,
       });
@@ -532,7 +538,49 @@ if (packageJSON.exports) {
         "❌ .exports — Must use an object (instead of an array).",
       );
     } else {
-      for (const secondaryKey of Object.keys(value as Record<string, string>)) {
+      const keys = Object.keys(value as Record<string, string>);
+
+      checks.push(
+        (async () => {
+          const { breadcrumbString } = traverse(["exports", [exportPath]]);
+          const orderingErrorLines = [];
+          /**
+           * https://nodejs.org/api/packages.html#conditional-exports
+           */
+          if (keys.includes("types")) {
+            if (keys[0] !== "types") {
+              orderingErrorLines.push(
+                `  ↪ "types" must be the first export if present.`,
+              );
+            }
+          }
+          if (keys.includes("default")) {
+            if (keys.at(-1) !== "default") {
+              orderingErrorLines.push(
+                `  ↪ "default" must be the last export if present.`,
+              );
+            }
+          }
+          for (const key of keys) {
+            // Note `"require"` is *emphatically not allowed*.
+            if (!["types", "import", "default"].includes(key)) {
+              orderingErrorLines.push(
+                `  ↪ Key must not be present: ${JSON.stringify(key)}`,
+              );
+            }
+          }
+          if (orderingErrorLines) {
+            exitCode = 0;
+            return [
+              `❌ ${breadcrumbString} — Invalid keys:`,
+              ...orderingErrorLines,
+            ].join("\n");
+          } else {
+            return `✅ ${breadcrumbString} — Key set and ordering is okay..`;
+          }
+        })(),
+      );
+      for (const secondaryKey of keys) {
         checkPath(["exports", [exportPath], secondaryKey], {
           expectPrefix: ResolutionPrefix.Relative,
         });

package/package.json

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