perf: use util functions

vuepress-theme-hope · Jan 4, 2023 · 2e364a9 · 2e364a9
1 parent f853aa4
commit 2e364a9
Show file tree

Hide file tree

Showing 64 changed files with 308 additions and 242 deletions.
diff --git a/packages/auto-catalog/rollup.config.ts b/packages/auto-catalog/rollup.config.ts
@@ -7,6 +7,7 @@ export default [
       "@vuepress/shared",
       "@vuepress/utils",
       "vuepress-shared/node",
+      "vuepress-plugin-components",
       "vuepress-plugin-sass-palette",
     ],
   }),

diff --git a/packages/blog2/src/node/category.ts b/packages/blog2/src/node/category.ts
@@ -1,5 +1,5 @@
 import { createPage } from "@vuepress/core";
-import { removeLeadingSlash } from "@vuepress/shared";
+import { isFunction, isString, removeLeadingSlash } from "@vuepress/shared";
 import { logger } from "./utils.js";
 
 import type { App, Page } from "@vuepress/core";
@@ -52,13 +52,13 @@ export const prepareCategory = (
         },
         index
       ) => {
-        if (typeof key !== "string" || !key) {
+        if (!isString(key) || !key) {
           logger.error(`Invalid 'key' option ${key} in 'category[${index}]'`);
 
           return null;
         }
 
-        if (typeof getter !== "function") {
+        if (!isFunction(getter)) {
           logger.error(
             `Invalid 'getter' option in 'category[${index}]', it should be a function!`
           );
@@ -70,13 +70,12 @@ export const prepareCategory = (
 
         const categoryMap: CategoryMap = {};
         const pageKeys: string[] = [];
-        const getItemPath =
-          typeof itemPath === "function"
-            ? itemPath
-            : (name: string): string =>
-                (itemPath || "")
-                  .replace(/:key/g, slugify(key))
-                  .replace(/:name/g, slugify(name));
+        const getItemPath = isFunction(itemPath)
+          ? itemPath
+          : (name: string): string =>
+              (itemPath || "")
+                .replace(/:key/g, slugify(key))
+                .replace(/:name/g, slugify(name));
 
         for (const localePath in pageMap) {
           if (path) {

diff --git a/packages/blog2/src/node/type.ts b/packages/blog2/src/node/type.ts
@@ -1,5 +1,5 @@
 import { createPage } from "@vuepress/core";
-import { removeLeadingSlash } from "@vuepress/shared";
+import { isString, removeLeadingSlash } from "@vuepress/shared";
 import { logger } from "./utils.js";
 
 import type { App } from "@vuepress/core";
@@ -48,7 +48,7 @@ export const prepareType = (
         },
         index
       ) => {
-        if (typeof key !== "string" || !key) {
+        if (!isString(key) || !key) {
           logger.error(`Invalid 'key' option ${key} in 'category[${index}]'`);
 
           return null;

diff --git a/packages/components/rollup.config.ts b/packages/components/rollup.config.ts
@@ -27,7 +27,13 @@ export default [
     dtsExternal: [/\.scss$/],
   }),
   ...rollupTypescript("client/components/BiliBili", {
-    external: ["@vueuse/core", "vue", "vuepress-shared/client", /\.scss$/],
+    external: [
+      "@vueuse/core",
+      "@vuepress/shared",
+      "vue",
+      "vuepress-shared/client",
+      /\.scss$/,
+    ],
     dtsExternal: [/\.scss$/],
   }),
   ...rollupTypescript("client/components/BackToTop", {
@@ -74,11 +80,17 @@ export default [
     dtsExternal: [/\.scss$/],
   }),
   ...rollupTypescript("client/components/StackBlitz", {
-    external: ["@vueuse/core", "vue", /\.scss$/],
+    external: ["@vueuse/core", "@vuepress/shared", "vue", /\.scss$/],
     dtsExternal: [/\.scss$/],
   }),
   ...rollupTypescript("client/components/YouTube", {
-    external: ["@vueuse/core", "@vuepress/client", "vue", /\.scss$/],
+    external: [
+      "@vueuse/core",
+      "@vuepress/shared",
+      "@vuepress/client",
+      "vue",
+      /\.scss$/,
+    ],
     dtsExternal: [/\.scss$/],
   }),
   ...rollupTypescript("client/components/VideoPlayer", {

diff --git a/packages/components/src/client/composables/size.ts b/packages/components/src/client/composables/size.ts
@@ -1,10 +1,12 @@
+import { isString } from "@vuepress/shared";
 import { useEventListener } from "@vueuse/core";
 import { computed, onMounted, isRef, ref, unref, watch } from "vue";
+
 import type { MaybeRef } from "@vueuse/core";
 import type { Ref } from "vue";
 
 const getValue = (value: string | number): string =>
-  typeof value === "string" ? value : `${value}px`;
+  isString(value) ? value : `${value}px`;
 
 export interface SizeOptions {
   width: string | number | undefined;
@@ -27,7 +29,7 @@ export const useSize = <E extends HTMLElement>(
   const height = ref("auto");
 
   const getRadio = (radio: number | string | undefined): number => {
-    if (typeof radio === "string") {
+    if (isString(radio)) {
       const [width, height] = radio.split(":");
       const parsedRadio = Number(width) / Number(height);
 

diff --git a/packages/components/src/client/utils/pdf.ts b/packages/components/src/client/utils/pdf.ts
@@ -1,7 +1,3 @@
-import { withBase } from "@vuepress/client";
-import { ensureEndingSlash } from "@vuepress/shared";
-import { checkIsMobile, checkIsSafari } from "vuepress-shared/client";
-
 /**
  * Fork and edited from https://github.com/pipwerks/PDFObject/blob/master/pdfobject.js
  *
@@ -16,6 +12,10 @@ import { checkIsMobile, checkIsSafari } from "vuepress-shared/client";
  * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+import { withBase } from "@vuepress/client";
+import { ensureEndingSlash, isString } from "@vuepress/shared";
+import { checkIsMobile, checkIsSafari } from "vuepress-shared/client";
+
 declare const PDFJS_URL: string | null;
 
 export interface ViewPDFOptions {
@@ -164,7 +164,7 @@ export const viewPDF = (
       // Modern versions of Firefox come bundled with PDFJS
       isFirefoxWithPDFJS);
 
-  if (typeof url !== "string") {
+  if (!isString(url)) {
     logError("URL is not valid");
 
     return null;

diff --git a/packages/components/src/node/define.ts b/packages/components/src/node/define.ts
@@ -1,3 +1,4 @@
+import { isString } from "@vuepress/shared";
 import { getLocales } from "vuepress-shared/node";
 import {
   backToTopLocales,
@@ -24,8 +25,7 @@ export const getDefine =
       });
 
     if (options.components?.includes("FontIcon"))
-      result["ICON_PREFIX"] =
-        typeof prefix === "string" ? prefix : getIconPrefix(assets);
+      result["ICON_PREFIX"] = isString(prefix) ? prefix : getIconPrefix(assets);
 
     if (options.components?.includes("PDF")) {
       result["PDF_LOCALES"] = getLocales({

diff --git a/packages/components/src/node/prepare.ts b/packages/components/src/node/prepare.ts
@@ -1,3 +1,4 @@
+import { isPlainObject, isString } from "@vuepress/shared";
 import { CLIENT_FOLDER, logger } from "./utils.js";
 
 import type { App } from "@vuepress/core";
@@ -101,7 +102,7 @@ useStyleTag(\`${content}\`, { id: "icon-assets" });
     }
   });
 
-  if (typeof rootComponents.addThis === "string") {
+  if (isString(rootComponents.addThis)) {
     shouldImportUseScriptTag = true;
     setup += `\
 useScriptTag(\`//s7.addthis.com/js/300/addthis_widget.js#pubid=${rootComponents.addThis}\`);
@@ -122,7 +123,7 @@ import BackToTop from "${CLIENT_FOLDER}components/BackToTop.js";
 `;
   }
 
-  if (typeof rootComponents.notice === "object") {
+  if (isPlainObject(rootComponents.notice)) {
     shouldImportH = true;
     configImport += `\
 import Notice from "${CLIENT_FOLDER}components/Notice.js";

diff --git a/packages/copy-code2/package.json b/packages/copy-code2/package.json
@@ -50,6 +50,7 @@
   },
   "dependencies": {
     "@vuepress/client": "2.0.0-beta.60",
+    "@vuepress/shared": "2.0.0-beta.60",
     "@vuepress/utils": "2.0.0-beta.60",
     "balloon-css": "^1.2.0",
     "vue": "^3.2.45",

diff --git a/packages/copy-code2/rollup.config.ts b/packages/copy-code2/rollup.config.ts
@@ -14,6 +14,7 @@ export default [
   ...rollupTypescript("client/config", {
     external: [
       "@vuepress/client",
+      "@vuepress/shared",
       "balloon-css/balloon.css",
       "vue",
       "vue-router",

diff --git a/packages/copy-code2/src/client/composables/setup.ts b/packages/copy-code2/src/client/composables/setup.ts
@@ -25,6 +25,7 @@
  * © 2019 GitHub, Inc.
  */
 
+import { isArray, isString } from "@vuepress/shared";
 import { onMounted, watch } from "vue";
 import { useRoute } from "vue-router";
 import { Message, useLocaleConfig } from "vuepress-shared/client";
@@ -79,11 +80,11 @@ export const setupCopyCode = (): void => {
 
   const generateCopyButton = (): void => {
     setTimeout(() => {
-      if (typeof copyCodeSelector === "string")
+      if (isString(copyCodeSelector))
         document
           .querySelectorAll<HTMLElement>(copyCodeSelector)
           .forEach(insertCopyButton);
-      else if (Array.isArray(copyCodeSelector))
+      else if (isArray(copyCodeSelector))
         copyCodeSelector.forEach((item) => {
           document
             .querySelectorAll<HTMLElement>(item)

diff --git a/packages/copyright2/rollup.config.ts b/packages/copyright2/rollup.config.ts
@@ -2,7 +2,12 @@ import { rollupTypescript } from "../../scripts/rollup.js";
 
 export default [
   ...rollupTypescript("node/index", {
-    external: ["@vuepress/core", "@vuepress/utils", "vuepress-shared/node"],
+    external: [
+      "@vuepress/core",
+      "@vuepress/shared",
+      "@vuepress/utils",
+      "vuepress-shared/node",
+    ],
     dtsExternal: ["vuepress-shared"],
   }),
   ...rollupTypescript("client/config", {

diff --git a/packages/copyright2/src/client/composables/setup.ts b/packages/copyright2/src/client/composables/setup.ts
@@ -1,5 +1,5 @@
 import { usePageFrontmatter, usePageData } from "@vuepress/client";
-import { isLinkHttp, removeEndingSlash } from "@vuepress/shared";
+import { isLinkHttp, isPlainObject, removeEndingSlash } from "@vuepress/shared";
 import { useEventListener } from "@vueuse/core";
 import { computed, onMounted, watchEffect } from "vue";
 import { useRoute } from "vue-router";
@@ -39,7 +39,7 @@ export const setupCopyright = (): void => {
     if (!enabled.value) return false;
 
     if (
-      typeof frontmatterOptions === "object" &&
+      isPlainObject(frontmatterOptions) &&
       "disableCopy" in frontmatterOptions
     )
       return frontmatterOptions.disableCopy;
@@ -53,7 +53,7 @@ export const setupCopyright = (): void => {
     if (!enabled.value) return false;
 
     if (
-      typeof frontmatterOptions === "object" &&
+      isPlainObject(frontmatterOptions) &&
       "disableSelection" in frontmatterOptions
     )
       return frontmatterOptions.disableSelection;

diff --git a/packages/copyright2/src/node/plugins.ts b/packages/copyright2/src/node/plugins.ts
@@ -1,3 +1,4 @@
+import { isFunction } from "@vuepress/shared";
 import { getDirname, path } from "@vuepress/utils";
 import { getLocales } from "vuepress-shared/node";
 
@@ -45,10 +46,9 @@ export const copyrightPlugin =
       }),
 
       extendsPage: (page: Page<Partial<CopyrightPluginPageData>>): void => {
-        const authorText = typeof author === "function" ? author(page) : author;
+        const authorText = isFunction(author) ? author(page) : author;
 
-        const licenseText =
-          typeof license === "function" ? license(page) : license;
+        const licenseText = isFunction(license) ? license(page) : license;
 
         page.data.copyright = {
           ...(authorText ? { author: authorText } : {}),

diff --git a/packages/feed2/src/node/json/index.ts b/packages/feed2/src/node/json/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
+import { isArray } from "@vuepress/shared";
 import { stripTags } from "vuepress-shared/node";
 
 import type { Feed } from "../feed.js";
@@ -65,7 +66,7 @@ export const renderJSON = (feed: Feed): string => {
       feedItem.date_modified = item.lastUpdated.toISOString();
 
     // author
-    if (Array.isArray(item.author))
+    if (isArray(item.author))
       feedItem.authors = item.author
         .filter((author) => author.name)
         .map((author) => formatAuthor(author));