Playwright Runner

Playwright Runner is a set of runners for Playwright.

This module is intended to provide useful toolset for Re:VIEW, but it can also be used for general purpose applications.

Installation

Add this line to your application's Gemfile:

gem 'playwright-runner'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install playwright-runner

Of course PlaywrightRunner needs Playwright npm library.

$ npm install playwright    (locally)
$ npm install -g playwright (globally)

Usage

Mermaid to PNG, PDF or SVG

Let's convert HTML files contain Mermaid to PNG/PDF/SVG.

To get marginless PDF, you have to install pdfcrop from TeXLive.
To make SVG, you have to install pdftocairo from poppler.

On Debian GNU/Linux or its derivatives, ues apt-get install texlive-extra-utils poppler-utils.

Syntax

config = {  # you can omit them if you don't want to change anything
  playwright_path: './node_modules/.bin/playwright',  # playwright binary path
  selfcrop: true,  # use chromium's crop logic. if you'd like to use better cropping, set this to false
  pdfcrop_path: 'pdfcrop',  # pdfcrop path (will be ignored when selfcrop: true)
  pdftocairo_path: 'pdftocairo'  # pdftocairo path
}

PlaywrightRunner.mermaids_to_images(
  config,  # config hash. if you want to use default values, specify {}
  src: '.',  # source folder contains html files
  dest: '.',  # destination folder to export pdf or svg
  type: 'pdf'  # 'png', 'pdf', or 'svg'
)

It converts all HTML files in the folder specified by src into PNG, PDF or SVG files (specified by type) using that name and writes them in the folder specified by dest.

Example

For Example, here is p1.html contains Mermaid code.

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <script type="module">import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs'; mermaid.initialize({ startOnLoad: true });</script>
</head>
<body>
<div id="p1">
<pre class="mermaid">
graph TD
A[Client] --> B[Load Balancer]
B --> C[Server1]
B --> D[Server2]
</pre>
</div>
</body>
</html>

Now convert it to PDF. p1.pdf will be created.

require 'playwrightrunner'

PlaywrightRunner.mermaids_to_images(
  {
    playwright_path: './node_modules/.bin/playwright'  # modify for your env
  },
  src: '.',
  dest: '.',
  type: 'pdf'
)

Convert it to SVG. p1.svg will be created.

require 'playwrightrunner'

PlaywrightRunner.mermaids_to_images(
  {
    playwright_path: './node_modules/.bin/playwright',  # modify for your env
    pdftocairo: 'pdftocairo'  # set the path to your pdftocairo
  },
  src: '.',
  dest: '.',
  type: 'svg'
)

Convert it to PNG. p1.png will be created.

require 'playwrightrunner'

PlaywrightRunner.mermaids_to_images(
  {
    playwright_path: './node_modules/.bin/playwright'  # modify for your env
  },
  src: '.',
  dest: '.',
  type: 'png'
)

about outside margin of images

In the default settings, white margins occur around the image. This is chromium's specification. To avoid this, you need to crop the PDF using the external command pdfcrop.

After installing pdfcrop, specify selfcrop: false on config.

require 'playwrightrunner'

PlaywrightRunner.mermaids_to_images(
  {
    playwright_path: './node_modules/.bin/playwright'  # modify for your env
    selfcrop: false,
    pdfcrop_path: 'pdfcrop'  # set the path to your pdfcrop
  },
  src: '.',
  dest: '.',
  type: 'pdf'
)

License

Copyright (c) 2023 Kenshi Muto

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.