vitepress-plugin-toolkit 0.1.0

package/dist/node/index.js

@@ -0,0 +1,446 @@
+import container from "markdown-it-container";
+import { camelCase, deepMerge, isBoolean, isNull, isNumber, isString, isUndefined, kebabCase, objectEntries, objectKeys, slash } from "@pengzhanbo/utils";
+import ansis from "ansis";
+import process from "node:process";
+//#region src/shared/link.ts
+const EXTERNAL_URL_RE = /^(?:[a-z]+:|\/\/)/i;
+function isExternal(path) {
+	return EXTERNAL_URL_RE.test(path);
+}
+const URL_PROTOCOL_RE = /^[a-z][a-z0-9+.-]*:/;
+function isLinkWithProtocol(link) {
+	return URL_PROTOCOL_RE.test(link) || link.startsWith("//");
+}
+//#endregion
+//#region src/node/utils/resolve-attrs.ts
+/**
+* Regular expression for matching attribute values
+*
+* 匹配属性值的正则表达式
+*/
+const RE_ATTR_VALUE = /(?:^|\s+)(?<attr>[\w-]+)(?:=(?<quote>['"])(?<valueWithQuote>.+?)\k<quote>|=(?<valueWithoutQuote>\S+))?(?:\s+|$)/;
+/**
+* Resolve attribute string to object
+*
+* 将属性字符串解析为对象
+*
+* @param info - Attribute string / 属性字符串
+* @returns Object with attrs and rawAttrs / 包含 attrs 和 rawAttrs 的对象
+* @typeParam T - Attribute type / 属性类型
+*/
+function resolveAttrs(info) {
+	info = info.trim();
+	if (!info) return {};
+	const attrs = {};
+	let matched;
+	while (matched = info.match(RE_ATTR_VALUE)) {
+		const { attr, valueWithQuote, valueWithoutQuote } = matched.groups;
+		const value = valueWithQuote || valueWithoutQuote || true;
+		let v = isString(value) ? value.trim() : value;
+		if (v === "true") v = true;
+		else if (v === "false") v = false;
+		else if (v === "\"\"" || v === "''") v = "";
+		attrs[camelCase(attr)] = v;
+		info = info.slice(matched[0].length);
+	}
+	return attrs;
+}
+/**
+* Resolve single attribute value from info string
+*
+* 从信息字符串中解析单个属性值
+*
+* @param info - Info string / 信息字符串
+* @param key - Attribute key / 属性键
+* @returns Attribute value or undefined / 属性值或 undefined
+*/
+function resolveAttr(info, key) {
+	const pattern = new RegExp(`(?:^|\\s+)${key}(?:=(?<quote>['"])(?<valueWithQuote>.+?)\\k<quote>|=(?<valueWithoutQuote>\\S+))?(?:\\s+|$)`);
+	const groups = info.match(pattern)?.groups;
+	return groups?.valueWithQuote || groups?.valueWithoutQuote;
+}
+//#endregion
+//#region src/node/markdown/container.ts
+/**
+* Create markdown-it custom container plugin
+*
+* 创建 markdown-it 的自定义容器插件
+*
+* @param md - Markdown-it instance / Markdown-it 实例
+* @param type - Container type (e.g., 'tip', 'warning') / 容器类型（如 'tip', 'warning' 等）
+* @param options - Optional before/after render hooks / 可选的 before/after 渲染钩子
+* @param options.before - Callback for rendering container opening tag / 渲染容器起始标签时的回调函数
+* @param options.after - Callback for rendering container closing tag / 渲染容器结束标签时的回调函数
+*/
+function createContainerPlugin(md, type, { before, after } = {}) {
+	const render = (tokens, index, options, env) => {
+		const token = tokens[index];
+		const info = token.info.trim().slice(type.length).trim() || "";
+		if (token.nesting === 1) return before?.(info, tokens, index, options, env) ?? `<div class="custom-container ${type}">`;
+		else return after?.(info, tokens, index, options, env) ?? "</div>";
+	};
+	md.use(container, type, { render });
+}
+/**
+* Create a custom container rule where content is not processed by markdown-it
+* Requires custom content processing logic
+* ```md
+* ::: type
+*  xxxx    <-- content: this part will not be processed by markdown-it
+* :::
+* ```
+*
+* @example
+* ```ts
+* const example = createContainerSyntaxPlugin(md, 'example', (tokens, index, options, env) => {
+*   const { content, meta } = tokens[index]
+*   return `<div class="example">${meta.title} | ${content}</div>`
+* })
+* ```
+*
+* @param md - Markdown-it instance / Markdown-it 实例
+* @param type - Container type / 容器类型
+* @param render - Custom render rule / 自定义渲染规则
+*/
+function createContainerSyntaxPlugin(md, type, render) {
+	const maker = ":";
+	const markerMinLen = 3;
+	/**
+	* Custom container block rule definition
+	*
+	* 自定义容器的 block 规则定义
+	*
+	* @param state - Current block state / 当前 block 状态
+	* @param startLine - Start line / 起始行
+	* @param endLine - End line / 结束行
+	* @param silent - Silent mode / 是否为静默模式
+	* @returns Whether matched / 是否匹配到自定义容器
+	*/
+	function defineContainer(state, startLine, endLine, silent) {
+		const start = state.bMarks[startLine] + state.tShift[startLine];
+		const max = state.eMarks[startLine];
+		let pos = start;
+		if (state.src[pos] !== maker) return false;
+		for (pos = start + 1; pos <= max; pos++) if (state.src[pos] !== maker) break;
+		if (pos - start < markerMinLen) return false;
+		const markup = state.src.slice(start, pos);
+		const info = state.src.slice(pos, max).trim();
+		if (!info.startsWith(type)) return false;
+		/* istanbul ignore if -- @preserve */
+		if (silent) return true;
+		let line = startLine;
+		let content = "";
+		while (++line < endLine) {
+			if (state.src.slice(state.bMarks[line], state.eMarks[line]).trim() === markup) break;
+			content += `${state.src.slice(state.bMarks[line], state.eMarks[line])}\n`;
+		}
+		const token = state.push(`${type}_container`, "", 0);
+		token.meta = resolveAttrs(info.slice(type.length));
+		token.content = content;
+		token.markup = `${markup} ${type}`;
+		token.map = [startLine, line + 1];
+		state.line = line + 1;
+		return true;
+	}
+	const defaultRender = (tokens, index) => {
+		const { content } = tokens[index];
+		return `<div class="custom-container ${type}">${content}</div>`;
+	};
+	md.block.ruler.before("fence", `${type}_definition`, defineContainer);
+	md.renderer.rules[`${type}_container`] = render ?? defaultRender;
+}
+//#endregion
+//#region src/node/markdown/embed.ts
+/**
+* Create embed rule block
+*
+* 创建嵌入规则块
+*
+* Syntax: \@\[name]()
+*
+* 语法：\@\[name]()
+*
+* @param md - Markdown instance / Markdown 实例
+* @param {EmbedRuleBlockOptions} options - Embed rule block options / 嵌入规则块选项
+* @typeParam Meta - Metadata type / 元数据类型
+*/
+function createEmbedRuleBlock(md, { type, name = type, syntaxPattern, beforeName = "code", ruleOptions = { alt: [
+	"paragraph",
+	"reference",
+	"blockquote",
+	"list"
+] }, meta, content }) {
+	const MIN_LENGTH = type.length + 5;
+	const START_CODES = [
+		64,
+		91,
+		...type.split("").map((c) => c.charCodeAt(0))
+	];
+	md.block.ruler.before(beforeName, name, (state, startLine, endLine, silent) => {
+		const pos = state.bMarks[startLine] + state.tShift[startLine];
+		const max = state.eMarks[startLine];
+		if (pos + MIN_LENGTH > max) return false;
+		for (let i = 0; i < START_CODES.length; i += 1) if (state.src.charCodeAt(pos + i) !== START_CODES[i]) return false;
+		const content = state.src.slice(pos, max);
+		const match = content.match(syntaxPattern);
+		if (!match) return false;
+		/* istanbul ignore if -- @preserve */
+		if (silent) return true;
+		const token = state.push(name, "", 0);
+		token.meta = meta(match);
+		token.content = content;
+		token.map = [startLine, startLine + 1];
+		state.line = startLine + 1;
+		return true;
+	}, ruleOptions);
+	md.renderer.rules[name] = (tokens, index, _, env) => {
+		const token = tokens[index];
+		token.content = content(token.meta, token.content, env);
+		return token.content;
+	};
+}
+//#endregion
+//#region src/node/utils/constants.ts
+/**
+* 支持的视频文件名扩展名
+*/
+const EXTENSION_VIDEOS = [
+	"mp4",
+	"mp3",
+	"webm",
+	"ogg",
+	"mpd",
+	"dash",
+	"m3u8",
+	"hls",
+	"ts",
+	"flv",
+	"mkv",
+	"mov",
+	"ogv"
+];
+/**
+* 支持的图片文件名扩展名
+*/
+const EXTENSION_IMAGES = [
+	"jpg",
+	"jpeg",
+	"png",
+	"gif",
+	"avif",
+	"webp",
+	"svg",
+	"bmp",
+	"ico",
+	"tiff",
+	"apng",
+	"jfif",
+	"pjpeg",
+	"pjp",
+	"xbm"
+];
+/**
+* 支持的音频文件名扩展名
+*/
+const EXTENSION_AUDIOS = [
+	"mp3",
+	"flac",
+	"wav",
+	"ogg",
+	"opus",
+	"webm",
+	"acc"
+];
+//#endregion
+//#region src/node/utils/logger.ts
+/**
+* Log levels mapping
+*
+* 日志级别映射
+*/
+const logLevels = {
+	silent: 0,
+	error: 1,
+	warn: 2,
+	info: 3,
+	debug: 4
+};
+/**
+* Create logger instance
+*
+* 创建日志实例
+*
+* @param prefix - Log prefix / 日志前缀
+* @param defaultLevel - Default log level / 默认日志级别
+* @returns Logger instance / 日志实例
+*/
+function createLogger(prefix, defaultLevel = "info") {
+	prefix = `[${prefix}]`;
+	/**
+	* Output log
+	*
+	* 输出日志
+	*/
+	function output(type, msg, level) {
+		level = isBoolean(level) ? level ? defaultLevel : "error" : level;
+		if (logLevels[level] >= logLevels[type]) {
+			const method = type === "info" || type === "debug" ? "log" : type;
+			const tag = type === "debug" ? ansis.magenta.bold(prefix) : type === "info" ? ansis.cyan.bold(prefix) : type === "warn" ? ansis.yellow.bold(prefix) : ansis.red.bold(prefix);
+			const format = `${ansis.dim((/* @__PURE__ */ new Date()).toLocaleTimeString())} ${tag} ${msg}`;
+			console[method](format);
+		}
+	}
+	return {
+		debug(msg, level = defaultLevel) {
+			output("debug", msg, level);
+		},
+		info(msg, level = defaultLevel) {
+			output("info", msg, level);
+		},
+		warn(msg, level = defaultLevel) {
+			output("warn", msg, level);
+		},
+		error(msg, level = defaultLevel) {
+			output("error", msg, level);
+		}
+	};
+}
+//#endregion
+//#region src/node/utils/parseRect.ts
+/**
+* Parse rect size string, add unit if it's a number
+*
+* 解析矩形尺寸字符串，如果是数字则添加单位
+*
+* @param str - Size string / 尺寸字符串
+* @param unit - Unit to append (default: 'px') / 要添加的单位（默认：'px'）
+* @returns Size string with unit / 带单位的尺寸字符串
+*/
+function parseRect(str, unit = "px") {
+	if (Number.parseFloat(str) === Number(str)) return `${str}${unit}`;
+	return str;
+}
+//#endregion
+//#region src/node/utils/slugify.ts
+const rControl = /[\u0000-\u001F]/g;
+const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
+const rCombining = /[\u0300-\u036F]/g;
+/**
+* Default slugification function
+*/
+function slugify(str) {
+	return str.normalize("NFKD").replace(rCombining, "").replace(rControl, "").replace(rSpecial, "-").replace(/-{2,}/g, "-").replace(/^-+|-+$/g, "").replace(/^(\d)/, "_$1").toLowerCase();
+}
+//#endregion
+//#region src/node/utils/stringify-attrs.ts
+/**
+* Stringify attributes object to HTML attribute string
+*
+* 将属性对象字符串化为 HTML 属性字符串
+*
+* @param attrs - Attributes object / 属性对象
+* @param withUndefinedOrNull - Whether to include undefined/null values / 是否包含 undefined/null 值
+* @param forceStringify - Keys to force stringify / 强制字符串化的键
+* @returns HTML attribute string / HTML 属性字符串
+* @typeParam T - Attribute type / 属性类型
+*/
+function stringifyAttrs(attrs, withUndefinedOrNull = false, forceStringify = []) {
+	const result = objectEntries(attrs).map(([key, value]) => {
+		const k = kebabCase(key);
+		if (isUndefined(value) || value === "undefined") return withUndefinedOrNull ? `:${k}="undefined"` : "";
+		if (isNull(value) || value === "null") return withUndefinedOrNull ? `:${k}="null"` : "";
+		if (value === "true") value = true;
+		if (value === "false") value = false;
+		if (isBoolean(value)) return value ? `${k}` : "";
+		if (isNumber(value)) return `:${k}="${value}"`;
+		if (isString(value) && (value[0] === "{" || value[0] === "[")) {
+			const v = value.replaceAll("\"", "'");
+			if (forceStringify.includes(key)) return `${k}="${v}"`;
+			return `:${k}="${v}"`;
+		}
+		return `${isString(key) && key[0] === ":" ? ":" : ""}${k}="${String(value)}"`;
+	}).filter(Boolean).join(" ");
+	return result ? ` ${result}` : "";
+}
+//#endregion
+//#region src/node/utils/treat-as-html.ts
+const KNOWN_EXTENSIONS = /* @__PURE__ */ new Set();
+function treatAsHtml(filename) {
+	if (KNOWN_EXTENSIONS.size === 0) {
+		const extraExts = typeof process === "object" && process.env?.VITE_EXTRA_EXTENSIONS || import.meta.env?.VITE_EXTRA_EXTENSIONS || "";
+		`3g2,3gp,aac,ai,apng,au,avif,bin,bmp,cer,class,conf,crl,css,csv,dll,doc,eps,epub,exe,gif,gz,ics,ief,jar,jpe,jpeg,jpg,js,json,jsonld,m4a,man,mid,midi,mjs,mov,mp2,mp3,mp4,mpe,mpeg,mpg,mpp,oga,ogg,ogv,ogx,opus,otf,p10,p7c,p7m,p7s,pdf,png,ps,qt,roff,rtf,rtx,ser,svg,t,tif,tiff,tr,ts,tsv,ttf,txt,vtt,wav,weba,webm,webp,woff,woff2,xhtml,xml,yaml,yml,zip${extraExts && typeof extraExts === "string" ? `,${extraExts}` : ""}`.split(",").forEach((ext) => KNOWN_EXTENSIONS.add(ext));
+	}
+	const ext = filename.split(".").pop();
+	return ext == null || !KNOWN_EXTENSIONS.has(ext.toLowerCase());
+}
+//#endregion
+//#region src/node/vitepress/get-vitepress-config.ts
+function getVitepressConfig() {
+	const config = globalThis.VITEPRESS_CONFIG;
+	if (!config) throw new Error("VITEPRESS_CONFIG is not initialized");
+	return config;
+}
+//#endregion
+//#region src/node/vitepress/createLocales.ts
+/**
+* 创建 locales
+* @param builtinLocales 内置的 locales
+* @param userLocales 用户的 locales
+* @returns locales
+*/
+function createLocales(builtinLocales, userLocales = {}) {
+	const locales = {};
+	const vitepressLocales = getVitepressConfig().userConfig.locales || {};
+	for (const [key, { lang }] of objectEntries(vitepressLocales)) for (const [langs, localeData] of builtinLocales) if (langs.includes(key) || lang && langs.includes(lang)) {
+		locales[key] = localeData;
+		break;
+	}
+	if (!locales.root) locales.root = builtinLocales[0][1];
+	deepMerge(locales, userLocales);
+	return locales;
+}
+//#endregion
+//#region src/node/vitepress/get-locale-with-path.ts
+function getLocaleWithPath(path) {
+	const locales = getVitepressConfig().userConfig?.locales || {};
+	const keys = objectKeys(locales);
+	const key = keys.find((locale) => path.startsWith(locale)) || keys[0] || "";
+	if (!key || !locales[key]) return {
+		lang: "",
+		locale: ""
+	};
+	return {
+		lang: locales[key].lang || key,
+		locale: key === "root" ? "" : key
+	};
+}
+//#endregion
+//#region src/node/vitepress/resolve-route-link.ts
+const indexRE = /(^|.*\/)index.md(.*)$/i;
+function resolveRouteLink(url, env) {
+	if (isExternal(url)) return url;
+	const config = getVitepressConfig();
+	if (url.startsWith("/")) return slash(config.site.base + url);
+	if (url.startsWith("#")) return decodeURI(normalizeHash(url));
+	const { pathname, protocol } = new URL(url, "http://a.com");
+	if (!url.startsWith("#") && protocol.startsWith("http") && treatAsHtml(pathname)) {
+		const indexMatch = url.match(indexRE);
+		if (indexMatch) {
+			const [, path, hash] = indexMatch;
+			url = path + normalizeHash(hash);
+		} else {
+			let cleanUrl = url.replace(/[?#].*$/, "");
+			if (cleanUrl.endsWith(".md")) cleanUrl = cleanUrl.replace(/\.md$/, env.cleanUrls ? "" : ".html");
+			if (!env.cleanUrls && !cleanUrl.endsWith(".html") && !cleanUrl.endsWith("/")) cleanUrl += ".html";
+			const parsed = new URL(url, "http://a.com");
+			url = cleanUrl + parsed.search + normalizeHash(parsed.hash);
+		}
+		if (!url.startsWith("/") && !url.startsWith("./")) url = `./${url}`;
+	}
+	return url;
+}
+function normalizeHash(str) {
+	return str ? encodeURI(`#${slugify(decodeURI(str).slice(1))}`) : "";
+}
+//#endregion
+export { EXTENSION_AUDIOS, EXTENSION_IMAGES, EXTENSION_VIDEOS, EXTERNAL_URL_RE, URL_PROTOCOL_RE, createContainerPlugin, createContainerSyntaxPlugin, createEmbedRuleBlock, createLocales, createLogger, getLocaleWithPath, getVitepressConfig, isExternal, isLinkWithProtocol, logLevels, parseRect, resolveAttr, resolveAttrs, resolveRouteLink, slugify, stringifyAttrs, treatAsHtml };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "vitepress-plugin-toolkit",
+  "type": "module",
+  "version": "0.1.0",
+  "description": "Development toolkit for vitepress plugins",
+  "author": "pengzhanbo <q942450674@outlook.com> (https://github.com/pengzhanbo/)",
+  "license": "MIT",
+  "keywords": [
+    "vitepress",
+    "vitepress-plugin",
+    "toolkit"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/node/index.d.ts",
+      "default": "./dist/node/index.js"
+    },
+    "./client": {
+      "browser": "./dist/client/browser/index.js",
+      "default": "./dist/client/ssr/index.js"
+    },
+    "./styles/*": "./dist/client/styles/*"
+  },
+  "module": "./dist/node/index.js",
+  "types": "./dist/node/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "vitepress": "^1.6.4 || ^2.0.0-alpha.17",
+    "vue": "^3.5.0"
+  },
+  "dependencies": {
+    "@pengzhanbo/utils": "^3.7.3",
+    "@vueuse/core": "^14.3.0",
+    "ansis": "^4.3.1",
+    "markdown-it-container": "^4.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rimraf --glob ./dist",
+    "dev": "pnpm '/(tsdown|copy):watch/'",
+    "build": "pnpm tsdown && pnpm copy",
+    "copy": "cpx \"src/**/*.css\" dist",
+    "copy:watch": "pnpm copy -w",
+    "tsdown": "tsdown --config-loader unrun"
+  }
+}