@vuepress/utils 2.0.0-beta.67 → 2.0.0-beta.68

package/dist/index.d.ts

@@ -8,30 +8,11 @@ export { default as colors } from 'picocolors';
 export { default as path } from 'upath';
 import { HeadConfig, HeadAttrsConfig } from '@vuepress/shared';
 
-declare const getDirname: (importMetaUrl: string) => string;
-
-/**
- * A helper for dynamically importing a file path
- *
- * We need to use `pathToFileURL` to transform file path wo compat with windows
- */
-declare const importFile: <T>(filePath: string) => Promise<T>;
-/**
- * A wrapper of `importFile` and returns the default export
- */
-declare const importFileDefault: <T>(filePath: string) => Promise<T>;
-
 /**
  * Format millisecond
  */
 declare const formatMs: (ms: number) => string;
 
-/**
- * Check if `child` is a sub path of `parent` or not. Return `true` if
- * they are the same path
- */
-declare const isChildPath: (child: string, parent: string) => boolean;
-
 declare const info: (...args: any[]) => void;
 declare const tip: (...args: any[]) => void;
 declare const success: (...args: any[]) => void;
@@ -47,6 +28,29 @@ declare const logger: {
     createError: (message?: string | undefined) => Error;
 };
 
+declare const withSpinner: (msg: string) => <T>(target: (spinner?: Ora) => Promise<T>) => Promise<T>;
+
+declare const getDirname: (importMetaUrl: string) => string;
+
+/**
+ * A helper for dynamically importing a file path
+ *
+ * We need to use `pathToFileURL` to transform file path wo compat with windows
+ */
+declare const importFile: <T>(filePath: string) => Promise<T>;
+/**
+ * A wrapper of `importFile` and returns the default export
+ */
+declare const importFileDefault: <T>(filePath: string) => Promise<T>;
+
+/**
+ * Check if `child` is a sub path of `parent` or not. Return `true` if
+ * they are the same path
+ */
+declare const isChildPath: (child: string, parent: string) => boolean;
+
+declare const sanitizeFileName: (name: string) => string;
+
 /**
  * Render head config to string
  */
@@ -57,8 +61,63 @@ declare const renderHead: ([tag, attrs, innerHTML,]: HeadConfig) => string;
  */
 declare const renderHeadAttrs: (attrs: HeadAttrsConfig) => string;
 
-declare const sanitizeFileName: (name: string) => string;
-
-declare const withSpinner: (msg: string) => <T>(target: (spinner?: Ora) => Promise<T>) => Promise<T>;
+/**
+ * HTML outlets of the template renderer
+ */
+declare const TEMPLATE_RENDERER_OUTLETS: {
+    CONTENT: string;
+    HEAD: string;
+    LANG: string;
+    PREFETCH: string;
+    PRELOAD: string;
+    SCRIPTS: string;
+    STYLES: string;
+    VERSION: string;
+};
+/**
+ * Context type of the template renderer
+ */
+interface TemplateRendererContext {
+    /**
+     * The rendered page content. Typically to be put inside `<div id="app"></div>`
+     */
+    content: string;
+    /**
+     * The rendered page head. Typically to be put inside `<head></head>`
+     */
+    head: string;
+    /**
+     * The language of the page. Typically to be put inside `<html lang="{{ lang }}">`
+     */
+    lang: string;
+    /**
+     * The rendered prefetch links. Typically to be put inside `<head></head>`
+     */
+    prefetch: string;
+    /**
+     * The rendered preload links. Typically to be put inside `<head></head>`
+     */
+    preload: string;
+    /**
+     * The rendered scripts. Typically to be put before `</body>`
+     */
+    scripts: string;
+    /**
+     * The rendered styles. Typically to be put inside `<head></head>`
+     */
+    styles: string;
+    /**
+     * The version of VuePress
+     */
+    version: string;
+}
+/**
+ * Type of the template renderer function
+ */
+type TemplateRenderer = (template: string, context: TemplateRendererContext) => string | Promise<string>;
+/**
+ * The default template renderer implementation
+ */
+declare const templateRenderer: TemplateRenderer;
 
-export { createError, error, formatMs, getDirname, importFile, importFileDefault, info, isChildPath, logger, renderHead, renderHeadAttrs, sanitizeFileName, success, tip, warn, withSpinner };
+export { TEMPLATE_RENDERER_OUTLETS, TemplateRenderer, TemplateRendererContext, createError, error, formatMs, getDirname, importFile, importFileDefault, info, isChildPath, logger, renderHead, renderHeadAttrs, sanitizeFileName, success, templateRenderer, tip, warn, withSpinner };

package/dist/index.js

@@ -7,36 +7,14 @@ import ora2 from "ora";
 import colors2 from "picocolors";
 import path3 from "upath";
 
-// src/getDirname.ts
-import { fileURLToPath } from "url";
-import path from "upath";
-var getDirname = (importMetaUrl) => path.dirname(fileURLToPath(importMetaUrl));
-
-// src/importFile.ts
-import { pathToFileURL } from "url";
-var importFile = (filePath) => import(pathToFileURL(filePath).toString());
-var importFileDefault = (filePath) => importFile(filePath).then((m) => m.default);
-
-// src/formatMs.ts
+// src/console/formatMs.ts
 var formatMs = (ms) => {
   if (ms < 1e3)
     return `${ms}ms`;
   return `${(ms / 1e3).toFixed(2)}s`;
 };
 
-// src/isChildPath.ts
-import path2 from "upath";
-var isChildPath = (child, parent) => {
-  const childPath = path2.normalize(child);
-  const parentPath = path2.normalize(parent);
-  if (!path2.win32.isAbsolute(childPath) || !path2.win32.isAbsolute(parentPath)) {
-    return false;
-  }
-  const relativePath = path2.relative(parentPath, childPath);
-  return relativePath === "" || !relativePath.startsWith("..");
-};
-
-// src/logger.ts
+// src/console/logger.ts
 import colors from "picocolors";
 var info = (...args) => {
   console.log(colors.cyan("info"), ...args);
@@ -66,33 +44,7 @@ var logger = {
   createError
 };
 
-// src/renderHeadAttrs.ts
-var renderHeadAttrs = (attrs) => Object.entries(attrs).filter((item) => item[1] !== false).map(
-  ([key, value]) => value === true ? ` ${key}` : ` ${key}="${attrs[key]}"`
-).join("");
-
-// src/renderHead.ts
-var renderHead = ([
-  tag,
-  attrs,
-  innerHTML = ""
-]) => {
-  const openTag = `<${tag}${renderHeadAttrs(attrs)}>`;
-  if (tag === "link" || tag === "meta" || tag === "base") {
-    return openTag;
-  }
-  return `${openTag}${innerHTML}</${tag}>`;
-};
-
-// src/sanitizeFileName.ts
-var INVALID_CHAR_REGEX = /[\x00-\x1F\x7F<>*#"{}|^[\]`;?:&=+$,]/g;
-var DRIVE_LETTER_REGEX = /^[a-z]:/i;
-var sanitizeFileName = (name) => {
-  const driveLetter = DRIVE_LETTER_REGEX.exec(name)?.[0] || "";
-  return driveLetter + name.substring(driveLetter.length).replace(INVALID_CHAR_REGEX, "_").replace(/^_+/, "");
-};
-
-// src/withSpinner.ts
+// src/console/withSpinner.ts
 import process from "process";
 import ora from "ora";
 var withSpinner = (msg) => async (target) => {
@@ -111,7 +63,69 @@ var withSpinner = (msg) => async (target) => {
     throw e;
   }
 };
+
+// src/module/getDirname.ts
+import { fileURLToPath } from "url";
+import path from "upath";
+var getDirname = (importMetaUrl) => path.dirname(fileURLToPath(importMetaUrl));
+
+// src/module/importFile.ts
+import { pathToFileURL } from "url";
+var importFile = (filePath) => import(pathToFileURL(filePath).toString());
+var importFileDefault = (filePath) => importFile(filePath).then((m) => m.default);
+
+// src/module/isChildPath.ts
+import path2 from "upath";
+var isChildPath = (child, parent) => {
+  const childPath = path2.normalize(child);
+  const parentPath = path2.normalize(parent);
+  if (!path2.win32.isAbsolute(childPath) || !path2.win32.isAbsolute(parentPath)) {
+    return false;
+  }
+  const relativePath = path2.relative(parentPath, childPath);
+  return relativePath === "" || !relativePath.startsWith("..");
+};
+
+// src/module/sanitizeFileName.ts
+var INVALID_CHAR_REGEX = /[\x00-\x1F\x7F<>*#"{}|^[\]`;?:&=+$,]/g;
+var DRIVE_LETTER_REGEX = /^[a-z]:/i;
+var sanitizeFileName = (name) => {
+  const driveLetter = DRIVE_LETTER_REGEX.exec(name)?.[0] || "";
+  return driveLetter + name.substring(driveLetter.length).replace(INVALID_CHAR_REGEX, "_").replace(/^_+/, "");
+};
+
+// src/ssr/renderHeadAttrs.ts
+var renderHeadAttrs = (attrs) => Object.entries(attrs).filter((item) => item[1] !== false).map(
+  ([key, value]) => value === true ? ` ${key}` : ` ${key}="${attrs[key]}"`
+).join("");
+
+// src/ssr/renderHead.ts
+var renderHead = ([
+  tag,
+  attrs,
+  innerHTML = ""
+]) => {
+  const openTag = `<${tag}${renderHeadAttrs(attrs)}>`;
+  if (tag === "link" || tag === "meta" || tag === "base") {
+    return openTag;
+  }
+  return `${openTag}${innerHTML}</${tag}>`;
+};
+
+// src/ssr/templateRenderer.ts
+var TEMPLATE_RENDERER_OUTLETS = {
+  CONTENT: "<!--vuepress-ssr-content-->",
+  HEAD: "<!--vuepress-ssr-head-->",
+  LANG: "{{ lang }}",
+  PREFETCH: "<!--vuepress-ssr-prefetch-->",
+  PRELOAD: "<!--vuepress-ssr-preload-->",
+  SCRIPTS: "<!--vuepress-ssr-scripts-->",
+  STYLES: "<!--vuepress-ssr-styles-->",
+  VERSION: "{{ version }}"
+};
+var templateRenderer = (template, { content, head, lang, prefetch, preload, scripts, styles, version }) => template.replace(TEMPLATE_RENDERER_OUTLETS.CONTENT, () => content).replace(TEMPLATE_RENDERER_OUTLETS.HEAD, head).replace(TEMPLATE_RENDERER_OUTLETS.LANG, lang).replace(TEMPLATE_RENDERER_OUTLETS.PREFETCH, prefetch).replace(TEMPLATE_RENDERER_OUTLETS.PRELOAD, preload).replace(TEMPLATE_RENDERER_OUTLETS.SCRIPTS, scripts).replace(TEMPLATE_RENDERER_OUTLETS.STYLES, styles).replace(TEMPLATE_RENDERER_OUTLETS.VERSION, version);
 export {
+  TEMPLATE_RENDERER_OUTLETS,
   colors2 as colors,
   createError,
   debug,
@@ -132,6 +146,7 @@ export {
   renderHeadAttrs,
   sanitizeFileName,
   success,
+  templateRenderer,
   tip,
   warn,
   withSpinner

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/utils",
-  "version": "2.0.0-beta.67",
+  "version": "2.0.0-beta.68",
   "description": "Utils package of VuePress",
   "keywords": [
     "vuepress",
@@ -27,17 +27,17 @@
     "dist"
   ],
   "dependencies": {
-    "@types/debug": "^4.1.8",
-    "@types/fs-extra": "^11.0.1",
-    "@types/hash-sum": "^1.0.0",
+    "@types/debug": "^4.1.12",
+    "@types/fs-extra": "^11.0.4",
+    "@types/hash-sum": "^1.0.2",
     "debug": "^4.3.4",
     "fs-extra": "^11.1.1",
-    "globby": "^13.2.2",
+    "globby": "^14.0.0",
     "hash-sum": "^2.0.0",
     "ora": "^7.0.1",
     "picocolors": "^1.0.0",
     "upath": "^2.0.1",
-    "@vuepress/shared": "2.0.0-beta.67"
+    "@vuepress/shared": "2.0.0-beta.68"
   },
   "publishConfig": {
     "access": "public"
@@ -53,7 +53,7 @@
     ],
     "outDir": "./dist",
     "sourcemap": false,
-    "target": "es2020",
+    "target": "es2022",
     "tsconfig": "../tsconfig.dts.json"
   },
   "scripts": {