jorgenevens / crpdf Goto Github PK

View Code? Open in Web Editor NEW

8.0 3.0 2.0 144 KB

Print HTML to PDF using puppeteer with a wkhtmltopdf compatible CLI

Home Page: https://crpdf.evens.eu

License: MIT License

JavaScript 100.00%

puppeteer pdf wkhtmltopdf printpdf

crpdf's Introduction

crPDF

Print HTML to PDF using Puppeteer with a wkhtmltopdf compatible CLI.

Motivation

While creating print versions of HTML on modern browsers is not fun, it is not an impossible feat. Getting HTML to PDF tools to render correctly on the other hand is very challenging. That is why this project leverages Puppeteer (Headless Chrome/Chromium) to generate PDFs from HTML. If you can get your layout to work using print preview on Chrome you will be good to go using this library.

Many of us have relied on wkhtmltopdf over the years, and it has great library support. To make transitioning as easy as possible crPDF matches the CLI options which allows you to use crPDF as a drop-in replacement.

Installation

Using NPM

Use NPM to install the latest version of crPDF, this package will install both a crpdf and wkhtmltopdf binary.

npm install -g crpdf

Manual

Download a binary for your platform from the releases page and place it in your $PATH.

curl -L -o crpdf <release url>
chmod +x crpdf

cp crpdf /usr/local/bin/crpdf

# Optionally set up an alias for wkhtmltopdf
ln -s /usr/local/bin/crpdf /usr/local/bin/wkhtmltopdf

Usage

The CLI interface is meant to be compatible with the wkhtmltopdf binary such that it can be used as a drop-in replacement for existing libraries using wkhtmltopdf.

Below is a list of options currently implemented by this project.

crpdf --help

  Usage: cli [options] [input] [output]


  Options:

    -V, --version                    output the version number
    -B, --margin-bottom <unitreal>   Set the page bottom margin
    -L, --margin-left <unitreal>     Set the page left margin (default 10mm)
    -R, --margin-right <unitreal>    Set the page right margin (default 10mm)
    -T, --margin-top <unitreal>      Set the page top margin
    -O, --orientation <orientation>  Set orientation to Landscape or Portrait (default Portrait)
    -s, --page-size <Size>           Set paper size to: A4, Letter, etc. (default A4)
    --page-height <unitreal>         Page height
    --page-width <unitreal>          Page width
    --page-ranges <range>            Page ranges to print, e.g., "1-5, 8, 11-13" (default all)
    --background                     Do print background
    --no-background                  Do not print background
    -h, --help                       output usage information

Note, --page-ranges is not available in wkhtmltopdf and thus not backwards compatible.

Contributing

I really appreciate any contribution you would like to make, so don't hesitate to report an issue or submit pull requests.

About me

Hi, my name is Jorgen Evens. By day I built things (mainly in PHP and JavaScript) for Ambassify and by night I tinker around with these kinds of projects.

crpdf's People

Contributors

Stargazers

Watchers

Forkers

tlvince icnocop

crpdf's Issues

Incompatible behavior if `-` is specified as the `output`

When I use wkhtmltox 0.12.5-1.msvc2015-win64 and run the following command:
wkhtmltopdf.exe TestPage.html -

wkhtmltopdf.exe will output the PDF file contents to the console (stdout) instead of to a file.

However, crPDF.exe will output the PDF to a file with the file name -.

I expected crPDF to behave the same as wkhtmltopdf and output the PDF file contents to the console.

Thank you.

Add support for `--outline` and `--no-outline`

wkhtmltopdf supports the --outline and --no-outline command line options.

See https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

If an outline isn't supported in puppeteer, I'm thinking crPDF should just ignore the command line options.

Currently, crPDF outputs error: unknown option '--no-outline' and doesn't produce the expected output.

Thank you.

UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, open '-'

I used wkhtmltopdf and everything worked, but then our hosting provider said to try your library, because wkhtmltopdf is heavy, and I got this error:

OSError at /admin/fulfilment-report/
wkhtmltopdf reported an error:
(node:17000) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, open '-'
    at Object.fs.openSync (fs.js:646:18)
    at Object.fs.readFileSync (fs.js:551:33)
    at toPDF (/Users/mirzadelic/.nvm/versions/node/v8.15.0/lib/node_modules/crpdf/src/index.js:49:33)
    at Object.<anonymous> (/Users/mirzadelic/.nvm/versions/node/v8.15.0/lib/node_modules/crpdf/src/cli.js:47:1)
    at Module._compile (module.js:653:30)
    at Object.Module._extensions..js (module.js:664:10)
    at Module.load (module.js:566:32)
    at tryModuleLoad (module.js:506:12)
    at Function.Module._load (module.js:498:3)
    at Function.Module.runMain (module.js:694:10)
(node:17000) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:17000) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Any solution?

Thanks.

Add support for `--javascript-delay`

Hi.

Thank you for crPDF.

wkhtmltopdf supports the --javascript-delay command line option.

See https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

If a javascript delay isn't supported in puppeteer, I'm thinking crPDF should just ignore the command line option.

Currently, crPDF outputs error: unknown option '--javascript-delay' and doesn't produce the expected output.

Thank you.

Add support for `--encoding`

wkhtmltopdf supports the --encoding command line option.

See https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

If the ability to specify an encoding isn't supported in puppeteer, I'm thinking crPDF should just ignore the command line options.

Currently, crPDF outputs error: unknown option '--encoding' and doesn't produce the expected output.

Thank you.

Add support for `--read-args-from-stdin`

wkhtmltopdf supports the --read-args-from-stdin command line option.

See https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

Currently, crPDF outputs error: unknown option '--read-args-from-stdin' and doesn't produce the expected output.

Thank you.

Add support for multiple input pages

wkhtmltopdf supports multiple input pages on the command line.

See https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

Currently, crPDF doesn't produce the expected output if more than one page object is specified on the command line.

For example, wkhtmltopdf "Page1.html" "Page2.html" -

Thank you.

Add support for `-q`

wkhtmltopdf supports the -q and --quiet command line options.

See https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

Currently, crPDF outputs error: unknown option '--q' and doesn't produce the expected output.

Thank you.

Add support for `--user-style-sheet`

wkhtmltopdf supports the --user-style-sheet command line option.

See https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

If the ability to specify a user style sheet isn't supported in puppeteer, I'm thinking crPDF should just ignore the command line options.

Currently, crPDF outputs error: unknown option '--user-style-sheet' and doesn't produce the expected output.

Thank you.

jorgenevens / crpdf Goto Github PK

crpdf's Introduction

crPDF

Motivation

Installation

Using NPM

Manual

Usage

Contributing

About me

crpdf's People

Contributors

Stargazers

Watchers

Forkers

crpdf's Issues

Recommend Projects

Recommend Topics

Recommend Org