docs(examples): 🚚 merged basic/cli examples and cleaned up examples

Author: arctic-hen7

Cargo.toml

@@ -4,6 +4,6 @@ members = [
     "examples/*",
     # We have the CLI subcrates as workspace members so we can actively develop on them
     # They also can't be a workspace until nested workspaces are supported
-    "examples/cli/.perseus",
-    "examples/cli/.perseus/server"
+    "examples/basic/.perseus",
+    "examples/basic/.perseus/server"
 ]

bonnie.toml

@@ -5,7 +5,7 @@ dev.subcommands.cli.cmd = [
 	"cd packages/perseus-cli",
     # We need to copy in the directory where we actually work on the subcrate
     "rm -rf ./.perseus",
-    "cp -r ../../examples/cli/.perseus/ .perseus/",
+    "cp -r ../../examples/basic/.perseus/ .perseus/",
     "mv .perseus/Cargo.toml .perseus/Cargo.toml.old",
     "mv .perseus/server/Cargo.toml .perseus/server/Cargo.toml.old",
 	"cargo run -- %%"
@@ -15,7 +15,7 @@ dev.subcommands.example.cmd = [
     "cd packages/perseus-cli",
     # We need to copy in the directory where we actually work on the subcrate
     "rm -rf ./.perseus",
-    "cp -r ../../examples/cli/.perseus/ .perseus/",
+    "cp -r ../../examples/basic/.perseus/ .perseus/",
     "mv .perseus/Cargo.toml .perseus/Cargo.toml.old",
     "mv .perseus/server/Cargo.toml .perseus/server/Cargo.toml.old",
     # Now point this live version of the CLI at the given example
@@ -75,7 +75,7 @@ publish.cmd = [
     # The CLI needs the `.perseus/` directory copied in for packaging (and we need to rename `Cargo.toml` to `Cargo.toml.old`)
     "cd ../perseus-cli",
     "rm -rf ./.perseus",
-    "cp -r ../../examples/cli/.perseus/ .perseus/",
+    "cp -r ../../examples/basic/.perseus/ .perseus/",
     "mv .perseus/Cargo.toml .perseus/Cargo.toml.old",
     "mv .perseus/server/Cargo.toml .perseus/server/Cargo.toml.old",
     "cargo publish --allow-dirty %%", # Without this flag, `.perseus` will be a problem because it's not in Git

examples/README.md

@@ -5,6 +5,7 @@ This folder contains examples for Perseus, which are used to test the project an
 These examples are all fully self-contained, and do not serve as examples in the traditional Cargo way, they are each indepedent crates to enable the use of build tools such as `wasm-pack`.
 
 -   Showcase -- an app that demonstrates all the different features of Perseus, including SSR, SSG, and ISR (this example is actively used for testing/development)
--   Basic -- a simple app that uses the Perseus CLI (symlinks to CLI example)
--   CLI -- same as basic, but includes the CLI subcrates (actively used for testing/development)
+-   Basic -- a simple app that uses the Perseus CLI
+    -   This has `.perseus/` included in Git, it's where that's developed
 -   i18n -- a simple app that showcases internationalization in particular
+-   Tiny -- the smallest Perseus can get, the _Hello World!_ example

examples/basic/.gitignore

@@ -1,20 +1,12 @@
-# This package is a testing playground for the CLI subcrates, which are stored here under `.perseus/`.
-# Use the `basic` example for learning
-
 [package]
-name = "perseus-example-basic"
+name = "perseus-example-cli"
 version = "0.1.4"
 edition = "2018"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 perseus = { path = "../../packages/perseus" }
-sycamore = { version = "0.6", features = ["ssr"] }
-sycamore-router = "0.6"
+sycamore = "0.6"
 serde = { version = "1", features = ["derive"] }
-serde_json = "1" # Possibly don't need?
-
-# This section is needed for Wasm Pack (which we use instead of Trunk for flexibility)
-[lib]
-crate-type = ["cdylib", "rlib"]
+serde_json = "1"

examples/cli/.perseus/.gitignore renamed to examples/basic/.perseus/.gitignore

@@ -3,9 +3,9 @@ use std::rc::Rc;
 use sycamore::template;
 
 pub fn get_error_pages<G: GenericNode>() -> ErrorPages<G> {
-    let mut error_pages = ErrorPages::new(Rc::new(|_, _, _, _| {
+    let mut error_pages = ErrorPages::new(Rc::new(|url, status, err, _| {
         template! {
-            p { "Another error occurred." }
+            p { (format!("An error with HTTP code {} occurred at '{}': '{}'.", status, url, err)) }
         }
     }));
     error_pages.add_page(
@@ -16,14 +16,6 @@ pub fn get_error_pages<G: GenericNode>() -> ErrorPages<G> {
             }
         }),
     );
-    error_pages.add_page(
-        400,
-        Rc::new(|_, _, _, _| {
-            template! {
-                p { "Client error occurred..." }
-            }
-        }),
-    );
 
     error_pages
 }

examples/cli/.perseus/Cargo.toml renamed to examples/basic/.perseus/Cargo.toml

@@ -1,12 +1,12 @@
 mod error_pages;
-mod pages;
+mod templates;
 
 use perseus::define_app;
 
 define_app! {
     templates: [
-        crate::pages::index::get_page::<G>(),
-        crate::pages::about::get_page::<G>()
+        crate::templates::index::get_template::<G>(),
+        crate::templates::about::get_template::<G>()
     ],
     error_pages: crate::error_pages::get_error_pages(),
     static_aliases: {

examples/cli/.perseus/server/Cargo.toml renamed to examples/basic/.perseus/server/Cargo.toml

@@ -9,7 +9,7 @@ pub fn about_page() -> SycamoreTemplate<G> {
     }
 }
 
-pub fn get_page<G: GenericNode>() -> Template<G> {
+pub fn get_template<G: GenericNode>() -> Template<G> {
     Template::new("about")
         .template(template_fn())
         .head(head_fn())

examples/cli/.perseus/server/src/main.rs renamed to examples/basic/.perseus/server/src/main.rs

@@ -1,7 +1,7 @@
-use perseus::{StringResultWithCause, Template};
+use perseus::{GenericNode, StringResultWithCause, Template};
 use serde::{Deserialize, Serialize};
 use std::rc::Rc;
-use sycamore::prelude::{component, template, GenericNode, Template as SycamoreTemplate};
+use sycamore::prelude::{component, template, Template as SycamoreTemplate};
 
 #[derive(Serialize, Deserialize, Debug)]
 pub struct IndexPageProps {
@@ -16,14 +16,14 @@ pub fn index_page(props: IndexPageProps) -> SycamoreTemplate<G> {
     }
 }
 
-pub fn get_page<G: GenericNode>() -> Template<G> {
+pub fn get_template<G: GenericNode>() -> Template<G> {
     Template::new("index")
-        .build_state_fn(Rc::new(get_static_props))
+        .build_state_fn(Rc::new(get_build_props))
         .template(template_fn())
         .head(head_fn())
 }
 
-pub async fn get_static_props(_path: String) -> StringResultWithCause<String> {
+pub async fn get_build_props(_path: String) -> StringResultWithCause<String> {
     Ok(serde_json::to_string(&IndexPageProps {
         greeting: "Hello World!".to_string(),
     })

examples/cli/.perseus/src/bin/build.rs renamed to examples/basic/.perseus/src/bin/build.rs

@@ -4,6 +4,7 @@
         <meta charset="UTF-8" />
         <meta http-equiv="X-UA-Compatible" content="IE=edge" />
         <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title>Perseus Example – Tiny</title>
     </head>
     <body>
         <div id="root"></div>