@vuepress/utils 2.0.0-rc.2 → 2.0.0-rc.21

package/README.md

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

package/dist/index.d.ts

@@ -13,19 +13,19 @@ import { HeadConfig, HeadAttrsConfig } from '@vuepress/shared';
  */
 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;
+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;
 };
 
 declare const withSpinner: (msg: string) => <T>(target: (spinner?: Ora) => Promise<T>) => Promise<T>;
@@ -51,6 +51,11 @@ declare const isChildPath: (child: string, parent: string) => boolean;
 
 declare const sanitizeFileName: (name: string) => string;
 
+/**
+ * Transforms a path to a file name, replacing slashes with underscores
+ */
+declare const transformPathToFileName: (rawPath: string) => string;
+
 /**
  * Render head config to string
  */
@@ -114,10 +119,10 @@ interface TemplateRendererContext {
 /**
  * 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 };
+export { TEMPLATE_RENDERER_OUTLETS, type TemplateRenderer, type TemplateRendererContext, createError, error, formatMs, getDirname, importFile, importFileDefault, info, isChildPath, logger, renderHead, renderHeadAttrs, sanitizeFileName, success, templateRenderer, tip, transformPathToFileName, warn, withSpinner };

package/dist/index.js

@@ -9,8 +9,7 @@ import path3 from "upath";
 
 // src/console/formatMs.ts
 var formatMs = (ms) => {
-  if (ms < 1e3)
-    return `${ms}ms`;
+  if (ms < 1e3) return `${ms}ms`;
   return `${(ms / 1e3).toFixed(2)}s`;
 };
 
@@ -45,7 +44,7 @@ var logger = {
 };
 
 // src/console/withSpinner.ts
-import process from "process";
+import process from "node:process";
 import ora from "ora";
 var withSpinner = (msg) => async (target) => {
   if (process.env.DEBUG) {
@@ -65,14 +64,14 @@ var withSpinner = (msg) => async (target) => {
 };
 
 // src/module/getDirname.ts
-import { fileURLToPath } from "url";
+import { fileURLToPath } from "node: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);
+import { pathToFileURL } from "node:url";
+var importFile = async (filePath) => import(pathToFileURL(filePath).toString());
+var importFileDefault = async (filePath) => importFile(filePath).then((m) => m.default);
 
 // src/module/isChildPath.ts
 import path2 from "upath";
@@ -87,13 +86,16 @@ var isChildPath = (child, parent) => {
 };
 
 // src/module/sanitizeFileName.ts
-var INVALID_CHAR_REGEX = /[\x00-\x1F\x7F<>*#"{}|^[\]`;?:&=+$,]/g;
+var INVALID_CHAR_REGEX = /[\u0000-\u001F"#$%&*+,:;<=>?[\]^`{|}\u007F]/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(/^_+/, "");
+  return driveLetter + name.slice(driveLetter.length).replace(INVALID_CHAR_REGEX, "_").replace(/^_+/, "");
 };
 
+// src/module/transformPathToFileName.ts
+var transformPathToFileName = (rawPath) => sanitizeFileName(rawPath.replace(/\//g, "_"));
+
 // src/ssr/renderHeadAttrs.ts
 var renderHeadAttrs = (attrs) => Object.entries(attrs).filter((item) => item[1] !== false).map(
   ([key, value]) => value === true ? ` ${key}` : ` ${key}="${attrs[key]}"`
@@ -148,6 +150,7 @@ export {
   success,
   templateRenderer,
   tip,
+  transformPathToFileName,
   warn,
   withSpinner
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/utils",
-  "version": "2.0.0-rc.2",
+  "version": "2.0.0-rc.21",
   "description": "Utils package of VuePress",
   "keywords": [
     "vuepress",
@@ -30,14 +30,14 @@
     "@types/debug": "^4.1.12",
     "@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",
+    "debug": "^4.4.0",
+    "fs-extra": "^11.3.0",
+    "globby": "^14.1.0",
     "hash-sum": "^2.0.0",
-    "ora": "^8.0.1",
-    "picocolors": "^1.0.0",
+    "ora": "^8.2.0",
+    "picocolors": "^1.1.1",
     "upath": "^2.0.1",
-    "@vuepress/shared": "2.0.0-rc.2"
+    "@vuepress/shared": "2.0.0-rc.21"
   },
   "publishConfig": {
     "access": "public"