@simmalugnt-se/payload-content-health 0.2.1 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.3.0
+
+- "Fix with the assistant" on a missing meta title or description says how long to write it
+  ("Write a meta title for this page, 50–60 characters."), from the same range as the length check.
+  Without it the assistant wrote titles well under the range. Findings for a missing meta title or
+  description carry that range as `range`.
+
 ## 0.2.1
 
 - The work list at `/admin/content-health` requires Admin access. Payload leaves custom Admin views

package/README.md

@@ -115,9 +115,10 @@ or block the unsaved form no longer has opens the nearest enclosing field instea
 
 With `@simmalugnt-se/payload-editor-assistant` (0.5.0 or later), rows in the collections the
 assistant works in also get "Fix with the assistant": the same link with a ready prompt that the
-assistant puts in its message box. The editor sends it. To write a missing alt text, the assistant
-needs to see the image: allow `media.view` on the media collection (0.6.0 or later). The packages
-do not import each other; they share these names:
+assistant puts in its message box, with the length to aim for when a meta title or description is
+missing or off. The editor sends it. To write a missing alt text, the assistant needs to see the
+image: allow `media.view` on the media collection (0.6.0 or later). The packages do not import each
+other; they share these names:
 
 | Name                                         | Direction               | Meaning                                  |
 | -------------------------------------------- | ----------------------- | ---------------------------------------- |
@@ -137,6 +138,8 @@ import { scanContentHealth } from "@simmalugnt-se/payload-content-health";
 const { findings, problems } = await scanContentHealth({ payload, user: req.user });
 ```
 
-Each finding is `{ check, collection, id, title, path, locale?, length?, heading?, words?, status? }`,
-where `path` is the form path with row indexes (`layout.1.items.0.title`). `problems`
-lists configured checks that could not run, such as a field path that does not exist.
+Each finding is
+`{ check, collection, id, title, path, locale?, length?, range?, heading?, words?, status? }`, where
+`path` is the form path with row indexes (`layout.1.items.0.title`) and `range` is the length a
+missing meta title or description should have. `problems` lists configured checks that could not
+run, such as a field path that does not exist.

package/dist/checks.d.ts

@@ -19,6 +19,7 @@ export type FieldRule = {
     kind: "required";
     path: string;
     imagesOnly?: boolean;
+    range?: LengthRange;
 } | {
     check: CheckId;
     kind: "length";

package/dist/checks.js

@@ -25,13 +25,23 @@ export function rulesFor(options) {
         const titleLength = seo.titleLength ?? SEO_DEFAULTS.titleLength;
         const descriptionLength = seo.descriptionLength ?? SEO_DEFAULTS.descriptionLength;
         if (title) {
-            rules.push({ check: "seo.title-missing", kind: "required", path: title });
+            rules.push({
+                check: "seo.title-missing",
+                kind: "required",
+                path: title,
+                ...(titleLength ? { range: titleLength } : {}),
+            });
             if (titleLength) {
                 rules.push({ check: "seo.title-length", kind: "length", path: title, range: titleLength });
             }
         }
         if (description) {
-            rules.push({ check: "seo.description-missing", kind: "required", path: description });
+            rules.push({
+                check: "seo.description-missing",
+                kind: "required",
+                path: description,
+                ...(descriptionLength ? { range: descriptionLength } : {}),
+            });
             if (descriptionLength) {
                 rules.push({
                     check: "seo.description-length",
@@ -105,7 +115,8 @@ export function checkDocument(input) {
             }
             checked.push(rule.check);
             if (isEmpty(value)) {
-                findings.push(base);
+                // The assistant writes to the length the length check will expect.
+                findings.push(rule.range ? { ...base, range: rule.range } : base);
             }
             continue;
         }

package/dist/copy.js

@@ -122,11 +122,15 @@ export const COPY = {
 export const ASK = {
     en: {
         "media.alt-missing": () => "Write an alt text for this image.",
-        "seo.title-missing": () => "Write a meta title for this page.",
+        "seo.title-missing": ({ range }) => range
+            ? `Write a meta title for this page, ${range.min}–${range.max} characters.`
+            : "Write a meta title for this page.",
         "seo.title-length": ({ length }) => length
             ? `The meta title is ${length.actual} characters. Rewrite it to ${length.min}–${length.max} characters.`
             : "Rewrite the meta title to a better length.",
-        "seo.description-missing": () => "Write a meta description for this page.",
+        "seo.description-missing": ({ range }) => range
+            ? `Write a meta description for this page, ${range.min}–${range.max} characters.`
+            : "Write a meta description for this page.",
         "seo.description-length": ({ length }) => length
             ? `The meta description is ${length.actual} characters. Rewrite it to ${length.min}–${length.max} characters.`
             : "Rewrite the meta description to a better length.",
@@ -142,11 +146,15 @@ export const ASK = {
     },
     sv: {
         "media.alt-missing": () => "Skriv en alt-text för den här bilden.",
-        "seo.title-missing": () => "Skriv en metatitel för den här sidan.",
+        "seo.title-missing": ({ range }) => range
+            ? `Skriv en metatitel för den här sidan, ${range.min}–${range.max} tecken.`
+            : "Skriv en metatitel för den här sidan.",
         "seo.title-length": ({ length }) => length
             ? `Metatiteln är ${length.actual} tecken. Skriv om den till ${length.min}–${length.max} tecken.`
             : "Skriv om metatiteln till en bättre längd.",
-        "seo.description-missing": () => "Skriv en metabeskrivning för den här sidan.",
+        "seo.description-missing": ({ range }) => range
+            ? `Skriv en metabeskrivning för den här sidan, ${range.min}–${range.max} tecken.`
+            : "Skriv en metabeskrivning för den här sidan.",
         "seo.description-length": ({ length }) => length
             ? `Metabeskrivningen är ${length.actual} tecken. Skriv om den till ${length.min}–${length.max} tecken.`
             : "Skriv om metabeskrivningen till en bättre längd.",

package/dist/types.d.ts

@@ -19,6 +19,8 @@ export type Finding = {
     length?: LengthRange & {
         actual: number;
     };
+    /** For a missing meta title or description: the length its length check expects. */
+    range?: LengthRange;
     /** For heading checks: the heading's level and, for a skip, the level before it. */
     heading?: {
         level: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simmalugnt-se/payload-content-health",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Content health checks and dashboard widgets for Payload Admin: alt texts, SEO fields and more",
   "keywords": [
     "payload",