@vuepress/shared 2.0.0-rc.1 → 2.0.0-rc.10

package/dist/index.d.ts

@@ -41,14 +41,6 @@ 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;
     /**
      * Route path of the page
      *
@@ -93,7 +85,7 @@ type PageFrontmatter<T extends Record<any, any> = Record<string, unknown>> = Par
     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 []
      *
@@ -211,6 +203,11 @@ declare const ensureEndingSlash: (str: string) => string;
  */
 declare const formatDateString: (str: string, defaultDateString?: string) => string;
 
+/**
+ * Infer route path according to the given (markdown file) path
+ */
+declare const inferRoutePath: (path: string) => string;
+
 /**
  * Determine a link is external or not
  */
@@ -235,6 +232,11 @@ declare const isLinkWithProtocol: (link: string) => boolean;
  */
 declare const isPlainObject: <T extends Record<any, any> = Record<any, any>>(val: unknown) => val is T;
 
+/**
+ * Normalize the given path to the final route path
+ */
+declare const normalizeRoutePath: (path: string, current?: string) => string;
+
 /**
  * Omit properties from an object
  */
@@ -271,4 +273,4 @@ declare const isFunction: (val: unknown) => val is Function;
  */
 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 };

package/dist/index.js

@@ -56,27 +56,48 @@ 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;
+// src/utils/inferRoutePath.ts
+var inferRoutePath = (path) => {
+  if (!path || path.endsWith("/"))
+    return path;
+  let routePath = path.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 (link.startsWith("/") && !link.startsWith(base) && !markdownLinkRegexp.test(link)) {
-    return true;
+  if (routePath.endsWith("/index.html")) {
+    routePath = routePath.substring(0, routePath.length - 10);
   }
-  return false;
+  return routePath;
 };
 
 // src/utils/isLinkWithProtocol.ts
-var isLinkWithProtocol = (link) => /^[a-z][a-z0-9+.-]*:/.test(link);
+var isLinkWithProtocol = (link) => /^[a-z][a-z0-9+.-]*:/.test(link) || link.startsWith("//");
+
+// src/utils/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/isLinkHttp.ts
+var isLinkHttp = (link) => /^(https?:)?\/\//.test(link);
 
 // src/utils/isPlainObject.ts
 var isPlainObject = (val) => Object.prototype.toString.call(val) === "[object Object]";
 
+// src/utils/normalizeRoutePath.ts
+var FAKE_HOST = "http://.";
+var normalizeRoutePath = (path, current) => {
+  if (!path.startsWith("/") && current) {
+    const loc = current.slice(0, current.lastIndexOf("/"));
+    const { pathname: pathname2, search, hash } = new URL(`${loc}/${path}`, FAKE_HOST);
+    return inferRoutePath(pathname2) + search + hash;
+  }
+  const [pathname, ...queryAndHash] = path.split(/(\?|#)/);
+  return inferRoutePath(pathname) + queryAndHash.join("");
+};
+
 // src/utils/omit.ts
 var omit = (obj, ...keys) => {
   const result = { ...obj };
@@ -111,7 +132,7 @@ var resolveLocalePath = (locales, routePath) => {
 
 // src/utils/resolveRoutePathFromUrl.ts
 var resolveRoutePathFromUrl = (url, base = "/") => {
-  const pathname = url.replace(/^(https?:)?\/\/[^/]*/, "");
+  const pathname = url.replace(/^(?:https?:)?\/\/[^/]*/, "");
   return pathname.startsWith(base) ? `/${pathname.slice(base.length)}` : pathname;
 };
 
@@ -123,12 +144,14 @@ export {
   ensureEndingSlash,
   ensureLeadingSlash,
   formatDateString,
+  inferRoutePath,
   isFunction,
   isLinkExternal,
   isLinkHttp,
   isLinkWithProtocol,
   isPlainObject,
   isString,
+  normalizeRoutePath,
   omit,
   removeEndingSlash,
   removeLeadingSlash,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/shared",
-  "version": "2.0.0-rc.1",
+  "version": "2.0.0-rc.10",
   "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"