feat: Notify user of deprecated pdfFormat param.

kohheepeace · May 2, 2022 · ab95a98 · ab95a98
1 parent 577975a
commit ab95a98
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/src/cli.ts b/src/cli.ts
@@ -41,7 +41,8 @@ program
     'set margin around PDF file',
     generatePuppeteerPDFMargin,
   )
-  .option('--pdfFormat <format>', 'pdf format ex: A3, A4...')
+  .option('--pdfFormat <format>', '(DEPRECATED use paperFormat)') //TODO: Remove at next major version, replaced by paperFormat
+  .option('--paperFormat <format>', 'pdf format ex: A3, A4...')
   .option('--coverTitle <title>', 'title for PDF cover')
   .option('--coverImage <src>', 'image for PDF cover. *.svg file not working!')
   .option('--disableTOC', 'disable table of contents')
@@ -51,6 +52,10 @@ program
     'wait for document render in milliseconds',
   )
   .action((options: generatePDFOptions) => {
+    if (options.pdfFormat) {
+      console.log(chalk.red('--pdfFormat is deprecated, use --paperFormat'));
+      process.exit(1);
+    }
     generatePDF(options)
       .then(() => {
         console.log(chalk.green('Finish generating PDF!'));

diff --git a/src/utils.ts b/src/utils.ts
@@ -9,6 +9,8 @@ export interface generatePDFOptions {
   pdfMargin: puppeteer.PDFOptions['margin'];
   contentSelector: string;
   paginationSelector: string;
+  // deprecated - user paperFormat
+  pdfFormat?: puppeteer.PaperFormat;
   paperFormat: puppeteer.PaperFormat;
   excludeSelectors: Array<string>;
   cssStyle: string;