astro-link-card 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 roboin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,100 @@
+# astro-link-card
+
+Astro integration to automatically convert bare links into link cards. This is a wrapper for [rehype-og-card](https://github.com/Robot-Inventor/rehype-og-card) with some configuration optimizations for Astro.
+
+## Features
+
+This integration will automatically convert bare links into link cards. This is useful for creating a more visually appealing website with link previews. Here are some key features:
+
+- Automatically convert bare links into link cards
+- Server-side image caching
+- Build cache for images and Open Graph metadata for faster builds
+- Lazy loading and async decoding for images
+- Zero runtime JavaScript (all processing is done at build time)
+
+The following links will be converted to link cards:
+
+- Bare links
+- Links that have the same URL and text (if you enable the `enableSameTextURLConversion` option)
+
+The following links will NOT be converted to link cards:
+
+- Links in lists
+- Links in code blocks
+- Links in sentences
+- Non-bare links
+- Links that have the same URL and text (if you disable the enableSameTextURLConversion option)
+
+Input:
+
+```markdown
+this is a link: https://blog.google/products/android/world-emoji-day-2024/
+
+\`https://blog.google/products/android/world-emoji-day-2024/\`
+
+https://blog.google/products/android/world-emoji-day-2024/
+```
+
+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">
+    <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>
+            <div class="og-card-description">Celebrate World Emoji Day with Google, and check out what’s new for Emoji Kitchen.</div>
+            <div class="og-card-url-container">
+                <img class="og-card-favicon" alt="favicon" decoding="async" height="16" loading="lazy" src="https://www.google.com/s2/favicons?domain=blog.google" width="16">
+                <span class="og-card-url">blog.google</span>
+            </div>
+        </div>
+        <div class="og-card-image-container">
+            <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>
+```
+
+## Installation
+
+### `astro add` command (Recommended)
+
+```bash
+npx astro add astro-link-card
+```
+
+### Manual Installation (Alternative)
+
+```bash
+npm install astro-link-card
+```
+
+```typescript
+import { defineConfig } from "astro";
+import linkCard from "astro-link-card";
+
+// https://astro.build/config
+export default defineConfig({
+    // ... other config
+    integrations: [
+        [
+            linkCard,
+            {
+                // Options
+            }
+        ]
+    ]
+});
+```
+
+## Options
+
+All rehype-og-card options are supported. You can find the full list of options [here](https://github.com/Robot-Inventor/rehype-og-card?tab=readme-ov-file#options). Some options below are optimized for Astro:
+
+- `enableSameTextURLConversion` (default: `true`): Enable conversion of links that have the same URL and text. This is useful for projects that have `markdown.gfm` enabled.
+- `serverCache` (default: `true`): Enable server-side image caching.
+- `serverCachePath` (default: `config.publicDir`): Path to store server-side image cache.
+- `buildCache` (default: `true`): Enable build cache for images and Open Graph metadata.
+- `buildCachePath` (default: `config.cacheDir`): Path to store build cache.

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { RehypeOGCardOptions } from "rehype-og-card";
+import type { AstroIntegration } from "astro";
+/**
+ * Astro integration to automatically convert bare links into link cards.
+ * This is a wrapper for [rehype-og-card](https://github.com/Robot-Inventor/rehype-og-card)
+ * with some configuration optimizations for Astro.
+ * @param options Options for the rehype-og-card plugin.
+ * @returns Astro integration object.
+ */
+declare const astroLinkCard: (options?: RehypeOGCardOptions) => AstroIntegration;
+export default astroLinkCard;
+export { RehypeOGCardOptions as AstroLinkCardOptions };

package/dist/index.js

@@ -0,0 +1,36 @@
+import rehypeOGCard from "rehype-og-card";
+/**
+ * Astro integration to automatically convert bare links into link cards.
+ * This is a wrapper for [rehype-og-card](https://github.com/Robot-Inventor/rehype-og-card)
+ * with some configuration optimizations for Astro.
+ * @param options Options for the rehype-og-card plugin.
+ * @returns Astro integration object.
+ */
+const astroLinkCard = (options) => {
+    const integration = {
+        hooks: {
+            // eslint-disable-next-line jsdoc/require-jsdoc
+            "astro:config:setup": ({ config, updateConfig }) => {
+                const defaultOptions = {
+                    buildCache: true,
+                    buildCachePath: config.cacheDir.pathname,
+                    enableSameTextURLConversion: true,
+                    serverCache: true,
+                    serverCachePath: config.publicDir.pathname
+                };
+                const mergedOptions = {
+                    ...defaultOptions,
+                    ...options
+                };
+                updateConfig({
+                    markdown: {
+                        rehypePlugins: [[rehypeOGCard, mergedOptions]]
+                    }
+                });
+            }
+        },
+        name: "astro-link-card"
+    };
+    return integration;
+};
+export default astroLinkCard;

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "astro-link-card",
+  "version": "0.1.0",
+  "description": "Astro integration to automatically convert bare links into link cards.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist/"
+  ],
+  "type": "module",
+  "publishConfig": {
+    "provenance": true
+  },
+  "scripts": {
+    "build": "npx tsc",
+    "format": "npx prettier --write ./src/",
+    "format:check": "npx prettier --check ./src/",
+    "lint": "npx eslint ./src/**/*.ts",
+    "version": "npm run build && git add .",
+    "ci:version": "changeset version && npm run version",
+    "ci:publish": "npm run build && changeset publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Robot-Inventor/astro-link-card.git"
+  },
+  "keywords": [
+    "astro",
+    "rehype",
+    "rehype-plugin",
+    "astro-integration"
+  ],
+  "author": "Robot-Inventor",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Robot-Inventor/astro-link-card/issues"
+  },
+  "homepage": "https://github.com/Robot-Inventor/astro-link-card#readme",
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.7",
+    "@robot-inventor/eslint-config": "^0.2.26",
+    "eslint": "^9.8.0",
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4"
+  },
+  "dependencies": {
+    "astro": "^4.12.3",
+    "rehype-og-card": "^0.4.3"
+  }
+}