feat(config): add "routePatterns" config

Author: condorheroblog

packages/vuepress-plugin-export-pdf-v2/README.md

@@ -88,6 +88,7 @@ config options:
 - `sorter` - function for changing pages order (default `undefined`)
 - `outFile` - name of output file (default `vuepress-YYMMDD-HHmmss.pdf`)
 - `outDir` - Directory of output files (default `package.json` file exists in directory)
+- `routePatterns` - Specify the patterns of files you want to be exported. The patterns are relative to the source directory (default `["/**", "!/404.html"]`).Patterns to match Route path using [multimatch](https://github.com/sindresorhus/multimatch)
 - `puppeteerLaunchOptions` - [Puppeteer launch options object](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.puppeteerlaunchoptions.md)
 - `pdfOptions` - [Valid options to configure PDF generation via Page.pdf()](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.pdfoptions.md) (default `{ format: 'A4 }`)
 
@@ -115,6 +116,20 @@ for example:
 
 ![print-style.png](./assets/print-style.png)
 
+## Examples
+
+### Don't export homepage
+
+`.vuepress/vuepress-pdf.config.ts` add `routePatterns`:
+
+```ts
+export default defineUserConfig({
+  routePatterns: ["!/"],
+});
+```
+
+> Note: `!` at the beginning of a pattern will negate the match
+
 ## Contributing
 
 1. Fork it!

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

@@ -57,6 +57,7 @@
     "cac": "^6.7.12",
     "debug": "^4.3.4",
     "envinfo": "^7.8.1",
+    "multimatch": "^6.0.0",
     "pdfjs": "^2.4.7",
     "puppeteer": "^15.4.0",
     "semver": "^7.3.7"

packages/vuepress-plugin-export-pdf-v2/src/configs/userConfigTypes.ts

@@ -11,6 +11,7 @@ export interface UserConfig {
   bundler?: Bundler
   sorter?: UserSorter
   puppeteerLaunchOptions?: PuppeteerLaunchOptions
+  routePatterns?: string[]
   pdfOptions?: PDFOptions
   outFile?: string
   outDir?: string

packages/vuepress-plugin-export-pdf-v2/src/dev-server/vuePressServer.ts

@@ -37,6 +37,12 @@ export const vuePressServer = async(dir = "docs", commandOptions: CommandOptions
   if (userConfigPath)
     userConfig = await loadModule(userConfigPath);
 
+  // set default routePatterns
+  if (Array.isArray(userConfig.routePatterns))
+    userConfig.routePatterns = ["/**", "!/404.html", ...userConfig.routePatterns];
+  else
+    userConfig.routePatterns = ["/**", "!/404.html"];
+
   const vuepressOutFile = commandOptions.outFile ?? `vuepress-${timeTransformer()}.pdf`;
   const vuepressOutDir = commandOptions.outDir ?? ".";
 
@@ -50,6 +56,7 @@ export const vuePressServer = async(dir = "docs", commandOptions: CommandOptions
     pdfOptions,
     outFile = vuepressOutFile,
     outDir = vuepressOutDir,
+    routePatterns,
   } = userConfig;
 
   const devApp = createDevApp({ source: sourceDir, bundler, theme, host: "localhost", port: 8714 });
@@ -73,6 +80,7 @@ export const vuePressServer = async(dir = "docs", commandOptions: CommandOptions
       sorter,
       puppeteerLaunchOptions,
       pdfOptions,
+      routePatterns,
     });
   }
   catch (error) {

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

@@ -0,0 +1,13 @@
+import type { Page } from "vuepress";
+import multimatch from "multimatch";
+
+/**
+ * Filter route by a list of glob patterns.
+ * @param pages - List of pages.
+ * @param routePatterns= - List of glob patterns.
+ * @returns - List of pages that match the glob patterns.
+ */
+export const filterRoute = (pages: Page[], routePatterns: string[]) => {
+  const pagePaths = multimatch(pages.map(({ path }) => path), routePatterns);
+  return pages.filter(({ path }) => pagePaths.includes(path));
+};

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

@@ -4,13 +4,15 @@ import { chalk, fs, logger, path } from "@vuepress/utils";
 import puppeteer from "puppeteer";
 import type { UserSorter } from "../configs";
 
+import { filterRoute } from "../utils";
 import { mergePDF } from "./mergePDF";
 
 interface IGeneratePdfOptions {
   port: number
   host: string
   outFile: string
   outDir: string
+  routePatterns: string[]
   sorter?: UserSorter
   puppeteerLaunchOptions?: PuppeteerLaunchOptions
   pdfOptions?: PDFOptions
@@ -32,12 +34,13 @@ export const generatePdf = async(ctx: DevApp, {
   outDir,
   puppeteerLaunchOptions,
   pdfOptions,
+  routePatterns,
 }: IGeneratePdfOptions) => {
   const { pages, options: { temp: tempPath } } = ctx;
   const tempPdfDir = join(tempPath, "pdf");
   fs.ensureDirSync(tempPdfDir);
 
-  let exportPages = pages.slice(0);
+  let exportPages = filterRoute(pages, routePatterns);
 
   if (typeof sorter === "function")
     exportPages = exportPages.sort(sorter);

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

@@ -1,5 +1,6 @@
 export * from "./timeTransformer";
 export * from "./wrapCommand";
 export * from "./generatePdf";
+export * from "./filterRoute";
 export * from "./checkEnv";
 export * from "./mergePDF";

packages/vuepress-plugin-export-pdf/README.md

@@ -109,6 +109,7 @@ config options:
 - `sorter` - function for changing pages order (default `undefined`)
 - `outFile` - name of output file (default `vuepress-YYMMDD-HHmmss.pdf`)
 - `outDir` - Directory of output files (default `package.json` file exists in directory)
+- `routePatterns` - Specify the patterns of files you want to be exported. The patterns are relative to the source directory (default `["/**", "!/404.html"]`).Patterns to match Route path using [multimatch](https://github.com/sindresorhus/multimatch)
 - `puppeteerLaunchOptions` - [Puppeteer launch options object](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.puppeteerlaunchoptions.md)
 - `pdfOptions` - [Valid options to configure PDF generation via Page.pdf()](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.pdfoptions.md) (default `{ format: 'A4 }`)
 
@@ -136,6 +137,20 @@ for example:
 
 ![print-style.png](./assets/print-style.png)
 
+## Examples
+
+### Don't export homepage
+
+`.vuepress/vuepress-pdf.config.ts` add `routePatterns`:
+
+```ts
+export default defineUserConfig({
+  routePatterns: ["!/"],
+});
+```
+
+> Note: `!` at the beginning of a pattern will negate the match
+
 ## Contributing
 
 1. Fork it!

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

@@ -56,6 +56,7 @@
     "cac": "^6.7.12",
     "debug": "^4.3.4",
     "envinfo": "^7.8.1",
+    "multimatch": "^6.0.0",
     "pdfjs": "^2.4.7",
     "puppeteer": "^15.4.0",
     "semver": "^7.3.7"

packages/vuepress-plugin-export-pdf/src/configs/userConfigTypes.ts

@@ -10,6 +10,7 @@ export interface UserConfig {
   theme?: string
   sorter?: UserSorter
   puppeteerLaunchOptions?: PuppeteerLaunchOptions
+  routePatterns?: string[]
   pdfOptions?: PDFOptions
   outFile?: string
   outDir?: string