rehype-og-card 2.0.2 → 3.0.1

package/README.md

@@ -63,7 +63,7 @@ Output (formatted for readability):
 ```html
 <p>this is a link: https://blog.google/products/android/world-emoji-day-2024/</p>
 <p><code>https://blog.google/products/android/world-emoji-day-2024/</code></p>
-<p><div class="og-card-container">
+<div class="og-card-container">
     <a href="https://blog.google/products/android/world-emoji-day-2024/">
         <div class="og-card-info">
             <div class="og-card-title">10 fun facts about emoji for World Emoji Day</div>
@@ -77,7 +77,7 @@ Output (formatted for readability):
             <img class="og-card-image" alt="https://storage.googleapis.com/gweb-uniblog-publish-prod/images/world_emoji_day_v2_1.width-1300.png" decoding="async" loading="lazy" src="https://storage.googleapis.com/gweb-uniblog-publish-prod/images/world_emoji_day_v2_1.width-1300.png">
         </div>
     </a>
-</div></p>
+</div>
 <p><a href="https://blog.google/products/android/world-emoji-day-2024/">https://blog.google/products/android/world-emoji-day-2024/</a></p>
 <p><a href="https://blog.google/products/android/world-emoji-day-2024/">Google blog</a></p>
 ```
@@ -165,6 +165,13 @@ Whether to open the link in a new tab.
 - Type: `boolean`
 - Default: `false`
 
+### `removeParentPTag`
+
+Whether to remove the parent `<p>` tag that contains only the bare link.
+
+- Type: `boolean`
+- Default: `true`
+
 ### `serverCache`
 
 Whether to cache the OG data on the server.

package/dist/index.js

@@ -19,6 +19,7 @@ const DEFAULT_OPTIONS = {
     excludeDomains: [],
     loading: "lazy",
     openInNewTab: false,
+    removeParentPTag: true,
     serverCache: true,
     serverCacheMaxAge: DEFAULT_CACHE_MAX_AGE_MS,
     serverCachePath: "./public",
@@ -94,7 +95,7 @@ const rehypeOGCard = (options) => {
             const targetURL = new URL(anchorNode.properties.href);
             if (mergedOptions.excludeDomains.includes(targetURL.hostname))
                 return;
-            // eslint-disable-next-line jsdoc/require-jsdoc, max-statements, max-lines-per-function
+            // eslint-disable-next-line jsdoc/require-jsdoc, max-statements, max-lines-per-function, complexity
             const linkCardPromise = async () => {
                 let OGData = mergedOptions.buildCache
                     ? await restoreOGDataBuildCache(anchorNode.properties.href, mergedOptions.buildCachePath, mergedOptions.buildCacheMaxAge)
@@ -144,12 +145,18 @@ const rehypeOGCard = (options) => {
                     OGData.displayURL = shortenedURL.hostname;
                 }
                 const OGCard = createOGCard(OGData, mergedOptions);
-                const index = parent.children.indexOf(node);
+                const { removeParentPTag: shouldRemoveParentPTag } = mergedOptions;
+                // eslint-disable-next-line no-magic-numbers
+                const replacementContainer = shouldRemoveParentPTag ? ancestors[ancestors.length - 2] : parent;
+                const replacementTarget = shouldRemoveParentPTag ? parent : node;
+                if (!replacementContainer || !("children" in replacementContainer))
+                    return;
+                const index = replacementContainer.children.indexOf(replacementTarget);
                 // eslint-disable-next-line no-magic-numbers
                 if (index === -1)
                     return;
                 // eslint-disable-next-line no-magic-numbers
-                parent.children.splice(index, 1, OGCard);
+                replacementContainer.children.splice(index, 1, OGCard);
             };
             linkCardPromises.push(linkCardPromise());
         });

package/dist/types.d.ts

@@ -23,6 +23,11 @@ interface RehypeOGCardOptions {
      * @default false
      */
     openInNewTab?: boolean;
+    /**
+     * Whether to remove the parent `<p>` tag that contains only the bare link.
+     * @default true
+     */
+    removeParentPTag?: boolean;
     /**
      * Whether to enable converting the links
      * that have the same URL and text (e.g., `[https://example.com](https://example.com)`).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rehype-og-card",
-  "version": "2.0.2",
+  "version": "3.0.1",
   "description": "Rehype plugin to convert text links to link cards",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",