npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@greenwood/plugin-renderer-puppeteer

v0.30.2

Published

A Greenwood plugin to allow headless browser rendering with Puppeteer.

Downloads

423

Readme

plugin-renderer-puppeteer

Overview

A Greenwood plugin for using Puppeteer as a custom pre-rendering solution. As Puppeteer is a headless browser, it provides a lot more power and capabilities for fully rendering things like Web Components, GraphQL calls, and other very browser dependent features. For more information and complete docs on Greenwood, please visit our website.

This package assumes you already have @greenwood/cli installed.

Installation

You can use your favorite JavaScript package manager to install this package.

# npm
$ npm i -D @greenwood/plugin-renderer-puppeteer

# yarn
$ yarn add @greenwood/plugin-renderer-puppeteer --dev

# pnpm
$ pnpm add -D @greenwood/plugin-renderer-puppeteer

Usage

Add this plugin to your greenwood.config.js:

import { greenwoodPluginRendererPuppeteer } from '@greenwood/plugin-renderer-puppeteer';

export default {
  // ...

  plugins: [
    greenwoodPluginRendererPuppeteer()
  ]
}

Now, when running greenwood build, all your pages will get run through Puppeteer and any JavaScript / Web Components that you author will get a one time pass execution and the resulting HTML generated from that process will be captured and further optimized through Greenwood's build pipeline.

Caveats

Limitations

Given this plugin instruments an entire browser, this plugin only supports Greenwood's prerender configuration option and so will NOT be viable for any SSR or Serverless and Edge features. Instead, Greenwood will be focusing on making WCC the default and recommended first-party solution.

In addition, puppeteer also leverages npm postinstall scripts which in some environments, like Stackblitz, would be disabled and so YMMV.

Dependencies

You may need to install additional Operating System level libraries and dependencies depending on the system you are running on to support headless Chrome. For example, for a Docker based environment like GitHub Actions, you would need to add this below setup script (or similar) to your runner

#!/usr/bin/bash

# path/to/your/chromium-lib-install.sh
sudo apt-get update \\
  && sudo apt-get install -yq libgconf-2-4 \\
  && sudo apt-get install -y wget --no-install-recommends \\
  && sudo wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add - \\
  && sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \\
  && sudo apt-get update \\
  && sudo apt-get install -y google-chrome-unstable fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst fonts-freefont-ttf --no-install-recommends \\
  && sudo rm -rf /var/lib/apt/lists/*

jobs:
 build:
   runs-on: ubuntu-latest
   steps:
      - uses: actions/checkout@v1
      - name: Install Chromium Library Dependencies
        run: |
         sh path/to/your/chromium-lib-install.sh
      - uses: actions/setup-node@v1
        with:
           node-version: "18.x"

See the Puppeteer Troubleshooting docs for more info on setting up your specific environment.