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

astro-prerender-patterns

v1.0.0

Published

Control rendering modes for all pages and endpoints in your Astro project right from the configuration.

Downloads

2

Readme

astro-prerender-patterns💈

This Astro integration allows you control rendering modes for all pages and endpoints in a single place.

Why astro-prerender-patterns?

If you are using astro for server side rendering, you can opt-in individual pages to be prerendered. However, you must do it by editing each file. This integration lets you control the rendering mode for all pages and endpoints right from the configuration file.

Installation

Manual Install

First, install the astro-prerender-patterns package using your package manager. If you're using npm or aren't sure, run this in the terminal:

npm install astro-prerender-patterns

Then, apply this integration to your astro.config.* file using the integrations property:

  // astro.config.mjs
  import { defineConfig } from 'astro/config';
+ import prerenderPatterns from 'astro-prerender-patterns';

  export default defineConfig({
    // ...
+   integrations: [prerenderPatterns()],
    //             ^^^^^^^^^^^^^^^^^^^
  });

Usage

Once the integration is installed and added to the configuration file, you can pass it a function that lets you decide which routes get prerendered.

export default defineConfig({
    // ...
    integrations: [
        prerenderPatterns(filePath => {
            if (filePath.endsWith(".astro")) return "prerender"
            if (filePath.endsWith(".ts")) return "render on demand"
        })
    ],
    // ...
});

The callback function receives the path of the file being rendered, relative to the root of your project. To override the current rendering mode, return either "prerender", or "render on demand". If neither of these two strings are returned, Astro's regular behavior as documented in On⁠-⁠demand Rendering Adapters applies.

If you would like to take into account the current rendering mode, you can read the second argument passed to the callback function:

export default defineConfig({
    // ...
    integrations: [
        prerenderPatterns((file, currentMode) => {
            if (currentMode === "prerender") return "render on demand"
        })
    ],
    // ...
});

For convenience, the strings "prerender" and "render on demand" are exported from the package as prerender and renderOnDemand respectively. You can use these to prevent typing mistakes:

import prerenderPatterns, { prerender, renderOnDemand } from "astro-prerender-patterns";

Troubleshooting

For help, check out the Discussions tab on the GitHub repo.

Contributing

This package is maintained by lilnasy independently from Astro. The integration code is located at packages/prerender-patterns/integration.ts. You're welcome to contribute by opening a PR or submitting an issue!

Changelog

See CHANGELOG.md for a history of changes to this integration.