@rspress/shared 1.44.0 → 1.45.0

package/dist/index.d.ts

@@ -767,7 +767,7 @@ export declare interface UserConfig<ThemeConfig = DefaultThemeConfig> {
     /**
      * Path to html icon file.
      */
-    icon?: string;
+    icon?: string | URL;
     /**
      * Default language of the site.
      */

package/dist/node-utils.d.ts

@@ -207,6 +207,18 @@ declare interface FrontMatterMeta {
     [key: string]: unknown;
 }
 
+/**
+ * Transform `config.icon` into final url path in the web app
+ *
+ * @param icon original icon in config
+ * @returns final url path in the web app
+ */
+export declare function getIconUrlPath(icon: '' | undefined): undefined;
+
+export declare function getIconUrlPath(icon: string | URL): string;
+
+export declare function getIconUrlPath(icon: string | URL | undefined): string | undefined;
+
 export declare function getNodeAttribute(node: MdxJsxFlowElement | MdxJsxTextElement, attrName: string, attribute?: false): string | MdxJsxAttributeValueExpression | null | undefined;
 
 export declare function getNodeAttribute(node: MdxJsxFlowElement | MdxJsxTextElement, attrName: string, attribute: true): MdxJsxAttribute | MdxJsxExpressionAttribute | undefined;
@@ -245,6 +257,7 @@ declare interface Hero {
 export declare function loadFrontMatter<TFrontmatter extends Record<string, unknown> = FrontMatterMeta>(source: string, filepath: string, root: string, outputWarning?: boolean): {
     frontmatter: TFrontmatter;
     content: string;
+    emptyLinesSource: string;
 };
 
 declare interface Locale {
@@ -600,7 +613,7 @@ declare interface UserConfig<ThemeConfig = Config> {
     /**
      * Path to html icon file.
      */
-    icon?: string;
+    icon?: string | URL;
     /**
      * Default language of the site.
      */

package/dist/node-utils.js

@@ -53,7 +53,8 @@ var __webpack_exports__ = {};
         extractTextAndId: ()=>extractTextAndId,
         loadFrontMatter: ()=>loadFrontMatter,
         mergeDocConfig: ()=>mergeDocConfig,
-        getNodeAttribute: ()=>getNodeAttribute
+        getNodeAttribute: ()=>getNodeAttribute,
+        getIconUrlPath: ()=>getIconUrlPath
     });
     const extractTextAndId = (title)=>{
         if (!title) return [
@@ -68,28 +69,40 @@ var __webpack_exports__ = {};
             customId
         ];
     };
+    const external_node_path_namespaceObject = require("node:path");
+    var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
+    const external_node_url_namespaceObject = require("node:url");
+    function getIconUrlPath(icon) {
+        if (!icon) return;
+        icon = icon.toString();
+        if (icon.startsWith('file://')) icon = (0, external_node_url_namespaceObject.fileURLToPath)(icon);
+        if (!external_node_path_default().isAbsolute(icon)) return icon;
+        return `/${external_node_path_default().basename(icon)}`;
+    }
     function getNodeAttribute(node, attrName, attribute) {
         const found = node.attributes.find((attr)=>'name' in attr && attr.name === attrName);
         return attribute ? found : found?.value;
     }
-    const external_node_path_namespaceObject = require("node:path");
-    var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
     const external_gray_matter_namespaceObject = require("gray-matter");
     var external_gray_matter_default = /*#__PURE__*/ __webpack_require__.n(external_gray_matter_namespaceObject);
     const core_namespaceObject = require("@rsbuild/core");
     function loadFrontMatter(source, filepath, root, outputWarning = false) {
         try {
             const { content, data } = external_gray_matter_default()(source);
+            const rawFrontMatter = source.slice(0, source.length - content.length);
+            const emptyLinesSource = rawFrontMatter.length ? `${rawFrontMatter.replace(/[^\n]/g, '')}${content}` : content;
             return {
                 content,
-                frontmatter: data
+                frontmatter: data,
+                emptyLinesSource
             };
         } catch (e) {
             if (outputWarning) core_namespaceObject.logger.warn(`Parse frontmatter error in ${external_node_path_default().relative(root, filepath)}: \n`, e);
         }
         return {
             content: '',
-            frontmatter: {}
+            frontmatter: {},
+            emptyLinesSource: source
         };
     }
     const castArray = (value)=>Array.isArray(value) ? value : [
@@ -111,11 +124,13 @@ var __webpack_exports__ = {};
     };
 })();
 exports.extractTextAndId = __webpack_exports__.extractTextAndId;
+exports.getIconUrlPath = __webpack_exports__.getIconUrlPath;
 exports.getNodeAttribute = __webpack_exports__.getNodeAttribute;
 exports.loadFrontMatter = __webpack_exports__.loadFrontMatter;
 exports.mergeDocConfig = __webpack_exports__.mergeDocConfig;
 for(var __webpack_i__ in __webpack_exports__)if (-1 === [
     "extractTextAndId",
+    "getIconUrlPath",
     "getNodeAttribute",
     "loadFrontMatter",
     "mergeDocConfig"

package/dist/node-utils.mjs

@@ -1,4 +1,5 @@
 import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
+import * as __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__ from "node:url";
 import * as __WEBPACK_EXTERNAL_MODULE_gray_matter_90c6cd0b__ from "gray-matter";
 import * as __WEBPACK_EXTERNAL_MODULE__rsbuild_core_1b356efc__ from "@rsbuild/core";
 const extractTextAndId = (title)=>{
@@ -14,6 +15,13 @@ const extractTextAndId = (title)=>{
         customId
     ];
 };
+function getIconUrlPath(icon) {
+    if (!icon) return;
+    icon = icon.toString();
+    if (icon.startsWith('file://')) icon = (0, __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__.fileURLToPath)(icon);
+    if (!__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].isAbsolute(icon)) return icon;
+    return `/${__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].basename(icon)}`;
+}
 function getNodeAttribute(node, attrName, attribute) {
     const found = node.attributes.find((attr)=>'name' in attr && attr.name === attrName);
     return attribute ? found : found?.value;
@@ -21,16 +29,20 @@ function getNodeAttribute(node, attrName, attribute) {
 function loadFrontMatter(source, filepath, root, outputWarning = false) {
     try {
         const { content, data } = (0, __WEBPACK_EXTERNAL_MODULE_gray_matter_90c6cd0b__["default"])(source);
+        const rawFrontMatter = source.slice(0, source.length - content.length);
+        const emptyLinesSource = rawFrontMatter.length ? `${rawFrontMatter.replace(/[^\n]/g, '')}${content}` : content;
         return {
             content,
-            frontmatter: data
+            frontmatter: data,
+            emptyLinesSource
         };
     } catch (e) {
         if (outputWarning) __WEBPACK_EXTERNAL_MODULE__rsbuild_core_1b356efc__.logger.warn(`Parse frontmatter error in ${__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].relative(root, filepath)}: \n`, e);
     }
     return {
         content: '',
-        frontmatter: {}
+        frontmatter: {},
+        emptyLinesSource: source
     };
 }
 const castArray = (value)=>Array.isArray(value) ? value : [
@@ -50,4 +62,4 @@ const mergeDocConfig = async (...configs)=>{
         ];
     });
 };
-export { extractTextAndId, getNodeAttribute, loadFrontMatter, mergeDocConfig };
+export { extractTextAndId, getIconUrlPath, getNodeAttribute, loadFrontMatter, mergeDocConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "1.44.0",
+  "version": "1.45.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/web-infra-dev/rspress",