@zappie/check 0.2.3 → 0.2.6

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @zappie/check
 
+## 0.2.6
+
+### Patch Changes
+
+- dc14434: Reload `zappie.config.ts` whenever its content changes, including when a rewrite keeps the same modification time.
+
+## 0.2.5
+
+### Patch Changes
+
+- b0b2a59: Let a site raise V15's first-card tappable limit to 5000 ms with an explained site budget, and record the applied limit in the verify report. A site that adds `budgets.tappableMs` must upgrade `@zappie/check` and `@zappie/sdk` in the same change.
+- Updated dependencies [b0b2a59]
+  - @zappie/sdk@0.1.15
+
+## 0.2.4
+
+### Patch Changes
+
+- 5a2bce9: Verify can start somewhere other than `/`, for a site whose root is a directory of its menus. Set `verify.startPath` in `zappie.config.ts`, or pass `startPath` to `verify()` or `verifyProject()`. Every check that opened `/` as the menu opens that route instead. Set `verify.cataloguePath`, such as `/menu?menu={menu}`, when each menu has its own page: V03 then needs 95% of each menu's available items on that menu's page, instead of 95% of the branch's items on one page, and the checks that use an item open the page of a menu that holds it. A route must start with one `/` and contain no backslash. A site that sets neither runs as before. The report's `environment` records `startPath`, and `cataloguePath` when it is set. When `--store` is passed and `zappie.config.ts` exists but can't be read, the report's `warnings` says its verify settings were ignored. The `@zappie/sdk` site config and `zappie check` accept the `verify` settings, so a site that adds them needs `@zappie/sdk` 0.1.14 and `@zappie/check` 0.2.4 in the same change. This is a minor release, so a regression comparison doesn't compare these reports with reports from 0.2.
+- Updated dependencies [5a2bce9]
+  - @zappie/sdk@0.1.14
+
 ## 0.2.3
 
 ### Patch Changes

package/dist/index.js

@@ -2,7 +2,8 @@
 var DEFAULT_BUDGETS = {
   jsKbGz: 200,
   cssKbGz: 50,
-  lcpMs: 2500
+  lcpMs: 2500,
+  tappableMs: 3e3
 };
 var GLOBAL_PACKAGE_ALLOWLIST = [
   "react",
@@ -96,7 +97,7 @@ function budgets(value, issue, error) {
   nested(
     value,
     "budgets",
-    ["jsKbGz", "cssKbGz", "lcpMs", "override"],
+    [...Object.keys(DEFAULT_BUDGETS), "override"],
     issue,
     (budget) => {
       nested(
@@ -114,28 +115,35 @@ function budgets(value, issue, error) {
           }
         }
       );
-      for (const key of ["jsKbGz", "cssKbGz", "lcpMs"]) {
+      for (const key of Object.keys(DEFAULT_BUDGETS)) {
         const amount = budget[key];
+        const path15 = `budgets.${key}`;
         if (amount === void 0) {
           continue;
         }
         if (typeof amount !== "number" || !Number.isFinite(amount) || amount <= 0) {
           error(
-            `budgets.${key}`,
+            path15,
             "invalid_type",
-            `Expected a positive finite number. Set budgets.${key} to a number greater than zero.`
+            `Expected a positive finite number. Set ${path15} to a number greater than zero.`
+          );
+        } else if (key === "tappableMs" && amount > 5e3) {
+          error(
+            path15,
+            "invalid_format",
+            "The tappableMs budget cannot exceed 5000. Set budgets.tappableMs to 5000 or less."
           );
         } else if (amount > DEFAULT_BUDGETS[key]) {
           const message6 = `The ${key} budget exceeds the ${DEFAULT_BUDGETS[key]} default.`;
           if (budget.override === void 0) {
             error(
-              `budgets.${key}`,
+              path15,
               "budget_override",
               `${message6} Add budgets.override.reason to explain the increase.`
             );
           } else {
             issue({
-              path: `budgets.${key}`,
+              path: path15,
               code: "budget_override",
               message: `${message6} Lower it to the default when the exception is no longer needed.`,
               severity: "warning"
@@ -186,7 +194,8 @@ var rootKeys = [
   "security",
   "budgets",
   "readiness",
-  "analytics"
+  "analytics",
+  "verify"
 ];
 function validateConfig(input) {
   const issues = [];
@@ -206,14 +215,30 @@ function validateConfig(input) {
     };
   }
   unknownKeys(input, rootKeys, "", issue);
-  requiredSlug(input.store, "store", error);
+  if (!nonblank(input.store)) {
+    error(
+      "store",
+      input.store === void 0 ? "missing_required" : "invalid_type",
+      "Expected a non-empty storefront slug. Set store to the slug used by createZappie()."
+    );
+  }
   theme(input.theme, error);
   stringList(input.branches, "branches", error, {
     nonempty: true,
     unique: true,
     slug: true
   });
-  paths(input.prerender, error);
+  stringList(input.prerender, "prerender", error, { unique: true })?.forEach(
+    (path15, index) => {
+      if (!path15.startsWith("/")) {
+        error(
+          `prerender[${index}]`,
+          "invalid_format",
+          "Expected a route starting with /. Prefix the route with /."
+        );
+      }
+    }
+  );
   nested(input.menu, "menu", ["hiddenCategories"], issue, (value) => {
     stringList(value.hiddenCategories, "menu.hiddenCategories", error);
   });
@@ -285,20 +310,19 @@ function validateConfig(input) {
     }
   );
   analytics(input.analytics, issue, error);
+  nested(
+    input.verify,
+    "verify",
+    ["startPath", "cataloguePath"],
+    issue,
+    () => {
+    }
+  );
   return {
     valid: !issues.some((entry) => entry.severity === "error"),
     issues
   };
 }
-function requiredSlug(value, path15, error) {
-  if (!nonblank(value)) {
-    error(
-      path15,
-      value === void 0 ? "missing_required" : "invalid_type",
-      `Expected a non-empty storefront slug. Set ${path15} to the slug used by createZappie().`
-    );
-  }
-}
 function theme(value, error) {
   if (typeof value !== "string") {
     error(
@@ -362,18 +386,6 @@ function hostList(value, path15, error) {
     }
   });
 }
-function paths(value, error) {
-  const values = stringList(value, "prerender", error, { unique: true });
-  values?.forEach((path15, index) => {
-    if (!path15.startsWith("/")) {
-      error(
-        `prerender[${index}]`,
-        "invalid_format",
-        "Expected a route starting with /. Prefix the route with /."
-      );
-    }
-  });
-}
 
 // src/allowlist.ts
 import { access, readFile as readFile3 } from "fs/promises";
@@ -1076,7 +1088,8 @@ function validateTheme(input) {
 }
 
 // src/config.ts
-import { readFile as readFile2, stat } from "fs/promises";
+import { createHash } from "crypto";
+import { readFile as readFile2 } from "fs/promises";
 import path2 from "path";
 import { pathToFileURL } from "url";
 
@@ -1127,7 +1140,7 @@ async function loadConfig(cwd) {
     );
   }
   const source = await readFile2(file, "utf8");
-  const version = (await stat(file)).mtimeMs;
+  const version = createHash("sha256").update(source).digest("hex");
   const loaded = await import(`${pathToFileURL(file).href}?check=${version}`);
   return { value: loaded.default, source, file };
 }