vitepress-linkcard 1.1.2 → 1.1.3

package/README.md

@@ -66,7 +66,7 @@ export default defineConfig({
 
 #### `*.md`
 
-Generates a link card when `@:` appended.
+Generates a linkcard when `@:` appended.
 
 ```md
 [example](@:https://example.com)

package/dist/.cjs.min.js

@@ -1,5 +1,5 @@
 /*!
-  * vitepress-linkcard v1.1.2
+  * vitepress-linkcard v1.1.3
   * (c) 2022 - 2025 luckrya
   * Released under the MIT License.
   */

package/dist/.esm.min.js

@@ -1,5 +1,5 @@
 /*!
-  * vitepress-linkcard v1.1.2
+  * vitepress-linkcard v1.1.3
   * (c) 2022 - 2025 luckrya
   * Released under the MIT License.
   */

package/dist/api.js

@@ -1,4 +1,4 @@
-import { xhr, generateCardDomFragment, parserMetadata } from "./assemble";
+import { xhr, generateCardDomFragment, parserMetadata } from './assemble';
 const cache = new Map();
 /**
  * @param url
@@ -13,18 +13,18 @@ export function generateCard(url, options) {
             if (urlMetadata) {
                 const _options = {
                     linkTitle: options.linkTitle,
-                    target: options.target || "_blank",
-                    classPrefix: options.classPrefix,
+                    target: options.target || '_blank',
+                    classPrefix: options.classPrefix
                 };
                 const card = generateCardDomFragment(urlMetadata, {
                     ..._options,
-                    href: url,
+                    href: url
                 });
                 const response = {
                     url,
                     data: urlMetadata,
                     options: _options,
-                    dom: card,
+                    dom: card
                 };
                 cache.set(url, response);
                 resolve(response);

package/dist/assemble/html.js

@@ -1,4 +1,4 @@
-import { STYLE } from "./style";
+import { STYLE } from './style';
 /**
  * @param data
  * @param options
@@ -11,33 +11,32 @@ export const generateCardDomFragment = (data, options) => {
         href: `href="${options.href}"`,
         title: `title="${options.linkTitle}"`,
         borderColor: `borderColor="${options.borderColor}"`,
-        bgColor: `bgColor="${options.bgColor}"`,
+        bgColor: `bgColor="${options.bgColor}"`
     };
     const inject = (s) => {
         return s;
     };
     const escapeHTML = (str) => str
-        .replace(/&/g, "&")
-        .replace(/&lt;/g, "<")
-        .replace(/&gt;/g, ">")
+        .replace(/&amp;/g, '&')
+        .replace(/&lt;/g, '<')
+        .replace(/&gt;/g, '>')
         .replace(/&quot;/g, '"')
         .replace(/&#039;/g, "'");
-    const style = STYLE(options.borderColor || "#7d7d7dff", options.bgColor || "#7d7d7d00");
-    const url = options.href || "";
-    const domain = new URL(url).origin.replace(/^https?:\/\//, "").replace(/^www\./, "") ||
-        "Unknown domain";
+    const style = STYLE(options.borderColor || '#7d7d7dff', options.bgColor || '#7d7d7d00');
+    const url = options.href || '';
+    const domain = new URL(url).origin.replace(/^https?:\/\//, '').replace(/^www\./, '') || 'Unknown domain';
     let title = data.title;
     let description = data.description;
     // Special handling for gitub.com
-    if (domain == "github.com") {
-        title = data.title?.split(":")[0].replace("GitHub - ", "") || "No title";
+    if (domain == 'github.com') {
+        title = data.title?.split(':')[0].replace('GitHub - ', '') || 'No title';
         description =
-            description?.replace(` - ${title}`, "").replace(`Contribute to ${title} development by creating an account on GitHub.`, // 定型句
-            "") || "";
+            description?.replace(` - ${title}`, '').replace(`Contribute to ${title} development by creating an account on GitHub.`, // 定型句
+            '') || '';
     }
     else {
-        title = data.title || "No title";
-        description = data.description || "";
+        title = data.title || 'No title';
+        description = data.description || '';
     }
     return `<span style="display:block;">
   <a ${aa.rel} ${aa.target} ${aa.href} ${aa.title} ${style.a}>

package/dist/assemble/index.js

@@ -1,4 +1,4 @@
-export * from "./metadata";
-export * from "./html";
-export * from "./parser";
-export * as xhr from "./xhr";
+export * from './metadata';
+export * from './html';
+export * from './parser';
+export * as xhr from './xhr';

package/dist/assemble/local-file-cache.js

@@ -1,14 +1,14 @@
-import { isPureObject } from "@luckrya/utility";
-import fs from "node:fs";
+import { isPureObject } from '@luckrya/utility';
+import fs from 'node:fs';
 const CONFIG_FILE = () => {
     const filePath = `${process.cwd()}/.linkcard_cache.json`;
     if (!fs.existsSync(filePath)) {
         const initialData = {
-            "https://example.com/": {
-                description: "Example Website",
-                logo: "https://example.com/example.png",
-                title: "Example Title",
-            },
+            'https://example.com/': {
+                description: 'Example Website',
+                logo: 'https://example.com/example.png',
+                title: 'Example Title'
+            }
         };
         fs.writeFileSync(filePath, JSON.stringify(initialData, null, 2));
     }
@@ -16,11 +16,11 @@ const CONFIG_FILE = () => {
 };
 const format = () => {
     const filePath = CONFIG_FILE();
-    const content = fs.readFileSync(filePath, "utf-8").trim();
+    const content = fs.readFileSync(filePath, 'utf-8').trim();
     if (!content)
         return;
     const parsed = JSON.parse(content);
-    const formatted = JSON.stringify(parsed, null, 2) + "\n";
+    const formatted = JSON.stringify(parsed, null, 2) + '\n';
     fs.writeFileSync(filePath, formatted);
 };
 export default class LocalFileCache {
@@ -41,7 +41,7 @@ export default class LocalFileCache {
      * @returns
      */
     readFile() {
-        const content = fs.readFileSync(CONFIG_FILE(), "utf-8");
+        const content = fs.readFileSync(CONFIG_FILE(), 'utf-8');
         const data = JSON.parse(content);
         if (isPureObject(data))
             return data;

package/dist/assemble/metadata.js

@@ -1,5 +1,5 @@
-import { parserMetadata, xhr } from ".";
-import LocalFileCache from "./local-file-cache";
+import { parserMetadata, xhr } from '.';
+import LocalFileCache from './local-file-cache';
 const cache = new LocalFileCache();
 /**
  * @param url

package/dist/assemble/parser.js

@@ -1,16 +1,16 @@
 /**
  * TODO: Refactor
  */
-import { isString } from "@luckrya/utility";
-import { cleanPath, extractUrl } from "./url";
-const DEFAULT_LOGO = "https://resources.whatwg.org/logo-url.svg";
+import { isString } from '@luckrya/utility';
+import { cleanPath, extractUrl } from './url';
+const DEFAULT_LOGO = 'https://resources.whatwg.org/logo-url.svg';
 const HtmlTagContentReg = /(<[A-Za-z]+\s*[^>]*>(.*)<\/[A-Za-z]+>)/;
 const ContentAttrValueHtmlMetaTagReg = /content=["|']([^>]*)["|']/;
 const HrefAttrValueHtmlLinkTagReg = /href=["|']([^>]*)["|']/;
 const HtmlTitleTagReg = /(<title\s*[^>]*>(.*)<\/title>)/g;
 // const HtmlMetaTagReg = /<meta\s[^>]*\/?>/g;
 // const HtmlLinkTagReg = /<link\s[^>]*\/?>/g;
-const containArrSelfLosingHtmlTagReg = (attr, tag = "meta") => new RegExp(`<${tag}\\s[^>]*\\w+=['|"]([a-zA-Z]|:|\\s)*${attr}['|"][^>]*\\/?>`);
+const containArrSelfLosingHtmlTagReg = (attr, tag = 'meta') => new RegExp(`<${tag}\\s[^>]*\\w+=['|"]([a-zA-Z]|:|\\s)*${attr}['|"][^>]*\\/?>`);
 /**
  * @param htmlString
  * @returns
@@ -20,7 +20,7 @@ const containArrSelfLosingHtmlTagReg = (attr, tag = "meta") => new RegExp(`<${ta
  */
 function matchTitleByMetaTag(htmlString) {
     let title;
-    const metas = htmlString.match(containArrSelfLosingHtmlTagReg("title"));
+    const metas = htmlString.match(containArrSelfLosingHtmlTagReg('title'));
     if (metas?.length) {
         const content = metas[0].match(ContentAttrValueHtmlMetaTagReg);
         if (content && isString(content[1]))
@@ -43,7 +43,7 @@ function matchTitleByMetaTag(htmlString) {
  */
 function matchDescriptionByMetaTag(htmlString) {
     let description;
-    const metas = htmlString.match(containArrSelfLosingHtmlTagReg("description"));
+    const metas = htmlString.match(containArrSelfLosingHtmlTagReg('description'));
     if (metas?.length) {
         const content = metas[0].match(ContentAttrValueHtmlMetaTagReg);
         if (content && isString(content[1]))
@@ -58,14 +58,14 @@ function matchDescriptionByMetaTag(htmlString) {
  */
 function matchLogoByLinkOrMetaTag(htmlString) {
     let logo;
-    const metas = htmlString.match(containArrSelfLosingHtmlTagReg("image"));
+    const metas = htmlString.match(containArrSelfLosingHtmlTagReg('image'));
     if (metas?.length) {
         const content = metas[0].match(ContentAttrValueHtmlMetaTagReg);
         if (content && isString(content[1]))
             logo = content[1];
     }
     else {
-        const linkHtmlTags = htmlString.match(containArrSelfLosingHtmlTagReg("icon", "link"));
+        const linkHtmlTags = htmlString.match(containArrSelfLosingHtmlTagReg('icon', 'link'));
         if (linkHtmlTags?.length) {
             const content = linkHtmlTags[0].match(HrefAttrValueHtmlLinkTagReg);
             // logo 判断是否是完整地址
@@ -84,14 +84,12 @@ export function parserMetadata(htmlString, url) {
     function absolute(logo) {
         if (!logo)
             return DEFAULT_LOGO;
-        return extractUrl(logo)
-            ? logo
-            : `${extractUrl(url)?.origin}${cleanPath(`/${logo}`)}`; // TODO: no match "content='//img.xx.com/a.png'"
+        return extractUrl(logo) ? logo : `${extractUrl(url)?.origin}${cleanPath(`/${logo}`)}`; // TODO: no match "content='//img.xx.com/a.png'"
     }
     const metadata = {
         title: matchTitleByMetaTag(htmlString),
         description: matchDescriptionByMetaTag(htmlString),
-        logo: absolute(matchLogoByLinkOrMetaTag(htmlString)),
+        logo: absolute(matchLogoByLinkOrMetaTag(htmlString))
     };
     if (isEmptyStringObject(metadata))
         return null;

package/dist/assemble/style.js

@@ -3,7 +3,7 @@
  * @returns
  */
 function hyphenate(str) {
-    return str.replace(/\B([A-Z])/g, "-$1").toLowerCase();
+    return str.replace(/\B([A-Z])/g, '-$1').toLowerCase();
 }
 /**
  * @param style
@@ -16,7 +16,7 @@ function join(style) {
             return `${hyphenate(k)}: ${v};`;
     })
         .filter(Boolean)
-        .join(" ");
+        .join(' ');
 }
 /**
  * @param style
@@ -30,15 +30,15 @@ function inlineStyle(style) {
  * @returns
  */
 const ellipsisStyle = (line) => ({
-    "-webkit-box-orient": "vertical",
-    "-webkit-line-clamp": line,
-    display: "-webkit-box",
-    hyphens: "auto",
+    '-webkit-box-orient': 'vertical',
+    '-webkit-line-clamp': line,
+    display: '-webkit-box',
+    hyphens: 'auto',
     lineClamp: line,
-    overflow: "hidden",
-    overflowWrap: "anywhere",
-    textOverflow: "ellipsis",
-    wordBreak: "break-word",
+    overflow: 'hidden',
+    overflowWrap: 'anywhere',
+    textOverflow: 'ellipsis',
+    wordBreak: 'break-word'
 });
 /**
  See: * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/components/VPFeature.vue
@@ -48,58 +48,58 @@ const ellipsisStyle = (line) => ({
  */
 export const STYLE = (borderColor, bgColor) => ({
     a: inlineStyle({
-        color: "unset !important",
-        display: "block",
-        width: "100%",
-        textDecoration: "none",
+        color: 'unset !important',
+        display: 'block',
+        width: '100%',
+        textDecoration: 'none'
     }),
     container: inlineStyle({
-        display: "flex",
-        alignItems: "center",
-        flexWrap: "wrap",
-        gap: "10px",
-        borderRadius: "12px",
+        display: 'flex',
+        alignItems: 'center',
+        flexWrap: 'wrap',
+        gap: '10px',
+        borderRadius: '12px',
         border: `1px solid ${borderColor}`,
         backgroundColor: bgColor,
-        boxSizing: "border-box",
-        width: "100%",
-        height: "130px",
+        boxSizing: 'border-box',
+        width: '100%',
+        height: '130px'
     }),
     img: inlineStyle({
-        borderRadius: "0px 12px 12px 0px",
-        maxWidth: "40%",
-        height: "128px", // container.height - 2px
+        borderRadius: '0px 12px 12px 0px',
+        maxWidth: '40%',
+        height: '128px', // container.height - 2px
         flexShrink: 0,
-        objectFit: "contain",
-        overflow: "hidden",
+        objectFit: 'contain',
+        overflow: 'hidden'
     }),
     texts: inlineStyle({
-        flex: "1 1 0%",
-        minWidth: "0", // ellipsisを有効にするために必要
+        flex: '1 1 0%',
+        minWidth: '0' // ellipsisを有効にするために必要
     }),
     title: inlineStyle({
         ...ellipsisStyle(2),
         opacity: 1,
-        fontSize: "16px",
-        lineHeight: "22px",
-        margin: "0 16px 8px 16px",
-        fontWeight: "bold",
+        fontSize: '16px',
+        lineHeight: '22px',
+        margin: '0 16px 8px 16px',
+        fontWeight: 'bold'
     }),
     domain: inlineStyle({
         ...ellipsisStyle(1),
         opacity: 1,
-        fontSize: "12px",
-        lineHeight: "16px",
-        margin: "8px 16px 8px 16px",
-        textDecoration: "underline",
+        fontSize: '12px',
+        lineHeight: '16px',
+        margin: '8px 16px 8px 16px',
+        textDecoration: 'underline'
     }),
     description: inlineStyle({
         ...ellipsisStyle(2),
         opacity: 0.8,
-        fontSize: "12px",
-        lineHeight: "16px",
-        margin: "8px 16px 0px 16px",
-    }),
+        fontSize: '12px',
+        lineHeight: '16px',
+        margin: '8px 16px 0px 16px'
+    })
 });
 /**
  * @param prefix
@@ -111,5 +111,5 @@ export const classNames = (prefix) => ({
     texts: `${prefix}__texts`,
     title: `${prefix}__texts--title`,
     domain: `${prefix}__texts--domain`,
-    description: `${prefix}__texts--desc`,
+    description: `${prefix}__texts--desc`
 });

package/dist/assemble/url.js

@@ -10,5 +10,5 @@ export function extractUrl(url) {
  * @returns
  */
 export function cleanPath(path) {
-    return path.replace(/\/\//g, "/");
+    return path.replace(/\/\//g, '/');
 }

package/dist/assemble/xhr.js

@@ -1,7 +1,7 @@
 // Refactor: xmlhttprequest will be replaced later
 // @ts-expect-error: xmlhttprequest has no types
-import xhrForNode from "xmlhttprequest";
-import { inBrowser, isString } from "@luckrya/utility";
+import xhrForNode from 'xmlhttprequest';
+import { inBrowser, isString } from '@luckrya/utility';
 // TODO: Local File Cache
 const cache = new Map();
 const XHR = inBrowser ? window.XMLHttpRequest : xhrForNode.XMLHttpRequest;
@@ -15,8 +15,8 @@ export function sync(url) {
     let result;
     try {
         const xhr = new XHR();
-        xhr.open("GET", url, false);
-        xhr.setRequestHeader("Content-Type", "text/html");
+        xhr.open('GET', url, false);
+        xhr.setRequestHeader('Content-Type', 'text/html');
         xhr.send();
         if (xhr.status === 200 && !!xhr.responseText) {
             result = xhr.responseText;
@@ -24,9 +24,7 @@ export function sync(url) {
         }
     }
     catch (err) {
-        console.error(`【XHR Error】：${err instanceof Error
-            ? err.message
-            : "get remote URL resource exception!"}`);
+        console.error(`【XHR Error】：${err instanceof Error ? err.message : 'get remote URL resource exception!'}`);
     }
     return result;
 }
@@ -40,12 +38,10 @@ export function async(url) {
             if (cache.has(url))
                 return resolve(cache.get(url));
             const xhr = new XHR();
-            xhr.open("GET", url, false);
-            xhr.setRequestHeader("Content-Type", "text/html");
+            xhr.open('GET', url, false);
+            xhr.setRequestHeader('Content-Type', 'text/html');
             xhr.onreadystatechange = function () {
-                if (xhr.readyState === 4 &&
-                    xhr.status === 200 &&
-                    isString(xhr.responseText)) {
+                if (xhr.readyState === 4 && xhr.status === 200 && isString(xhr.responseText)) {
                     cache.set(url, xhr.responseText);
                     resolve(xhr.responseText);
                 }

package/dist/index.js

@@ -1,3 +1,3 @@
-export * from "./api";
-export * from "./link-to-card-plugin";
-export * from "./types";
+export * from './api';
+export * from './link-to-card-plugin';
+export * from './types';

package/dist/link-to-card-plugin.js

@@ -1,16 +1,16 @@
-import { isFunction } from "@luckrya/utility";
-import { getUrlMetadata, generateCardDomFragment } from "./assemble";
+import { isFunction } from '@luckrya/utility';
+import { getUrlMetadata, generateCardDomFragment } from './assemble';
 /**
  * @param md
  * @param pluginOptions
  */
 export const linkToCardPlugin = (md, pluginOptions = {}) => {
     function parseCardLinkHref(href) {
-        const tagRegexp = new RegExp(`^(${"@"}:)([a-zA-Z0-9]+.*)`);
+        const tagRegexp = new RegExp(`^(${'@'}:)([a-zA-Z0-9]+.*)`);
         const match = href?.match(tagRegexp);
         return {
             isCardLink: !!match,
-            url: match?.[2],
+            url: match?.[2]
         };
     }
     /**
@@ -24,10 +24,10 @@ export const linkToCardPlugin = (md, pluginOptions = {}) => {
             const cardDomOptions = {
                 href: options.url,
                 linkTitle: joinLinkTitle(options.tokens),
-                target: pluginOptions.target || "_blank",
+                target: pluginOptions.target || '_blank',
                 classPrefix: pluginOptions.classPrefix,
                 borderColor: pluginOptions.borderColor,
-                bgColor: pluginOptions.bgColor,
+                bgColor: pluginOptions.bgColor
             };
             return isFunction(pluginOptions.render)
                 ? pluginOptions.render(urlMetadata, cardDomOptions)
@@ -42,12 +42,12 @@ export const linkToCardPlugin = (md, pluginOptions = {}) => {
      * @returns
      */
     md.renderer.renderInline = (tokens, rootOptions, env) => {
-        let result = "";
+        let result = '';
         for (let i = 0; i < tokens.length; i++) {
             const currentToken = tokens[i];
             const ruleFunction = md.renderer.rules[currentToken.type];
             if (currentToken.hidden) {
-                result += "";
+                result += '';
             }
             else if (isFunction(ruleFunction)) {
                 result += ruleFunction(tokens, i, rootOptions, env, md.renderer);
@@ -69,8 +69,8 @@ export const linkToCardPlugin = (md, pluginOptions = {}) => {
      */
     md.renderer.rules.link_open = (tokens, i, rootOptions, env, self) => {
         const token = tokens[i];
-        const isLinkOpenToken = token.tag === "a" && token.type === "link_open";
-        const href = token.attrs?.filter((attr) => attr.includes("href"))[0]?.[1];
+        const isLinkOpenToken = token.tag === 'a' && token.type === 'link_open';
+        const href = token.attrs?.filter((attr) => attr.includes('href'))[0]?.[1];
         const { url, isCardLink } = parseCardLinkHref(href);
         if (isLinkOpenToken && isCardLink && url) {
             const card = assembleCardTpl({ url, tokens, i });
@@ -100,8 +100,8 @@ function joinLinkTitle(tokens) {
         .map(({ hidden, content }) => {
         if (hidden)
             return content;
-        return "";
+        return '';
     })
         .filter(Boolean)
-        .join("");
+        .join('');
 }

package/package.json

@@ -69,11 +69,11 @@
     "clean": "rm -rf dist types",
     "dev": "rollup -c -w",
     "docs": "yarn typedoc",
-    "format": "yarn prettier --write src/**/* && rm -rf node_modules",
+    "format": "yarn prettier --config .vscode/.prettierrc.json --write .config/*.json .github .vscode src *.json && rm -rf node_modules",
     "lint": "yarn eslint --config .vscode/eslint.config.ts src/**/*",
     "type:dts": "tsc --emitDeclarationOnly"
   },
   "type": "module",
   "types": "./types/index.d.ts",
-  "version": "1.1.2"
+  "version": "1.1.3"
 }

package/types/api.d.ts

@@ -1,8 +1,8 @@
-import type { UrlMetadata, CardDomRenderOptions } from "./types";
+import type { UrlMetadata, CardDomRenderOptions } from './types';
 interface CardResponse {
     url: string;
     data: UrlMetadata;
-    options: Omit<CardDomRenderOptions, "href">;
+    options: Omit<CardDomRenderOptions, 'href'>;
     dom: string;
 }
 /**
@@ -10,5 +10,5 @@ interface CardResponse {
  * @param options
  * @returns
  */
-export declare function generateCard(url: string, options: Omit<CardDomRenderOptions, "href">): Promise<CardResponse>;
+export declare function generateCard(url: string, options: Omit<CardDomRenderOptions, 'href'>): Promise<CardResponse>;
 export {};

package/types/assemble/html.d.ts

@@ -1,4 +1,4 @@
-import type { CardDomRender } from "../types";
+import type { CardDomRender } from '../types';
 /**
  * @param data
  * @param options

package/types/assemble/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./metadata";
-export * from "./html";
-export * from "./parser";
-export * as xhr from "./xhr";
+export * from './metadata';
+export * from './html';
+export * from './parser';
+export * as xhr from './xhr';

package/types/assemble/metadata.d.ts

@@ -1,4 +1,4 @@
-import type { UrlMetadata } from "../types";
+import type { UrlMetadata } from '../types';
 /**
  * @param url
  * @returns

package/types/assemble/parser.d.ts

@@ -1,7 +1,7 @@
 /**
  * TODO: Refactor
  */
-import type { UrlMetadata } from "../types";
+import type { UrlMetadata } from '../types';
 /**
  * @param htmlString
  * @param url

package/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./api";
-export * from "./link-to-card-plugin";
-export * from "./types";
+export * from './api';
+export * from './link-to-card-plugin';
+export * from './types';

package/types/link-to-card-plugin.d.ts

@@ -1,4 +1,4 @@
-import type { LinkToCardPlugin } from "./types";
+import type { LinkToCardPlugin } from './types';
 /**
  * @param md
  * @param pluginOptions

package/types/types.d.ts

@@ -1,4 +1,4 @@
-import type MarkdownIt from "markdown-it";
+import type MarkdownIt from 'markdown-it';
 export type LinkToCardPlugin = MarkdownIt.PluginWithOptions<LinkToCardPluginOptions>;
 export interface LinkToCardPluginOptions {
     target?: ATarget;
@@ -13,7 +13,7 @@ export interface UrlMetadata {
     logo?: string;
     [key: string]: unknown;
 }
-export type ATarget = "_self" | "_blank" | "_top" | "_parent";
+export type ATarget = '_self' | '_blank' | '_top' | '_parent';
 export interface CardDomRenderOptions {
     href: string;
     linkTitle: string;