Crate perseus_macro

source · [−]
Expand description

Perseus

Book API Docs Crate Page Top Language Discord Chat

Perseus is a blazingly fast frontend web development framework built in Rust with support for generating page state at build-time, request-time, incrementally, or whatever you’d like! It supports reactivity using Sycamore, and builds on it to provide a fully-fledged framework for developing modern apps.

  • 📕 Supports static generation (serving only static resources)
  • 🗼 Supports server-side rendering (serving dynamic resources)
  • 🔧 Supports revalidation after time and/or with custom logic (updating rendered pages)
  • 🛠️ Supports incremental regeneration (build on demand)
  • 🏭 Open build matrix (use any rendering strategy with anything else)
  • 🖥️ CLI harness that lets you build apps with ease and confidence
  • 🌐 Full i18n support out-of-the-box with Fluent
  • 🏎 Lighthouse scores of 100 on desktop and over 95 on mobile
  • ⚡ Support for hot state reloading (reload your entire app’s state after you make any code changes in development, Perseus is the only framework in the world that can do this, to our knowledge)

What’s it like?

Here’s a taste of Perseus (see the tiny example for more):

ⓘ
use perseus::{Html, PerseusApp, Template};
use sycamore::view;

#[perseus::main(perseus_warp::dflt_server)]
pub fn main<G: Html>() -> PerseusApp<G> {
    PerseusApp::new().template(|| {
        Template::new("index").template(|cx, _| {
            view! { cx,
                p { "Hello World!" }
            }
        })
    })
}

Check out the book to learn how to turn that into your next app!

Quick start

If you want to start working with Perseus right away, run the following commands and you’ll have a basic app ready in no time! (Or, more accurately, after Cargo compiles everything…)

cargo install perseus-cli --version 0.4.0-beta.4
perseus new my-app
cd my-app/
perseus serve -w

Then, hop over to http://localhost:8080 and see a placeholder app, in all its glory! If you change some code, that’ll automatically update, reloading the browser all by itself. (This rebuilding might take a while though, see here for how to speed things up.)

Check out our getting started tutorial for more, or head over to out core principles page, which explains the basics of how Perseus works. Enjoy!

Aim

Support every major rendering strategy and provide developers the ability to efficiently create super-fast apps with Rust and a fantastic developer experience!

Motivation

There is a sore lack of Rust frameworks for frontend development that support more than just SPAs and client-side rendering, and so Perseus was born. We need something like NextJS for Wasm. But why stop there?

Contributing

We appreciate all kinds of contributions, check out our contributing guidelines for more information! Also, please be sure to follow our code of conduct.

You can also chat about Perseus on our channel on Sycamore’s Discord server.

License

See LICENSE.

Features

  • live-reload – enables reloading the browser automatically when you make changes to your app
  • hsr – enables hot state reloading, which reloads the state of your app right before you made code changes in development, allowing you to pick up where you left off

Packages

This is the API documentation for the perseus-macro package, which manages Perseus’ procedural macros. Note that Perseus mostly uses the book for documentation, and this should mostly be used as a secondary reference source. You can also find full usage examples here.

Attribute Macros

amalgamate_states

Annotates functions used for amalgamating build-time and request-time states to support automatic serialization/deserialization of app state and client/server division. This supersedes the old autoserde macro for state amalgamation functions.

browser

Marks the annotated code as only to be run in the browser. This is the opposite of (and mutually exclusive with) #[engine]. This resolves to a target-gate that makes the annotated code run only on targets that are wasm32.

browser_main

Marks the given function as the browser entrypoint into your app. This is designed for more complex apps that need to manually distinguish between the engine and browser entrypoints.

build_paths

Annotates functions used for generating paths at build time to support automatic serialization/deserialization of app state and client/server division. This supersedes the old autoserde macro for build paths functions.

build_state

Annotates functions used for generating state at build time to support automatic serialization/deserialization of app state and client/server division. This supersedes the old autoserde macro for build state functions.

engine

Marks the annotated code as only to be run as part of the engine (the server, the builder, the exporter, etc.). This resolves to a target-gate that makes the annotated code run only on targets that are not wasm32.

engine_main

Marks the given function as the engine entrypoint into your app. This is designed for more complex apps that need to manually distinguish between the engine and browser entrypoints.

global_build_state

Annotates functions used for generating global state at build time to support automatic serialization/deserialization of app state and client/server division. This supersedes the old autoserde macro for global build state functions.

head

Labels a function as a Perseus head function, which is very similar to a template, but for the HTML metadata in the document <head>.

main

Marks the given function as the universal entrypoint into your app. This is designed for simple use-cases, and the annotated function should return a PerseusApp. This will expand into separate main() functions for both the browser and engine sides.

main_export

This is identical to #[main], except it doesn’t require a server integration, because it sets your app up for exporting only. This is useful for apps not using server-requiring features (like incremental static generation and revalidation) that want to avoid bringing in another dependency on the server-side.

make_rx

Processes the given struct to create a reactive version by wrapping each field in a Signal. This will generate a new struct with the given name and implement a .make_rx() method on the original that allows turning an instance of the unreactive struct into an instance of the reactive one.

request_state

Annotates functions used for generating state at request time to support automatic serialization/deserialization of app state and client/server division. This supersedes the old autoserde macro for request state functions.

set_headers

Annotates functions used for generating state at build time to support automatic serialization/deserialization of app state and client/server division. This supersedes the old autoserde macro for build state functions.

should_revalidate

Annotates functions used for checking if a template should revalidate and request-time states to support automatic serialization/deserialization of app state and client/server division. This supersedes the old autoserde macro for revalidation determination functions.

template

Labels a Sycamore component as a Perseus template, turning it into something that can be easily inserted into the .template() function, avoiding the need for you to manually serialize/deserialize things. This should be provided the name of the Sycamore component (same as given to Sycamore’s #[component()], but without the <G>).

template_rx

The new version of #[template] designed for reactive state. This can interface automatically with global state, and will automatically provide Sycamore #[component] annotations. To use this, you don’t need to provide anything other than an optional custom type parameter letter (by default, G will be used). Unlike with the original macro, this will automatically handle component names internally.

test

Marks the given function as a Perseus test. Functions marked with this attribute must have the following signature: async fn foo(client: &mut fantoccini::Client) -> Result<>.