@vuepress/shared 2.0.0-rc.30 → 2.0.0-rc.32

package/dist/index.d.ts

@@ -1,6 +1,4 @@
 import { MarkdownItHeader } from "@mdit-vue/types";
-
-//#region src/types/head.d.ts
 /**
  * Config for `<head>` tags
  */
@@ -23,8 +21,6 @@ type HeadTagEmpty = 'base' | 'link' | 'meta' | 'script';
  * Attributes to be set for tags in `<head>`
  */
 type HeadAttrsConfig = Record<string, boolean | string>;
-//#endregion
-//#region src/types/locale.d.ts
 /**
  * Locales config, a key-value object
  *
@@ -37,9 +33,7 @@ type LocaleConfig<T extends LocaleData = LocaleData> = Record<string, Partial<T>
 /**
  * Locales data
  */
-type LocaleData = Record<never, never>;
-//#endregion
-//#region src/types/page.d.ts
+type LocaleData = object;
 /**
  * Base type of vuepress page
  */
@@ -93,8 +87,6 @@ type PageFrontmatter<T extends Record<string, unknown> = Record<string, unknown>
  * Vuepress page header
  */
 type PageHeader = MarkdownItHeader;
-//#endregion
-//#region src/types/site.d.ts
 /**
  * Vuepress site data
  */
@@ -172,8 +164,6 @@ interface SiteLocaleData {
  * Site locale config
  */
 type SiteLocaleConfig = LocaleConfig<SiteLocaleData>;
-//#endregion
-//#region src/types/ssr.d.ts
 /**
  * Context for SSR
  */
@@ -181,14 +171,10 @@ interface VuepressSSRContext {
   lang: string;
   head: HeadConfig[];
 }
-//#endregion
-//#region src/utils/links/isLinkExternal.d.ts
 /**
  * Determine a link is external or not
  */
-declare const isLinkExternal: (link: string, base?: string) => boolean;
-//#endregion
-//#region src/utils/links/isLinkHttp.d.ts
+export declare const isLinkExternal: (link: string, base?: string) => boolean;
 /**
  * Determine a link is http link or not
  *
@@ -196,109 +182,78 @@ declare const isLinkExternal: (link: string, base?: string) => boolean;
  * - https://github.com
  * - //github.com
  */
-declare const isLinkHttp: (link: string) => boolean;
-//#endregion
-//#region src/utils/links/isLinkWithProtocol.d.ts
+export declare const isLinkHttp: (link: string) => boolean;
 /**
  * Determine a link has protocol or not
  */
-declare const isLinkWithProtocol: (link: string) => boolean;
-//#endregion
-//#region src/utils/routes/inferRoutePath.d.ts
+export declare const isLinkWithProtocol: (link: string) => boolean;
 /**
  * Infer route path of the given raw path
  */
-declare const inferRoutePath: (rawPath: string) => string;
-//#endregion
-//#region src/utils/routes/normalizeRoutePath.d.ts
+export declare const inferRoutePath: (rawPath: string) => string;
 /**
  * Normalize the given pathname path to the final route path
  */
-declare const normalizeRoutePath: (pathname: string, current?: string) => string;
-//#endregion
-//#region src/utils/routes/resolveLocalePath.d.ts
+export declare const normalizeRoutePath: (pathname: string, current?: string) => string;
 /**
  * Resolve the matched locale path of route path
  */
-declare const resolveLocalePath: (locales: LocaleConfig, routePath: string) => string;
-//#endregion
-//#region src/utils/routes/resolveRoutePathFromUrl.d.ts
+export declare const resolveLocalePath: (locales: LocaleConfig, routePath: string) => string;
 /**
  * For a give URL, remove the origin and the site base to get the route path
  */
-declare const resolveRoutePathFromUrl: (url: string, base?: string) => string;
-//#endregion
-//#region src/utils/routes/splitPath.d.ts
+export declare const resolveRoutePathFromUrl: (url: string, base?: string) => string;
 /**
  * Split a path into pathname and hashAndQueries
  */
-declare const splitPath: (path: string) => {
+export declare const splitPath: (path: string) => {
   pathname: string;
   hashAndQueries: string;
 };
-//#endregion
-//#region src/utils/dedupeHead.d.ts
 /**
  * Dedupe head config with identifier
  *
  * Items that appear earlier have higher priority
  */
-declare const dedupeHead: (head: HeadConfig[]) => HeadConfig[];
-//#endregion
-//#region src/utils/ensureLeadingSlash.d.ts
+export declare const dedupeHead: (head: HeadConfig[]) => HeadConfig[];
 /**
  * Ensure a url string to have leading slash /
  */
-declare const ensureLeadingSlash: (str: string) => string;
-//#endregion
-//#region src/utils/ensureEndingSlash.d.ts
+export declare const ensureLeadingSlash: (str: string) => string;
 /**
  * Ensure a url string to have ending slash /
  */
-declare const ensureEndingSlash: (str: string) => string;
-//#endregion
-//#region src/utils/formatDateString.d.ts
+export declare const ensureEndingSlash: (str: string) => string;
 /**
  * Format a date string to `yyyy-MM-dd`
  */
-declare const formatDateString: (str: string, defaultDateString?: string) => string;
-//#endregion
-//#region src/utils/omit.d.ts
+export declare const formatDateString: (str: string, defaultDateString?: string) => string;
 /**
  * Omit properties from an object
  */
-declare const omit: <T extends Record<string, unknown>, U extends string[]>(obj: T, ...keys: U) => Omit<T, U[number]>;
-//#endregion
-//#region src/utils/removeEndingSlash.d.ts
+export declare const omit: <T extends Record<string, unknown>, U extends string[]>(obj: T, ...keys: U) => Omit<T, U[number]>;
 /**
  * Remove ending slash / from a string
  */
-declare const removeEndingSlash: (str: string) => string;
-//#endregion
-//#region src/utils/removeLeadingSlash.d.ts
+export declare const removeEndingSlash: (str: string) => string;
 /**
  * Remove leading slash / from a string
  */
-declare const removeLeadingSlash: (str: string) => string;
-//#endregion
-//#region src/utils/resolveHeadIdentifier.d.ts
+export declare const removeLeadingSlash: (str: string) => string;
 /**
  * Resolve identifier of a tag, to avoid duplicated tags in `<head>`
  */
-declare const resolveHeadIdentifier: ([tag, attrs, content]: HeadConfig) => string | null;
-//#endregion
-//#region src/utils/typeGuards.d.ts
+export declare const resolveHeadIdentifier: ([tag, attrs, content]: HeadConfig) => string | null;
 /**
  * Check if a value is a function
  */
-declare const isFunction: (val: unknown) => val is Function;
+export declare const isFunction: (val: unknown) => val is Function;
 /**
  * Check if a value is plain object, with generic type support
  */
-declare const isPlainObject: <T extends Record<any, any> = Record<any, any>>(val: unknown) => val is T;
+export declare const isPlainObject: <T extends Record<any, any> = Record<any, any>>(val: unknown) => val is T;
 /**
  * Check if a value is a string
  */
-declare const isString: (val: unknown) => val is string;
-//#endregion
-export { HeadAttrsConfig, HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, LocaleConfig, LocaleData, PageBase, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig, SiteLocaleData, VuepressSSRContext, dedupeHead, ensureEndingSlash, ensureLeadingSlash, formatDateString, inferRoutePath, isFunction, isLinkExternal, isLinkHttp, isLinkWithProtocol, isPlainObject, isString, normalizeRoutePath, omit, removeEndingSlash, removeLeadingSlash, resolveHeadIdentifier, resolveLocalePath, resolveRoutePathFromUrl, splitPath };
+export declare const isString: (val: unknown) => val is string;
+export type { HeadAttrsConfig, HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, LocaleConfig, LocaleData, PageBase, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig, SiteLocaleData, VuepressSSRContext };

package/dist/index.js

@@ -1,17 +1,15 @@
-//#region src/utils/links/isLinkWithProtocol.ts
+// src/utils/links/isLinkWithProtocol.ts
 /**
 * Determine a link has protocol or not
 */
 const isLinkWithProtocol = (link) => /^[a-z][a-z0-9+.-]*:/.test(link) || link.startsWith("//");
-//#endregion
-//#region src/utils/links/isLinkExternal.ts
+// src/utils/links/isLinkExternal.ts
 const markdownLinkRegexp = /.md((\?|#).*)?$/;
 /**
 * Determine a link is external or not
 */
 const isLinkExternal = (link, base = "/") => isLinkWithProtocol(link) || link.startsWith("/") && !link.startsWith(base) && !markdownLinkRegexp.test(link);
-//#endregion
-//#region src/utils/links/isLinkHttp.ts
+// src/utils/links/isLinkHttp.ts
 /**
 * Determine a link is http link or not
 *
@@ -20,8 +18,7 @@ const isLinkExternal = (link, base = "/") => isLinkWithProtocol(link) || link.st
 * - //github.com
 */
 const isLinkHttp = (link) => /^(https?:)?\/\//.test(link);
-//#endregion
-//#region src/utils/routes/inferRoutePath.ts
+// src/utils/routes/inferRoutePath.ts
 /**
 * Infer route path of the given raw path
 */
@@ -33,8 +30,7 @@ const inferRoutePath = (rawPath) => {
 	if (routePath.endsWith("/index.html")) routePath = routePath.substring(0, routePath.length - 10);
 	return routePath;
 };
-//#endregion
-//#region src/utils/routes/normalizeRoutePath.ts
+// src/utils/routes/normalizeRoutePath.ts
 const FAKE_HOST = "http://.";
 /**
 * Normalize the given pathname path to the final route path
@@ -46,8 +42,7 @@ const normalizeRoutePath = (pathname, current) => {
 	}
 	return inferRoutePath(pathname);
 };
-//#endregion
-//#region src/utils/routes/resolveLocalePath.ts
+// src/utils/routes/resolveLocalePath.ts
 /**
 * Resolve the matched locale path of route path
 */
@@ -60,8 +55,7 @@ const resolveLocalePath = (locales, routePath) => {
 	for (const localePath of localePaths) if (routePath.startsWith(localePath)) return localePath;
 	return "/";
 };
-//#endregion
-//#region src/utils/routes/resolveRoutePathFromUrl.ts
+// src/utils/routes/resolveRoutePathFromUrl.ts
 /**
 * For a give URL, remove the origin and the site base to get the route path
 */
@@ -69,8 +63,7 @@ const resolveRoutePathFromUrl = (url, base = "/") => {
 	const pathname = url.replace(/^(?:https?:)?\/\/[^/]*/, "");
 	return pathname.startsWith(base) ? `/${pathname.slice(base.length)}` : pathname;
 };
-//#endregion
-//#region src/utils/routes/splitPath.ts
+// src/utils/routes/splitPath.ts
 const SPLIT_CHAR_REGEXP = /(#|\?)/;
 /**
 * Split a path into pathname and hashAndQueries
@@ -82,8 +75,7 @@ const splitPath = (path) => {
 		hashAndQueries: hashAndQueries.join("")
 	};
 };
-//#endregion
-//#region src/utils/resolveHeadIdentifier.ts
+// src/utils/resolveHeadIdentifier.ts
 const TAGS_ALLOWED = [
 	"link",
 	"meta",
@@ -110,8 +102,7 @@ const resolveHeadIdentifier = ([tag, attrs, content]) => {
 		content
 	]);
 };
-//#endregion
-//#region src/utils/dedupeHead.ts
+// src/utils/dedupeHead.ts
 /**
 * Dedupe head config with identifier
 *
@@ -129,20 +120,17 @@ const dedupeHead = (head) => {
 	});
 	return result;
 };
-//#endregion
-//#region src/utils/ensureLeadingSlash.ts
+// src/utils/ensureLeadingSlash.ts
 /**
 * Ensure a url string to have leading slash /
 */
 const ensureLeadingSlash = (str) => str.startsWith("/") ? str : `/${str}`;
-//#endregion
-//#region src/utils/ensureEndingSlash.ts
+// src/utils/ensureEndingSlash.ts
 /**
 * Ensure a url string to have ending slash /
 */
 const ensureEndingSlash = (str) => str.endsWith("/") || str.endsWith(".html") ? str : `${str}/`;
-//#endregion
-//#region src/utils/formatDateString.ts
+// src/utils/formatDateString.ts
 /**
 * Format a date string to `yyyy-MM-dd`
 */
@@ -156,8 +144,7 @@ const formatDateString = (str, defaultDateString = "") => {
 		dayStr.padStart(2, "0")
 	].join("-");
 };
-//#endregion
-//#region src/utils/omit.ts
+// src/utils/omit.ts
 /**
 * Omit properties from an object
 */
@@ -166,20 +153,17 @@ const omit = (obj, ...keys) => {
 	for (const key of keys) delete result[key];
 	return result;
 };
-//#endregion
-//#region src/utils/removeEndingSlash.ts
+// src/utils/removeEndingSlash.ts
 /**
 * Remove ending slash / from a string
 */
 const removeEndingSlash = (str) => str.endsWith("/") ? str.slice(0, -1) : str;
-//#endregion
-//#region src/utils/removeLeadingSlash.ts
+// src/utils/removeLeadingSlash.ts
 /**
 * Remove leading slash / from a string
 */
 const removeLeadingSlash = (str) => str.startsWith("/") ? str.slice(1) : str;
-//#endregion
-//#region src/utils/typeGuards.ts
+// src/utils/typeGuards.ts
 /**
 * Check if a value is a function
 */
@@ -192,5 +176,4 @@ const isPlainObject = (val) => Object.prototype.toString.call(val) === "[object
 * Check if a value is a string
 */
 const isString = (val) => typeof val === "string";
-//#endregion
 export { dedupeHead, ensureEndingSlash, ensureLeadingSlash, formatDateString, inferRoutePath, isFunction, isLinkExternal, isLinkHttp, isLinkWithProtocol, isPlainObject, isString, normalizeRoutePath, omit, removeEndingSlash, removeLeadingSlash, resolveHeadIdentifier, resolveLocalePath, resolveRoutePathFromUrl, splitPath };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/shared",
-  "version": "2.0.0-rc.30",
+  "version": "2.0.0-rc.32",
   "description": "Utils that shared between VuePress node and client",
   "keywords": [
     "shared",
@@ -32,7 +32,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@mdit-vue/types": "^3.0.2"
+    "@mdit-vue/types": "^4.0.0"
   },
   "tsdown": {
     "dts": true,