feat: support progress display generation pdf

Author: condorheroblog

packages/vuepress-plugin-export-pdf-v2/package.json

@@ -55,6 +55,7 @@
     "@vuepress/utils": "2.0.0-beta.24",
     "bundle-require": "^3.0.4",
     "cac": "^6.7.12",
+    "cli-progress": "^3.11.2",
     "debug": "^4.3.4",
     "envinfo": "^7.8.1",
     "multimatch": "^6.0.0",
@@ -63,6 +64,7 @@
     "semver": "^7.3.7"
   },
   "devDependencies": {
+    "@types/cli-progress": "^3.11.0",
     "@types/envinfo": "^7.8.1",
     "@types/semver": "^7.3.10",
     "vuepress": "^2.0.0-beta.49"

packages/vuepress-plugin-export-pdf-v2/src/utils/generatePdf.ts

@@ -1,10 +1,10 @@
 import type { DevApp } from "vuepress";
 import type { PDFOptions, PuppeteerLaunchOptions } from "puppeteer";
-import { chalk, fs, logger, path } from "@vuepress/utils";
+import { chalk, fs, path } from "@vuepress/utils";
 import puppeteer from "puppeteer";
 import type { UserSorter } from "../configs";
 
-import { filterRoute } from "../utils";
+import { filterRoute, singleProgressBar } from "../utils";
 import { mergePDF } from "./mergePDF";
 
 interface IGeneratePdfOptions {
@@ -54,6 +54,9 @@ export const generatePdf = async(ctx: DevApp, {
     };
   });
 
+  const singleBar = singleProgressBar(`Generated Progress [{bar}] {percentage}%({value}/{total}) || ${yellow("{title}")} ${gray("{url}")}`);
+  singleBar.start(normalizePages.length, 0);
+
   const browser = await puppeteer.launch(puppeteerLaunchOptions);
 
   for (const { location, pagePath, url, title } of normalizePages) {
@@ -71,13 +74,15 @@ export const generatePdf = async(ctx: DevApp, {
       ...pdfOptions,
     });
 
-    const pathUrl = gray(`${url}`);
-
-    logger.success(`Generated ${yellow(title)} ${pathUrl}`);
-
     browserPage.close();
+
+    singleBar.increment(1, {
+      title,
+      url,
+    });
   }
 
+  singleBar.stop();
   await mergePDF(normalizePages, outFile, outDir);
 
   await browser.close();

packages/vuepress-plugin-export-pdf-v2/src/utils/index.ts

@@ -4,3 +4,4 @@ export * from "./generatePdf";
 export * from "./filterRoute";
 export * from "./checkEnv";
 export * from "./mergePDF";
+export * from "./progress";

packages/vuepress-plugin-export-pdf-v2/src/utils/progress.ts

@@ -0,0 +1,7 @@
+import cliProgress from "cli-progress";
+
+export const singleProgressBar = (format = "Progress |" + "{bar}" + "| {percentage} % || {value} / {total}", preset = cliProgress.Presets.shades_classic) => {
+  return new cliProgress.Bar({
+    format,
+  }, preset);
+};

packages/vuepress-plugin-export-pdf/package.json

@@ -54,6 +54,7 @@
     "@vuepress/utils": "2.0.0-beta.24",
     "bundle-require": "^3.0.4",
     "cac": "^6.7.12",
+    "cli-progress": "^3.11.2",
     "debug": "^4.3.4",
     "envinfo": "^7.8.1",
     "multimatch": "^6.0.0",
@@ -63,6 +64,7 @@
   },
   "devDependencies": {
     "@condorhero/vuepress-types": "workspace:^",
+    "@types/cli-progress": "^3.11.0",
     "@types/envinfo": "^7.8.1",
     "@types/semver": "^7.3.10",
     "vuepress": "^1.9.7"

packages/vuepress-plugin-export-pdf/src/utils/generatePdf.ts

@@ -1,10 +1,10 @@
 import type { Context } from "vuepress";
 import type { PDFOptions, PuppeteerLaunchOptions } from "puppeteer";
-import { chalk, fs, logger, path } from "@vuepress/utils";
+import { chalk, fs, path } from "@vuepress/utils";
 import puppeteer from "puppeteer";
 import type { UserSorter } from "../configs";
 
-import { filterRoute } from "../utils";
+import { filterRoute, singleProgressBar } from "../utils";
 import { mergePDF } from "./mergePDF";
 
 interface IGeneratePdfOptions {
@@ -54,6 +54,9 @@ export const generatePdf = async(ctx: Context, {
     };
   });
 
+  const singleBar = singleProgressBar(`Generated Progress [{bar}] {percentage}%({value}/{total}) || ${yellow("{title}")} ${gray("{url}")}`);
+  singleBar.start(normalizePages.length, 0);
+
   const browser = await puppeteer.launch(puppeteerLaunchOptions);
 
   for (const { location, pagePath, url, title } of normalizePages) {
@@ -71,13 +74,15 @@ export const generatePdf = async(ctx: Context, {
       ...pdfOptions,
     });
 
-    const pathUrl = gray(`${url}`);
-
-    logger.success(`Generated ${yellow(title)} ${pathUrl}`);
-
     browserPage.close();
+
+    singleBar.increment(1, {
+      title,
+      url,
+    });
   }
 
+  singleBar.stop();
   await mergePDF(normalizePages, outFile, outDir);
 
   await browser.close();

packages/vuepress-plugin-export-pdf/src/utils/index.ts

@@ -4,3 +4,4 @@ export * from "./generatePdf";
 export * from "./filterRoute";
 export * from "./checkEnv";
 export * from "./mergePDF";
+export * from "./progress";

packages/vuepress-plugin-export-pdf/src/utils/progress.ts

@@ -0,0 +1,7 @@
+import cliProgress from "cli-progress";
+
+export const singleProgressBar = (format = "Progress |" + "{bar}" + "| {percentage} % || {value} / {total}", preset = cliProgress.Presets.shades_classic) => {
+  return new cliProgress.Bar({
+    format,
+  }, preset);
+};