@vuepress/utils 2.0.0-beta.50-pre → 2.0.0-beta.51

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+export { default as chalk } from 'chalk';
+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 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;
+declare const warn: (...args: any[]) => void;
+declare const error: (...args: any[]) => void;
+declare const createError: (message?: string | undefined) => 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;
+};
+
+/**
+ * Render head config to string
+ */
+declare const renderHead: ([tag, attrs, innerHTML,]: HeadConfig) => string;
+
+/**
+ * Render head attrs config to string
+ */
+declare const renderHeadAttrs: (attrs: HeadAttrsConfig) => string;
+
+declare const withSpinner: (msg: string) => <T>(target: (spinner?: Ora) => Promise<T>) => Promise<T>;
+
+export { createError, error, formatMs, getDirname, importFile, importFileDefault, info, isChildPath, logger, renderHead, renderHeadAttrs, success, tip, warn, withSpinner };

package/dist/index.js

@@ -0,0 +1,129 @@
+// src/index.ts
+import chalk2 from "chalk";
+import debug from "debug";
+import fs from "fs-extra";
+import { globby } from "globby";
+import hash from "hash-sum";
+import ora2 from "ora";
+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
+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
+import chalk from "chalk";
+var info = (...args) => {
+  console.log(chalk.cyan("info"), ...args);
+};
+var tip = (...args) => {
+  console.log(chalk.blue("tip"), ...args);
+};
+var success = (...args) => {
+  console.log(chalk.green("success"), ...args);
+};
+var warn = (...args) => {
+  console.warn(chalk.yellow("warning"), ...args);
+};
+var error = (...args) => {
+  console.error(chalk.red("error"), ...args);
+};
+var createError = (message) => {
+  error(message);
+  return new Error(message);
+};
+var logger = {
+  info,
+  tip,
+  success,
+  warn,
+  error,
+  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/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;
+  }
+};
+export {
+  chalk2 as chalk,
+  createError,
+  debug,
+  error,
+  formatMs,
+  fs,
+  getDirname,
+  globby,
+  hash,
+  importFile,
+  importFileDefault,
+  info,
+  isChildPath,
+  logger,
+  ora2 as ora,
+  path3 as path,
+  renderHead,
+  renderHeadAttrs,
+  success,
+  tip,
+  warn,
+  withSpinner
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/utils",
-  "version": "2.0.0-beta.50-pre",
+  "version": "2.0.0-beta.51",
   "description": "Utils package of VuePress",
   "keywords": [
     "vuepress",
@@ -24,13 +24,13 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "./dist"
+    "dist"
   ],
   "dependencies": {
     "@types/debug": "^4.1.7",
     "@types/fs-extra": "^9.0.13",
     "@types/hash-sum": "^1.0.0",
-    "@vuepress/shared": "2.0.0-beta.50-pre",
+    "@vuepress/shared": "2.0.0-beta.51",
     "chalk": "^5.0.1",
     "debug": "^4.3.4",
     "fs-extra": "^10.1.0",