Share localized metadata sentence joining

Author: lawrencecchen

web/i18n/audited-seo.ts

@@ -2,6 +2,7 @@ import {
   openGraphImageAlt,
   openGraphImageTagline,
   detailedSeoDescriptionCandidate,
+  joinMetadataSentences,
   seoDescription,
   seoTitle,
   shortSeoDescriptionCandidate,
@@ -67,23 +68,16 @@ function selectDescription(
   const tagline = openGraphImageTagline(locale);
   const contextualCandidates = authoredCandidates.flatMap((candidate) => [
     candidate,
-    joinSentences(candidate, short),
-    joinSentences(candidate, detailed),
-    joinSentences(joinSentences(candidate, short), tagline),
+    joinMetadataSentences(candidate, short),
+    joinMetadataSentences(candidate, detailed),
+    joinMetadataSentences(joinMetadataSentences(candidate, short), tagline),
   ]);
   return seoDescription(locale, original, {
     minLength: 110,
     fallbackCandidates: contextualCandidates,
   });
 }
 
-function joinSentences(first: string, second: string) {
-  const leading = first.trim();
-  const trailing = second.trim();
-  const separator = /[.!?。！？؟។៕]$/u.test(leading) ? " " : ". ";
-  return `${leading}${separator}${trailing}`;
-}
-
 export function homeSeoCopy(locale: string, meta: SeoMessageLookup) {
   const title = selectTitle(locale, meta("title"), meta, [
     openGraphImageAlt(locale),
@@ -106,7 +100,7 @@ export function assetsSeoCopy(
     title: selectTitle(locale, t("metaTitle"), siteMeta, [t("title")]),
     description: selectDescription(locale, t("metaDescription"), [
       t("title"),
-      joinSentences(t("title"), t("metaDescription")),
+      joinMetadataSentences(t("title"), t("metaDescription")),
       t("description"),
     ]),
   };
@@ -121,7 +115,7 @@ export function blogIndexSeoCopy(
     title: selectTitle(locale, t("metaTitle"), siteMeta, [t("title")]),
     description: selectDescription(locale, t("metaDescription"), [
       t("title"),
-      joinSentences(t("title"), t("metaDescription")),
+      joinMetadataSentences(t("title"), t("metaDescription")),
     ]),
   };
 }
@@ -138,7 +132,7 @@ export function communitySeoCopy(
     ]),
     description: selectDescription(locale, t("metaDescription"), [
       t("title"),
-      joinSentences(t("title"), t("metaDescription")),
+      joinMetadataSentences(t("title"), t("metaDescription")),
       t("description"),
     ]),
   };
@@ -154,7 +148,7 @@ export function bestTerminalSeoCopy(
     description: selectDescription(locale, t("metaDescription"), [
       t("title"),
       t("cmuxBuiltFor"),
-      joinSentences(t("title"), t("cmuxBuiltFor")),
+      joinMetadataSentences(t("title"), t("cmuxBuiltFor")),
     ]),
   };
 }
@@ -194,7 +188,7 @@ export function compareIndexSeoCopy(
     title: selectTitle(locale, t("metaTitle"), siteMeta, [t("title")]),
     description: selectDescription(locale, t("metaDescription"), [
       t("title"),
-      joinSentences(t("title"), openGraphImageAlt(locale)),
+      joinMetadataSentences(t("title"), openGraphImageAlt(locale)),
       t("intro"),
     ]),
   };
@@ -222,9 +216,9 @@ export function comparePageSeoCopy(
     title: selectTitle(locale, t("metaTitle"), siteMeta, titleCandidates),
     description: selectDescription(locale, t("metaDescription"), [
       ...descriptionCandidates,
-      joinSentences(t("faqQ1"), t("faqA1")),
-      joinSentences(t("faqQ2"), t("faqA2")),
-      joinSentences(t("faqQ3"), t("faqA3")),
+      joinMetadataSentences(t("faqQ1"), t("faqA1")),
+      joinMetadataSentences(t("faqQ2"), t("faqA2")),
+      joinMetadataSentences(t("faqQ3"), t("faqA3")),
     ]),
   };
 }

web/i18n/seo.ts

@@ -145,6 +145,13 @@ export function shortSeoDescriptionCandidate(locale: string) {
   return shortDescriptionSuffixes[locale] ?? shortDescriptionSuffixes.en;
 }
 
+export function joinMetadataSentences(first: string, second: string) {
+  const leading = first.trim();
+  const trailing = second.trim();
+  const separator = /[.!?。！？؟។៕]$/u.test(leading) ? " " : ". ";
+  return `${leading}${separator}${trailing}`;
+}
+
 export function seoDescription(
   locale: string,
   description: string,
@@ -164,9 +171,7 @@ export function seoDescription(
         : shortDescriptionSuffixes;
     const suffix = suffixes[locale] ?? suffixes.en;
     if (!trimmed.includes(suffix)) {
-      const separator =
-        /[。！？.!?]$/.test(trimmed) || trimmed.endsWith("؟") ? " " : ". ";
-      candidates.push(`${trimmed}${separator}${suffix}`);
+      candidates.push(joinMetadataSentences(trimmed, suffix));
     }
   }
 

web/tests/seo.test.ts

@@ -8,6 +8,7 @@ import {
   buildAlternates,
   canonicalUrl,
   hasLocalizedSeoCopy,
+  joinMetadataSentences,
   openGraphDefaults,
   openGraphImageTagline,
   seoDescription,
@@ -66,6 +67,12 @@ describe("SEO metadata helpers", () => {
     expect(seoDescription("en", original)).toBe(original);
   });
 
+  test("joins metadata sentences without duplicating localized punctuation", () => {
+    expect(joinMetadataSentences("សាកល្បង។", "បន្ទាប់")).toBe(
+      "សាកល្បង។ បន្ទាប់",
+    );
+  });
+
   test("preserves overbound authored copy when no complete candidate fits", () => {
     const description = `${"A".repeat(157)}👩🏽‍💻${"B".repeat(20)}`;
     expect(seoDescription("en", description)).toBe(description);