@vuepress/shared 2.0.0-rc.2 → 2.0.0-rc.20

package/README.md

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

package/dist/index.d.ts

@@ -9,11 +9,11 @@ type HeadConfig = [HeadTagEmpty, HeadAttrsConfig] | [HeadTagNonEmpty, HeadAttrsC
  *
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/head
  */
-type HeadTag = HeadTagNonEmpty | HeadTagEmpty;
+type HeadTag = HeadTagEmpty | HeadTagNonEmpty;
 /**
  * Non-empty tags in `<head>`
  */
-type HeadTagNonEmpty = 'title' | 'style' | 'script' | 'noscript' | 'template';
+type HeadTagNonEmpty = 'noscript' | 'script' | 'style' | 'template' | 'title';
 /**
  * Empty tags in `<head>`
  */
@@ -21,7 +21,7 @@ type HeadTagEmpty = 'base' | 'link' | 'meta' | 'script';
 /**
  * Attributes to be set for tags in `<head>`
  */
-type HeadAttrsConfig = Record<string, string | boolean>;
+type HeadAttrsConfig = Record<string, boolean | string>;
 
 /**
  * Locales config, a key-value object
@@ -40,15 +40,7 @@ type LocaleData = Record<never, never>;
 /**
  * Base type of vuepress page
  */
-interface PageBase<ExtraPageFrontmatter extends Record<any, any> = Record<string, unknown>> {
-    /**
-     * Identifier of the page
-     *
-     * Will also be used as the component name
-     *
-     * @example 'v-foobar'
-     */
-    key: string;
+interface PageBase<ExtraPageFrontmatter extends Record<string, unknown> = Record<string, unknown>> {
     /**
      * Route path of the page
      *
@@ -80,20 +72,20 @@ interface PageBase<ExtraPageFrontmatter extends Record<any, any> = Record<string
 /**
  * Vuepress page data
  */
-type PageData<ExtraPageData extends Record<any, any> = Record<never, never>, ExtraPageFrontmatter extends Record<any, any> = Record<string, unknown>> = PageBase<ExtraPageFrontmatter> & ExtraPageData;
+type PageData<ExtraPageData extends Record<string, unknown> = Record<string, unknown>, ExtraPageFrontmatter extends Record<string, unknown> = Record<string, unknown>> = ExtraPageData & PageBase<ExtraPageFrontmatter>;
 /**
  * Vuepress page frontmatter
  *
  * Notice that frontmatter is parsed from yaml or other languages,
  * so we cannot guarantee the type safety
  */
-type PageFrontmatter<T extends Record<any, any> = Record<string, unknown>> = Partial<T> & {
-    date?: string | Date;
+type PageFrontmatter<T extends Record<string, unknown> = Record<string, unknown>> = Partial<T> & {
+    date?: Date | string;
     description?: string;
     head?: HeadConfig[];
     lang?: string;
     layout?: string;
-    permalink?: string;
+    permalink?: string | null;
     permalinkPattern?: string | null;
     routeMeta?: Record<string, unknown>;
     title?: string;
@@ -167,7 +159,7 @@ interface SiteLocaleData {
     /**
      * Head config
      *
-     * Descibe the tags to be appended into the `<head>` tag
+     * Describe the tags to be appended into the `<head>` tag
      *
      * @default []
      *
@@ -190,50 +182,73 @@ interface VuepressSSRContext {
 }
 
 /**
- * Dedupe head config with identifier
+ * Determine a link is external or not
+ */
+declare const isLinkExternal: (link: string, base?: string) => boolean;
+
+/**
+ * Determine a link is http link or not
  *
- * Items that appear earlier have higher priority
+ * - http://github.com
+ * - https://github.com
+ * - //github.com
  */
-declare const dedupeHead: (head: HeadConfig[]) => HeadConfig[];
+declare const isLinkHttp: (link: string) => boolean;
 
 /**
- * Ensure a url string to have leading slash /
+ * Determine a link has protocol or not
  */
-declare const ensureLeadingSlash: (str: string) => string;
+declare const isLinkWithProtocol: (link: string) => boolean;
 
 /**
- * Ensure a url string to have ending slash /
+ * Infer route path of the given raw path
  */
-declare const ensureEndingSlash: (str: string) => string;
+declare const inferRoutePath: (rawPath: string) => string;
 
 /**
- * Format a date string to `yyyy-MM-dd`
+ * Normalize the given pathname path to the final route path
  */
-declare const formatDateString: (str: string, defaultDateString?: string) => string;
+declare const normalizeRoutePath: (pathname: string, current?: string) => string;
 
 /**
- * Determine a link is external or not
+ * Resolve the matched locale path of route path
  */
-declare const isLinkExternal: (link: string, base?: string) => boolean;
+declare const resolveLocalePath: (locales: LocaleConfig, routePath: string) => string;
 
 /**
- * Determine a link is http link or not
+ * For a give URL, remove the origin and the site base to get the route path
+ */
+declare const resolveRoutePathFromUrl: (url: string, base?: string) => string;
+
+/**
+ * Split a path into pathname and hashAndQueries
+ */
+declare const splitPath: (path: string) => {
+    pathname: string;
+    hashAndQueries: string;
+};
+
+/**
+ * Dedupe head config with identifier
  *
- * - http://github.com
- * - https://github.com
- * - //github.com
+ * Items that appear earlier have higher priority
  */
-declare const isLinkHttp: (link: string) => boolean;
+declare const dedupeHead: (head: HeadConfig[]) => HeadConfig[];
 
 /**
- * Determine a link has protocol or not
+ * Ensure a url string to have leading slash /
  */
-declare const isLinkWithProtocol: (link: string) => boolean;
+declare const ensureLeadingSlash: (str: string) => string;
 
 /**
- * Check if a value is plain object, with generic type support
+ * Ensure a url string to have ending slash /
  */
-declare const isPlainObject: <T extends Record<any, any> = Record<any, any>>(val: unknown) => val is T;
+declare const ensureEndingSlash: (str: string) => string;
+
+/**
+ * Format a date string to `yyyy-MM-dd`
+ */
+declare const formatDateString: (str: string, defaultDateString?: string) => string;
 
 /**
  * Omit properties from an object
@@ -255,20 +270,17 @@ declare const removeLeadingSlash: (str: string) => string;
  */
 declare const resolveHeadIdentifier: ([tag, attrs, content]: HeadConfig) => string | null;
 
-/**
- * Resolve the matched locale path of route path
- */
-declare const resolveLocalePath: (locales: LocaleConfig, routePath: string) => string;
-
-declare const resolveRoutePathFromUrl: (url: string, base?: string) => string;
-
 /**
  * Check if a value is a function
  */
 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;
 /**
  * Check if a value is a string
  */
 declare const isString: (val: unknown) => val is string;
 
-export { type HeadAttrsConfig, type HeadConfig, type HeadTag, type HeadTagEmpty, type HeadTagNonEmpty, type LocaleConfig, type LocaleData, type PageBase, type PageData, type PageFrontmatter, type PageHeader, type SiteData, type SiteLocaleConfig, type SiteLocaleData, type VuepressSSRContext, dedupeHead, ensureEndingSlash, ensureLeadingSlash, formatDateString, isFunction, isLinkExternal, isLinkHttp, isLinkWithProtocol, isPlainObject, isString, omit, removeEndingSlash, removeLeadingSlash, resolveHeadIdentifier, resolveLocalePath, resolveRoutePathFromUrl };
+export { type HeadAttrsConfig, type HeadConfig, type HeadTag, type HeadTagEmpty, type HeadTagNonEmpty, type LocaleConfig, type LocaleData, type PageBase, type PageData, type PageFrontmatter, type PageHeader, type SiteData, type SiteLocaleConfig, type SiteLocaleData, type VuepressSSRContext, dedupeHead, ensureEndingSlash, ensureLeadingSlash, formatDateString, inferRoutePath, isFunction, isLinkExternal, isLinkHttp, isLinkWithProtocol, isPlainObject, isString, normalizeRoutePath, omit, removeEndingSlash, removeLeadingSlash, resolveHeadIdentifier, resolveLocalePath, resolveRoutePathFromUrl, splitPath };

package/dist/index.js

@@ -1,3 +1,72 @@
+// src/utils/links/isLinkWithProtocol.ts
+var isLinkWithProtocol = (link) => /^[a-z][a-z0-9+.-]*:/.test(link) || link.startsWith("//");
+
+// src/utils/links/isLinkExternal.ts
+var markdownLinkRegexp = /.md((\?|#).*)?$/;
+var isLinkExternal = (link, base = "/") => isLinkWithProtocol(link) || // absolute link that does not start with `base` and does not end with `.md`
+link.startsWith("/") && !link.startsWith(base) && !markdownLinkRegexp.test(link);
+
+// src/utils/links/isLinkHttp.ts
+var isLinkHttp = (link) => /^(https?:)?\/\//.test(link);
+
+// src/utils/routes/inferRoutePath.ts
+var inferRoutePath = (rawPath) => {
+  if (!rawPath || rawPath.endsWith("/")) return rawPath;
+  let routePath = rawPath.replace(/(^|\/)README.md$/i, "$1index.html");
+  if (routePath.endsWith(".md")) {
+    routePath = `${routePath.substring(0, routePath.length - 3)}.html`;
+  } else if (!routePath.endsWith(".html")) {
+    routePath = `${routePath}.html`;
+  }
+  if (routePath.endsWith("/index.html")) {
+    routePath = routePath.substring(0, routePath.length - 10);
+  }
+  return routePath;
+};
+
+// src/utils/routes/normalizeRoutePath.ts
+var FAKE_HOST = "http://.";
+var normalizeRoutePath = (pathname, current) => {
+  if (!pathname.startsWith("/") && current) {
+    const loc = current.slice(0, current.lastIndexOf("/"));
+    return inferRoutePath(new URL(`${loc}/${pathname}`, FAKE_HOST).pathname);
+  }
+  return inferRoutePath(pathname);
+};
+
+// src/utils/routes/resolveLocalePath.ts
+var resolveLocalePath = (locales, routePath) => {
+  const localePaths = Object.keys(locales).sort((a, b) => {
+    const levelDelta = b.split("/").length - a.split("/").length;
+    if (levelDelta !== 0) {
+      return levelDelta;
+    }
+    return b.length - a.length;
+  });
+  for (const localePath of localePaths) {
+    if (routePath.startsWith(localePath)) {
+      return localePath;
+    }
+  }
+  return "/";
+};
+
+// src/utils/routes/resolveRoutePathFromUrl.ts
+var resolveRoutePathFromUrl = (url, base = "/") => {
+  const pathname = url.replace(/^(?:https?:)?\/\/[^/]*/, "");
+  return pathname.startsWith(base) ? `/${pathname.slice(base.length)}` : pathname;
+};
+
+// src/utils/routes/splitPath.ts
+var SPLIT_CHAR_REGEXP = /(#|\?)/;
+var splitPath = (path) => {
+  const [pathname, ...hashAndQueries] = path.split(SPLIT_CHAR_REGEXP);
+  return {
+    pathname,
+    hashAndQueries: hashAndQueries.join("")
+  };
+};
+
 // src/utils/resolveHeadIdentifier.ts
 var TAGS_ALLOWED = ["link", "meta", "script", "style", "noscript", "template"];
 var TAGS_UNIQUE = ["title", "base"];
@@ -41,10 +110,10 @@ var dedupeHead = (head) => {
 };
 
 // src/utils/ensureLeadingSlash.ts
-var ensureLeadingSlash = (str) => str[0] === "/" ? str : `/${str}`;
+var ensureLeadingSlash = (str) => str.startsWith("/") ? str : `/${str}`;
 
 // src/utils/ensureEndingSlash.ts
-var ensureEndingSlash = (str) => str[str.length - 1] === "/" || str.endsWith(".html") ? str : `${str}/`;
+var ensureEndingSlash = (str) => str.endsWith("/") || str.endsWith(".html") ? str : `${str}/`;
 
 // src/utils/formatDateString.ts
 var formatDateString = (str, defaultDateString = "") => {
@@ -56,27 +125,6 @@ var formatDateString = (str, defaultDateString = "") => {
   return [yearStr, monthStr.padStart(2, "0"), dayStr.padStart(2, "0")].join("-");
 };
 
-// src/utils/isLinkHttp.ts
-var isLinkHttp = (link) => /^(https?:)?\/\//.test(link);
-
-// src/utils/isLinkExternal.ts
-var markdownLinkRegexp = /.md((\?|#).*)?$/;
-var isLinkExternal = (link, base = "/") => {
-  if (isLinkHttp(link)) {
-    return true;
-  }
-  if (link.startsWith("/") && !link.startsWith(base) && !markdownLinkRegexp.test(link)) {
-    return true;
-  }
-  return false;
-};
-
-// src/utils/isLinkWithProtocol.ts
-var isLinkWithProtocol = (link) => /^[a-z][a-z0-9+.-]*:/.test(link);
-
-// src/utils/isPlainObject.ts
-var isPlainObject = (val) => Object.prototype.toString.call(val) === "[object Object]";
-
 // src/utils/omit.ts
 var omit = (obj, ...keys) => {
   const result = { ...obj };
@@ -87,52 +135,33 @@ var omit = (obj, ...keys) => {
 };
 
 // src/utils/removeEndingSlash.ts
-var removeEndingSlash = (str) => str[str.length - 1] === "/" ? str.slice(0, -1) : str;
+var removeEndingSlash = (str) => str.endsWith("/") ? str.slice(0, -1) : str;
 
 // src/utils/removeLeadingSlash.ts
-var removeLeadingSlash = (str) => str[0] === "/" ? str.slice(1) : str;
-
-// src/utils/resolveLocalePath.ts
-var resolveLocalePath = (locales, routePath) => {
-  const localePaths = Object.keys(locales).sort((a, b) => {
-    const levelDelta = b.split("/").length - a.split("/").length;
-    if (levelDelta !== 0) {
-      return levelDelta;
-    }
-    return b.length - a.length;
-  });
-  for (const localePath of localePaths) {
-    if (routePath.startsWith(localePath)) {
-      return localePath;
-    }
-  }
-  return "/";
-};
-
-// src/utils/resolveRoutePathFromUrl.ts
-var resolveRoutePathFromUrl = (url, base = "/") => {
-  const pathname = url.replace(/^(https?:)?\/\/[^/]*/, "");
-  return pathname.startsWith(base) ? `/${pathname.slice(base.length)}` : pathname;
-};
+var removeLeadingSlash = (str) => str.startsWith("/") ? str.slice(1) : str;
 
 // src/utils/typeGuards.ts
 var isFunction = (val) => typeof val === "function";
+var isPlainObject = (val) => Object.prototype.toString.call(val) === "[object Object]";
 var isString = (val) => typeof val === "string";
 export {
   dedupeHead,
   ensureEndingSlash,
   ensureLeadingSlash,
   formatDateString,
+  inferRoutePath,
   isFunction,
   isLinkExternal,
   isLinkHttp,
   isLinkWithProtocol,
   isPlainObject,
   isString,
+  normalizeRoutePath,
   omit,
   removeEndingSlash,
   removeLeadingSlash,
   resolveHeadIdentifier,
   resolveLocalePath,
-  resolveRoutePathFromUrl
+  resolveRoutePathFromUrl,
+  splitPath
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/shared",
-  "version": "2.0.0-rc.2",
+  "version": "2.0.0-rc.20",
   "description": "Utils that shared between VuePress node and client",
   "keywords": [
     "vuepress",
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@mdit-vue/types": "^2.0.0"
+    "@mdit-vue/types": "^2.1.0"
   },
   "publishConfig": {
     "access": "public"