html2pdf icon indicating copy to clipboard operation
html2pdf copied to clipboard

feat: add version flag

Open kachick opened this issue 8 months ago • 0 comments

  • The --version flag is useful for testing in package managers such as nixpkgs.
  • It is unclear whether this feature was introduced in an earlier version (e.g., as mentioned in the 0.4.0 README) or if this is the first time it has been added.

Before

> ./target/debug/html2pdf --version
error: unexpected argument '--version' found

  tip: to pass '--version' as a value, use '-- --version'

Usage: html2pdf [OPTIONS] <INPUT>

For more information, try '--help'.

> ./target/debug/html2pdf --help
Generate a PDF from a local HTML file using a headless chrome

Usage: html2pdf [OPTIONS] <INPUT>

Arguments:
  <INPUT>  Input HTML file

Options:
  -o, --output <OUTPUT>  Output file. By default, just change the input extension to PDF
      --landscape        Use landscape mode
      --background       Allow print background
      --wait <WAIT>      Time to wait in ms before printing. Examples: 150ms, 10s
      --header <HEADER>  HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: date for formatted print date, title for document title, url for document location, pageNumber for current page number, totalPages for total pages in the document. For example, `<span class=title></span>` would generate span containing the title
      --footer <FOOTER>  HTML template for the print footer. Should use the same format as the headerTemplate
      --paper <PAPER>    Paper size. Supported values: A4, Letter, A3, Tabloid, A2, A1, A0, A5, A6
      --scale <SCALE>    Scale, default to 1.0
      --range <RANGE>    Paper ranges to print, e.g. '1-5, 8, 11-13'
      --margin <MARGIN>  Margin in inches You can define margin like this: '0.4' the value is applied for all side, '0.4 0.4' : first value is applied for top and bottom, second for left and right, '0.4 0.4 0.4 0.4' : first value is applied for top then, right, then bottom, and last for left
      --disable-sandbox  Disable Chrome sandbox Not recommended, unless running on docker
  -h, --help             Print help

After

> ./target/debug/html2pdf --version
html2pdf 0.8.2

> ./target/debug/html2pdf --help
Generate a PDF from a local HTML file using a headless chrome

Usage: html2pdf [OPTIONS] <INPUT>

Arguments:
  <INPUT>  Input HTML file

Options:
  -o, --output <OUTPUT>  Output file. By default, just change the input extension to PDF
      --landscape        Use landscape mode
      --background       Allow print background
      --wait <WAIT>      Time to wait in ms before printing. Examples: 150ms, 10s
      --header <HEADER>  HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: date for formatted print date, title for document title, url for document location, pageNumber for current page number, totalPages for total pages in the document. For example, `<span class=title></span>` would generate span containing the title
      --footer <FOOTER>  HTML template for the print footer. Should use the same format as the headerTemplate
      --paper <PAPER>    Paper size. Supported values: A4, Letter, A3, Tabloid, A2, A1, A0, A5, A6
      --scale <SCALE>    Scale, default to 1.0
      --range <RANGE>    Paper ranges to print, e.g. '1-5, 8, 11-13'
      --margin <MARGIN>  Margin in inches You can define margin like this: '0.4' the value is applied for all side, '0.4 0.4' : first value is applied for top and bottom, second for left and right, '0.4 0.4 0.4 0.4' : first value is applied for top then, right, then bottom, and last for left
      --disable-sandbox  Disable Chrome sandbox Not recommended, unless running on docker
  -h, --help             Print help
  -V, --version          Print version

kachick avatar Apr 13 '25 12:04 kachick