@vuepress/utils 2.0.0-rc.3 → 2.0.0-rc.31

package/README.md

@@ -5,7 +5,7 @@
 
 ## Documentation
 
-https://v2.vuepress.vuejs.org
+https://vuepress.vuejs.org
 
 ## License
 

package/dist/index.d.ts

@@ -1,37 +1,41 @@
-export { default as debug } from 'debug';
-export { default as fs } from 'fs-extra';
-export { globby } from 'globby';
-export { default as hash } from 'hash-sum';
-import { Ora } from 'ora';
-export { default as ora } from 'ora';
-export { default as colors } from 'picocolors';
-export { default as path } from 'upath';
-import { HeadConfig, HeadAttrsConfig } from '@vuepress/shared';
-
+import debug from "debug";
+import fs from "fs-extra";
+import hash from "hash-sum";
+import ora, { Ora } from "ora";
+import colors from "picocolors";
+import picomatch from "picomatch";
+import * as tinyglobby from "tinyglobby";
+import path from "upath";
+import { HeadAttrsConfig, HeadConfig } from "@vuepress/shared";
+//#region src/console/formatMs.d.ts
 /**
  * Format millisecond
  */
 declare const formatMs: (ms: number) => string;
-
-declare const info: (...args: any[]) => void;
-declare const tip: (...args: any[]) => void;
-declare const success: (...args: any[]) => void;
-declare const warn: (...args: any[]) => void;
-declare const error: (...args: any[]) => void;
-declare const createError: (message?: string | undefined) => Error;
+//#endregion
+//#region src/console/logger.d.ts
+declare const info: (...args: unknown[]) => void;
+declare const tip: (...args: unknown[]) => void;
+declare const success: (...args: unknown[]) => void;
+declare const warn: (...args: unknown[]) => void;
+declare const error: (...args: unknown[]) => void;
+declare const createError: (message?: string) => Error;
 declare const logger: {
-    info: (...args: any[]) => void;
-    tip: (...args: any[]) => void;
-    success: (...args: any[]) => void;
-    warn: (...args: any[]) => void;
-    error: (...args: any[]) => void;
-    createError: (message?: string | undefined) => Error;
+  info: (...args: unknown[]) => void;
+  tip: (...args: unknown[]) => void;
+  success: (...args: unknown[]) => void;
+  warn: (...args: unknown[]) => void;
+  error: (...args: unknown[]) => void;
+  createError: (message?: string) => Error;
 };
-
+//#endregion
+//#region src/console/withSpinner.d.ts
 declare const withSpinner: (msg: string) => <T>(target: (spinner?: Ora) => Promise<T>) => Promise<T>;
-
+//#endregion
+//#region src/module/getDirname.d.ts
 declare const getDirname: (importMetaUrl: string) => string;
-
+//#endregion
+//#region src/module/importFile.d.ts
 /**
  * A helper for dynamically importing a file path
  *
@@ -42,82 +46,93 @@ 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>;
-
+//#endregion
+//#region src/module/isChildPath.d.ts
 /**
  * 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;
-
+//#endregion
+//#region src/module/sanitizeFileName.d.ts
 declare const sanitizeFileName: (name: string) => string;
-
+//#endregion
+//#region src/module/transformPathToFileName.d.ts
+/**
+ * Transforms a path to a file name, replacing slashes with underscores
+ */
+declare const transformPathToFileName: (rawPath: string) => string;
+//#endregion
+//#region src/ssr/renderHead.d.ts
 /**
  * Render head config to string
  */
-declare const renderHead: ([tag, attrs, innerHTML,]: HeadConfig) => string;
-
+declare const renderHead: ([tag, attrs, innerHTML]: HeadConfig) => string;
+//#endregion
+//#region src/ssr/renderHeadAttrs.d.ts
 /**
  * Render head attrs config to string
  */
 declare const renderHeadAttrs: (attrs: HeadAttrsConfig) => string;
-
+//#endregion
+//#region src/ssr/templateRenderer.d.ts
 /**
  * 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;
-};
+declare enum TemplateRendererOutlet {
+  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 }}"
+}
 /**
  * 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;
+  /**
+   * 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>;
+type TemplateRenderer = (template: string, context: TemplateRendererContext) => Promise<string> | string;
 /**
  * The default template renderer implementation
  */
 declare const templateRenderer: TemplateRenderer;
-
-export { TEMPLATE_RENDERER_OUTLETS, type TemplateRenderer, type TemplateRendererContext, createError, error, formatMs, getDirname, importFile, importFileDefault, info, isChildPath, logger, renderHead, renderHeadAttrs, sanitizeFileName, success, templateRenderer, tip, warn, withSpinner };
+//#endregion
+export { TemplateRenderer, TemplateRendererContext, TemplateRendererOutlet, colors, createError, debug, error, formatMs, fs, getDirname, hash, importFile, importFileDefault, info, isChildPath, logger, ora, path, picomatch, renderHead, renderHeadAttrs, sanitizeFileName, success, templateRenderer, tinyglobby, tip, transformPathToFileName, warn, withSpinner };

package/dist/index.js

@@ -1,153 +1,143 @@
-// src/index.ts
 import debug from "debug";
 import fs from "fs-extra";
-import { globby } from "globby";
 import hash from "hash-sum";
-import ora2 from "ora";
-import colors2 from "picocolors";
-import path3 from "upath";
-
-// src/console/formatMs.ts
-var formatMs = (ms) => {
-  if (ms < 1e3)
-    return `${ms}ms`;
-  return `${(ms / 1e3).toFixed(2)}s`;
+import ora, { default as ora$1 } from "ora";
+import colors, { default as colors$1 } from "picocolors";
+import picomatch from "picomatch";
+import * as tinyglobby from "tinyglobby";
+import path, { default as path$1 } from "upath";
+import process from "node:process";
+import { fileURLToPath, pathToFileURL } from "node:url";
+//#region src/console/formatMs.ts
+/**
+* Format millisecond
+*/
+const formatMs = (ms) => {
+	if (ms < 1e3) return `${ms}ms`;
+	return `${(ms / 1e3).toFixed(2)}s`;
 };
-
-// src/console/logger.ts
-import colors from "picocolors";
-var info = (...args) => {
-  console.log(colors.cyan("info"), ...args);
+//#endregion
+//#region src/console/logger.ts
+const info = (...args) => {
+	console.log(colors$1.cyan("info"), ...args);
 };
-var tip = (...args) => {
-  console.log(colors.blue("tip"), ...args);
+const tip = (...args) => {
+	console.log(colors$1.blue("tip"), ...args);
 };
-var success = (...args) => {
-  console.log(colors.green("success"), ...args);
+const success = (...args) => {
+	console.log(colors$1.green("success"), ...args);
 };
-var warn = (...args) => {
-  console.warn(colors.yellow("warning"), ...args);
+const warn = (...args) => {
+	console.warn(colors$1.yellow("warning"), ...args);
 };
-var error = (...args) => {
-  console.error(colors.red("error"), ...args);
+const error = (...args) => {
+	console.error(colors$1.red("error"), ...args);
 };
-var createError = (message) => {
-  error(message);
-  return new Error(message);
+const createError = (message) => {
+	error(message);
+	return new Error(message);
 };
-var logger = {
-  info,
-  tip,
-  success,
-  warn,
-  error,
-  createError
+const logger = {
+	info,
+	tip,
+	success,
+	warn,
+	error,
+	createError
 };
-
-// src/console/withSpinner.ts
-import process from "process";
-import ora from "ora";
-var withSpinner = (msg) => async (target) => {
-  if (process.env.DEBUG) {
-    return target();
-  }
-  const start = Date.now();
-  const spinner = ora();
-  try {
-    spinner.start(msg);
-    const result = await target(spinner);
-    spinner.succeed(`${msg} - done in ${formatMs(Date.now() - start)}`);
-    return result;
-  } catch (e) {
-    spinner.fail(`${msg} - failed in ${formatMs(Date.now() - start)}`);
-    throw e;
-  }
+//#endregion
+//#region src/console/withSpinner.ts
+const withSpinner = (msg) => async (target) => {
+	if (process.env.DEBUG) return target();
+	const start = Date.now();
+	const spinner = ora$1();
+	try {
+		spinner.start(msg);
+		const result = await target(spinner);
+		spinner.succeed(`${msg} - done in ${formatMs(Date.now() - start)}`);
+		return result;
+	} catch (e) {
+		spinner.fail(`${msg} - failed in ${formatMs(Date.now() - start)}`);
+		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("..");
+//#endregion
+//#region src/module/getDirname.ts
+const getDirname = (importMetaUrl) => path$1.dirname(fileURLToPath(importMetaUrl));
+//#endregion
+//#region src/module/importFile.ts
+/**
+* A helper for dynamically importing a file path
+*
+* We need to use `pathToFileURL` to transform file path wo compat with windows
+*/
+const importFile = async (filePath) => import(pathToFileURL(filePath).toString());
+/**
+* A wrapper of `importFile` and returns the default export
+*/
+const importFileDefault = async (filePath) => importFile(filePath).then((m) => m.default);
+//#endregion
+//#region src/module/isChildPath.ts
+/**
+* Check if `child` is a sub path of `parent` or not. Return `true` if
+* they are the same path
+*/
+const isChildPath = (child, parent) => {
+	const childPath = path$1.normalize(child);
+	const parentPath = path$1.normalize(parent);
+	if (!path$1.win32.isAbsolute(childPath) || !path$1.win32.isAbsolute(parentPath)) return false;
+	const relativePath = path$1.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(/^_+/, "");
+//#endregion
+//#region src/module/sanitizeFileName.ts
+const INVALID_CHAR_REGEX = /[\u0000-\u001F"#$%&*+,:;<=>?[\]^`{|}\u007F]/g;
+const DRIVE_LETTER_REGEX = /^[a-z]:/i;
+const sanitizeFileName = (name) => {
+	const driveLetter = DRIVE_LETTER_REGEX.exec(name)?.[0] || "";
+	return driveLetter + name.slice(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,
-  error,
-  formatMs,
-  fs,
-  getDirname,
-  globby,
-  hash,
-  importFile,
-  importFileDefault,
-  info,
-  isChildPath,
-  logger,
-  ora2 as ora,
-  path3 as path,
-  renderHead,
-  renderHeadAttrs,
-  sanitizeFileName,
-  success,
-  templateRenderer,
-  tip,
-  warn,
-  withSpinner
+//#endregion
+//#region src/module/transformPathToFileName.ts
+/**
+* Transforms a path to a file name, replacing slashes with underscores
+*/
+const transformPathToFileName = (rawPath) => sanitizeFileName(rawPath.replace(/\//g, "_"));
+//#endregion
+//#region src/ssr/renderHeadAttrs.ts
+/**
+* Render head attrs config to string
+*/
+const renderHeadAttrs = (attrs) => Object.entries(attrs).filter((item) => item[1] !== false).map(([key, value]) => value === true ? ` ${key}` : ` ${key}="${attrs[key]}"`).join("");
+//#endregion
+//#region src/ssr/renderHead.ts
+/**
+* Render head config to string
+*/
+const renderHead = ([tag, attrs, innerHTML = ""]) => {
+	const openTag = `<${tag}${renderHeadAttrs(attrs)}>`;
+	if (tag === "link" || tag === "meta" || tag === "base") return openTag;
+	return `${openTag}${innerHTML}</${tag}>`;
 };
+//#endregion
+//#region src/ssr/templateRenderer.ts
+/**
+* HTML outlets of the template renderer
+*/
+let TemplateRendererOutlet = /* @__PURE__ */ function(TemplateRendererOutlet) {
+	TemplateRendererOutlet["Content"] = "<!--vuepress-ssr-content-->";
+	TemplateRendererOutlet["Head"] = "<!--vuepress-ssr-head-->";
+	TemplateRendererOutlet["Lang"] = "{{ lang }}";
+	TemplateRendererOutlet["Prefetch"] = "<!--vuepress-ssr-prefetch-->";
+	TemplateRendererOutlet["Preload"] = "<!--vuepress-ssr-preload-->";
+	TemplateRendererOutlet["Scripts"] = "<!--vuepress-ssr-scripts-->";
+	TemplateRendererOutlet["Styles"] = "<!--vuepress-ssr-styles-->";
+	TemplateRendererOutlet["Version"] = "{{ version }}";
+	return TemplateRendererOutlet;
+}({});
+/**
+* The default template renderer implementation
+*/
+const templateRenderer = (template, { content, head, lang, prefetch, preload, scripts, styles, version }) => template.replace("<!--vuepress-ssr-content-->", () => content).replace("<!--vuepress-ssr-head-->", head).replace("{{ lang }}", lang).replace("<!--vuepress-ssr-prefetch-->", prefetch).replace("<!--vuepress-ssr-preload-->", preload).replace("<!--vuepress-ssr-scripts-->", scripts).replace("<!--vuepress-ssr-styles-->", styles).replace("{{ version }}", version);
+//#endregion
+export { TemplateRendererOutlet, colors, createError, debug, error, formatMs, fs, getDirname, hash, importFile, importFileDefault, info, isChildPath, logger, ora, path, picomatch, renderHead, renderHeadAttrs, sanitizeFileName, success, templateRenderer, tinyglobby, tip, transformPathToFileName, warn, withSpinner };

package/package.json

@@ -1,63 +1,60 @@
 {
   "name": "@vuepress/utils",
-  "version": "2.0.0-rc.3",
+  "version": "2.0.0-rc.31",
   "description": "Utils package of VuePress",
   "keywords": [
-    "vuepress",
-    "utils"
+    "utils",
+    "vuepress"
   ],
   "homepage": "https://github.com/vuepress",
   "bugs": {
     "url": "https://github.com/vuepress/core/issues"
   },
+  "license": "MIT",
+  "author": "meteorlxy",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vuepress/core.git"
   },
-  "license": "MIT",
-  "author": "meteorlxy",
+  "files": [
+    "dist"
+  ],
   "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": "./dist/index.js",
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
-    "@types/debug": "^4.1.12",
+    "@types/debug": "^4.1.13",
     "@types/fs-extra": "^11.0.4",
     "@types/hash-sum": "^1.0.2",
-    "debug": "^4.3.4",
-    "fs-extra": "^11.2.0",
-    "globby": "^14.0.0",
+    "@types/picomatch": "^4.0.3",
+    "debug": "^4.4.3",
+    "fs-extra": "^11.3.6",
     "hash-sum": "^2.0.0",
-    "ora": "^8.0.1",
-    "picocolors": "^1.0.0",
-    "upath": "^2.0.1",
-    "@vuepress/shared": "2.0.0-rc.3"
-  },
-  "publishConfig": {
-    "access": "public"
+    "ora": "^9.4.1",
+    "picocolors": "^1.1.1",
+    "picomatch": "^4.0.5",
+    "tinyglobby": "^0.2.17",
+    "upath": "^3.0.8",
+    "@vuepress/shared": "2.0.0-rc.31"
   },
-  "tsup": {
-    "clean": true,
-    "dts": "./src/index.ts",
-    "entry": [
-      "./src/index.ts"
-    ],
-    "format": [
-      "esm"
-    ],
-    "outDir": "./dist",
-    "sourcemap": false,
-    "target": "es2022",
+  "tsdown": {
+    "dts": true,
+    "entry": "./src/index.ts",
+    "fixedExtension": false,
+    "format": "esm",
+    "target": "es2023",
     "tsconfig": "../../tsconfig.dts.json"
   },
   "scripts": {
-    "build": "tsup",
+    "build": "tsdown",
     "clean": "rimraf dist"
   }
 }