@quartz-community/og-image 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.1.0
+
+### Minor Changes
+
+- 5352988: Add a `useGeneratedDescription` option (default `true`). Set it to `false` to show `defaultDescription` on pages without a frontmatter description, instead of the excerpt the description plugin generates (jackyzha0/quartz#2470). An empty generated description now also falls back to `defaultDescription`.
+
 ## 1.0.0
 
 ### Major Changes

package/dist/index.d.ts

@@ -36,7 +36,14 @@ type SocialImageOptions = {
     width: number;
     excludeRoot: boolean;
     defaultTitle?: string;
+    /** Shown when a page has no description of its own (see `useGeneratedDescription`). */
     defaultDescription?: string;
+    /**
+     * Use the description another plugin generated for the page (the description plugin's
+     * excerpt of its content) when the frontmatter has none. `false` skips it, so pages without
+     * a frontmatter `socialDescription` or `description` show `defaultDescription`. Default `true`.
+     */
+    useGeneratedDescription?: boolean;
     readingTimeText?: (minutes: number) => string;
     imageStructure: (options: ImageOptions & {
         userOpts: UserOpts;

package/dist/index.js

@@ -24339,6 +24339,7 @@ var defaultOptions = {
   excludeRoot: false,
   defaultTitle: "Untitled",
   defaultDescription: "No description provided",
+  useGeneratedDescription: true,
   readingTimeText: (minutes) => `${minutes} min read`
 };
 async function generateSocialImage({ cfg, description, fonts, title, fileData }, userOpts) {
@@ -24373,13 +24374,19 @@ async function generateSocialImage({ cfg, description, fonts, title, fileData },
   });
   return sharp(Buffer.from(svg)).webp({ quality: 40 });
 }
+function resolveDescription(fileData, opts) {
+  const own2 = fileData.frontmatter?.socialDescription ?? fileData.frontmatter?.description;
+  if (own2 != null) return own2;
+  const generated = opts.useGeneratedDescription === false ? void 0 : fileData.description;
+  return unescapeHTML(generated?.trim() || opts.defaultDescription || "");
+}
 async function processOgImage(ctx, fileData, fonts, fullOptions) {
   const cfg = ctx.cfg.configuration;
   const slug2 = fileData.slug;
   const titleSuffix = cfg.pageTitleSuffix ?? "";
   const frontmatter = fileData.frontmatter;
   const title = (frontmatter?.title ?? fullOptions.defaultTitle ?? "") + titleSuffix;
-  const description = frontmatter?.socialDescription ?? frontmatter?.description ?? unescapeHTML(fileData.description?.trim() ?? fullOptions.defaultDescription ?? "");
+  const description = resolveDescription(fileData, fullOptions);
   const stream = await generateSocialImage(
     {
       title,