-
📦✨ Dioxus CLI
+
+
📦✨ Dioxus CLI
Tooling to supercharge Dioxus projects
-**dioxus-cli** (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running.
-It handles all build, bundling, development and publishing to simplify web development.
+The **dioxus-cli** (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running.
+It handles all building, bundling, development and publishing to simplify development.
## Installation
-### Install stable version
+### Install the stable version (recommended)
+
```
-cargo install dioxus-cli
+cargo install dioxus-cli --locked
```
-### Install from git repository
+
+### Install the latest development build through git
+
+To get the latest bug fixes and features, you can install the development version from git.
+However, this is not fully tested.
+That means you're probably going to have more bugs despite having the latest bug fixes.
+
```
cargo install --git https://github.com/DioxusLabs/dioxus dioxus-cli
```
+
+This will download the CLI from the master branch,
+and install it in Cargo's global binary directory (`~/.cargo/bin/` by default).
+
### Install from local folder
+
```
cargo install --path . --debug
```
+## Get started
-## Get Started
-
-Use `dx create project-name` to initialize a new Dioxus project.
-
+Use `dx create project-name` to initialize a new Dioxus project.
It will be cloned from the [dioxus-template](https://github.com/DioxusLabs/dioxus-template) repository.
-
-
Alternatively, you can specify the template path:
```
dx create hello --template gh:dioxuslabs/dioxus-template
```
-## Dioxus Config File
+Run `dx --help` for a list of all the available commands.
+Furthermore, you can run `dx
--help` to get help with a specific command.
-Dioxus CLI will use `Dioxus.toml` file to Identify some project info and switch some cli feature.
+## Dioxus config file
-You can get more configure information from [Dioxus CLI Document](https://dioxuslabs.com/cli/configure.html).
+You can use the `Dioxus.toml` file for further configuration.
+Some fields are mandatory, but the CLI tool will tell you which ones are missing.
+You can create a `Dioxus.toml` with all fields already set using `dx config init project-name`,
+or you can use this bare-bones template (only mandatory fields) to get started:
+
+```toml
+[application]
+name = "project-name"
+# Currently supported platforms: web, desktop
+default_platform = "web"
+
+[web.app]
+title = "Hello"
+
+[web.watcher]
+
+[web.resource.dev]
+```
+
+The full anatomy of `Dioxus.toml` is shown on the [Dioxus website](https://dioxuslabs.com/learn/0.4/CLI/configure).
diff --git a/packages/cli/docs/book.toml b/packages/cli/docs/book.toml
index c5c216fe4..a1e57f634 100644
--- a/packages/cli/docs/book.toml
+++ b/packages/cli/docs/book.toml
@@ -3,4 +3,4 @@ authors = ["YuKun Liu"]
language = "en"
multilingual = false
src = "src"
-title = "Dioxus Cli"
+title = "Dioxus CLI"
diff --git a/packages/cli/docs/src/SUMMARY.md b/packages/cli/docs/src/SUMMARY.md
index b5e3b91ae..98a66ae21 100644
--- a/packages/cli/docs/src/SUMMARY.md
+++ b/packages/cli/docs/src/SUMMARY.md
@@ -2,17 +2,12 @@
- [Introduction](./introduction.md)
- [Installation](./installation.md)
-- [Create a Project](./creating.md)
-- [Configure Project](./configure.md)
-- [Commands](./cmd/README.md)
- - [Build](./cmd/build.md)
- - [Serve](./cmd/serve.md)
- - [Clean](./cmd/clean.md)
- - [Translate](./cmd/translate.md)
-- [Plugin Development](./plugin/README.md)
- - [API.Log](./plugin/interface/log.md)
- - [API.Command](./plugin/interface/command.md)
- - [API.OS](./plugin/interface/os.md)
- - [API.Directories](./plugin/interface/dirs.md)
- - [API.Network](./plugin/interface/network.md)
- - [API.Path](./plugin/interface/path.md)
\ No newline at end of file
+- [Create a project](./creating.md)
+- [Configure a project](./configure.md)
+- [Plugin development](./plugin/README.md)
+ - [API.Log](plugin/interface/log.md)
+ - [API.Command](plugin/interface/command.md)
+ - [API.OS](plugin/interface/os.md)
+ - [API.Directories](plugin/interface/dirs.md)
+ - [API.Network](plugin/interface/network.md)
+ - [API.Path](plugin/interface/path.md)
\ No newline at end of file
diff --git a/packages/cli/docs/src/cmd/README.md b/packages/cli/docs/src/cmd/README.md
deleted file mode 100644
index 735794635..000000000
--- a/packages/cli/docs/src/cmd/README.md
+++ /dev/null
@@ -1,30 +0,0 @@
-# Commands
-
-In this chapter we will introduce all `dioxus-cli` commands.
-
-> You can also use `dx --help` to get cli help info.
-
-```
-Build, Bundle & Ship Dioxus Apps
-
-Usage: dx [OPTIONS]
-
-Commands:
- build Build the Rust WASM app and all of its assets
- translate Translate some source file into Dioxus code
- serve Build, watch & serve the Rust WASM app and all of its assets
- create Init a new project for Dioxus
- clean Clean output artifacts
- bundle Bundle the Rust desktop app and all of its assets
- version Print the version of this extension
- fmt Format some rsx
- check Check the Rust files in the project for issues
- config Dioxus config file controls
- help Print this message or the help of the given subcommand(s)
-
-Options:
- -v Enable verbose logging
- --bin Specify bin target
- -h, --help Print help
- -V, --version Print version
-```
diff --git a/packages/cli/docs/src/cmd/build.md b/packages/cli/docs/src/cmd/build.md
deleted file mode 100644
index 6109d14f1..000000000
--- a/packages/cli/docs/src/cmd/build.md
+++ /dev/null
@@ -1,56 +0,0 @@
-# Build
-
-The `dx build` command can help you `pack & build` a dioxus project.
-
-```
-dioxus-build
-Build the Rust WASM app and all of its assets
-
-USAGE:
- dx build [OPTIONS]
-
-OPTIONS:
- --example [default: ""]
- --platform [default: "default_platform"]
- --release [default: false]
- --bin [default: None]
-```
-
-You can use this command to build a project:
-
-```
-dx build --release
-```
-
-## Target platform
-
-Use the `platform` option to choose your target platform:
-
-```
-# for desktop project
-dx build --platform desktop
-```
-
-`platform` currently only supports `desktop` & `web`.
-
-```
-# for web project
-dx build --platform web
-```
-
-## Specify workspace bin
-
-You can add the `--bin` option to select which crate you want Dioxus to build:
-
-```
-dx build --bin app
-```
-
-## Build Example
-
-You can use the `example` option to select a example to build:
-
-```
-# build the `test` example
-dx build --exmaple test
-```
diff --git a/packages/cli/docs/src/cmd/clean.md b/packages/cli/docs/src/cmd/clean.md
deleted file mode 100644
index ef938d245..000000000
--- a/packages/cli/docs/src/cmd/clean.md
+++ /dev/null
@@ -1,27 +0,0 @@
-# Clean
-
-`dx clean` will clear the build artifacts (the out_dir and the cargo cache)
-
-```
-dioxus-clean
-Clean build artifacts
-
-USAGE:
- dx clean [OPTIONS]
-
-OPTIONS:
- --bin [default: None]
-```
-
-# Example
-
-```
-dx clean
-```
-
-# Specify workspace bin
-You can add the `--bin` option to select which crate you want Dioxus to clean artifacts from:
-
-```
-dx clean --bin app
-```
diff --git a/packages/cli/docs/src/cmd/serve.md b/packages/cli/docs/src/cmd/serve.md
deleted file mode 100644
index d8b4e0d42..000000000
--- a/packages/cli/docs/src/cmd/serve.md
+++ /dev/null
@@ -1,70 +0,0 @@
-# Serve
-
-The `dx serve` can start a dev server with hot-reloading
-
-```
-dioxus-serve
-Build, watch & serve the Rust WASM app and all of its assets
-
-USAGE:
- dx serve [OPTIONS]
-
-OPTIONS:
- --example [default: ""]
- --platform [default: "default_platform"]
- --release [default: false]
- --hot-reload [default: false]
- --bin [default: None]
-```
-
-You can use this command to build project and start a dev server:
-
-```
-dx serve
-```
-
-## Serve Example
-
-You can use the `example` option to serve a example:
-
-```
-# serve the `test` example
-dx serve --exmaple test
-```
-
-## Specify workspace bin
-
-You can add the `--bin` option to select which crate you want Dioxus to build and serve:
-
-```
-dx serve --bin app
-```
-
-## Open Browser
-
-You can add the `--open` option to open system default browser when server startup:
-
-```
-dx serve --open
-```
-
-## RSX Hot Reloading
-
-You can add the `--hot-reload` flag to enable [rsx hot reloading](https://dioxuslabs.com/docs/0.3/guide/en/getting_started/hot_reload.html). This will allow you to reload some rsx changes without a full recompile:
-
-```
-dx serve --open
-```
-
-## Cross Origin Policy
-
-You can add the `cross-origin-policy` option to change cross-origin header to:
-
-```
- Cross-Origin-Opener-Policy: same-origin
- Cross-Origin-Embedder-Policy: require-corp
-```
-
-```
-dx serve --corss-origin-policy
-```
diff --git a/packages/cli/docs/src/cmd/translate.md b/packages/cli/docs/src/cmd/translate.md
deleted file mode 100644
index b03b4422c..000000000
--- a/packages/cli/docs/src/cmd/translate.md
+++ /dev/null
@@ -1,68 +0,0 @@
-# Translate
-
-`dx translate` can translate some `html` file into a Dioxus compoent
-
-```
-dioxus-translate
-Translate some source file into a Dioxus component
-
-USAGE:
- dx translate [OPTIONS] [OUTPUT]
-
-ARGS:
- Output file, defaults to stdout if not present
-
-OPTIONS:
- -c, --component Activate debug mode
- -f, --file Input file
-```
-
-## Translate HTML to stdout
-
-You can use the `file` option to set path to the `html` file to translate:
-
-```
-dx transtale --file ./index.html
-```
-
-## Output rsx to a file
-
-You can pass a file to the traslate command to set the path to write the output of the command to:
-
-```
-dx translate --file ./index.html component.rsx
-```
-
-## Output rsx to a file
-
-Setting the `component` option will create a compoent from the HTML:
-
-```
-dx translate --file ./index.html --component
-```
-
-## Example
-
-This HTML:
-```html
-
-```
-
-Translates into this Dioxus component:
-
-```rust
-fn component(cx: Scope) -> Element {
- cx.render(rsx! {
- div {
- h1 { "Hello World" },
- a {
- href: "https://dioxuslabs.com/",
- "Link"
- }
- }
- })
-}
-```
diff --git a/packages/cli/docs/src/configure.md b/packages/cli/docs/src/configure.md
index 9d0cb0a9b..3b9f6189b 100644
--- a/packages/cli/docs/src/configure.md
+++ b/packages/cli/docs/src/configure.md
@@ -1,166 +1,155 @@
# Configure Project
+This chapter will teach you how to configure the CLI with the `Dioxus.toml` file.
+There's an [example](#config-example) which has comments to describe individual keys.
+You can copy that or view this documentation for a more complete learning experience.
-This chapter will introduce you to how to configure the CLI with your `Dioxus.toml` file
-
-Be aware that if the config file is present in the folder, some fields must be filled out, or the CLI tool will abort. The mandatory [table headers](https://toml.io/en/v1.0.0#table) and keys will have a '✍' sign beside it.
+"🔒" indicates a mandatory item. Some headers are mandatory, but none of the keys inside them are. It might look weird, but it's normal. Simply don't include any keys.
## Structure
-The CLI uses a `Dioxus.toml` file in the root of your crate to define some configuration for your `dioxus` project.
+Each header has it's TOML form directly under it.
-### Application ✍
+### Application 🔒
-General application confiration:
-
-```
+```toml
[application]
-# configuration
```
-1. ***name*** ✍ - project name & title
-2. ***default_platform*** ✍ - which platform target for this project.
+Application-wide configuration. Applies to both web and desktop.
+
+1. **name** 🔒 - Project name & title.
+ ```toml
+ name = "my_project"
```
- name = "my-project"
- ```
-2. ***default_platform*** - The platform this project targets
- ```ß
- # current supported platforms: web, desktop
- # default: web
+
+2. **default_platform** 🔒 - The platform this project targets
+ ```toml
+ # Currently supported platforms: web, desktop
default_platform = "web"
```
- if you change this to `desktop`, the `dx build` will default building a desktop app
-3. ***out_dir*** - The directory to place the build artifacts from `dx build` or `dx service` into. This is also where the `assets` directory will be copied to
- ```
+
+3. **out_dir** - The directory to place the build artifacts from `dx build` or `dx serve` into. This is also where the `assets` directory will be copied into.
+ ```toml
out_dir = "dist"
```
-4. ***asset_dir*** - The directory with your static assets. The CLI will automatically copy these assets into the ***out_dir*** after a build/serve.
- ```
+
+4. **asset_dir** - The directory with your static assets. The CLI will automatically copy these assets into the **out_dir** after a build/serve.
+ ```toml
asset_dir = "public"
```
-5. ***sub_package*** - The sub package in the workspace to build by default
- ```
+
+5. **sub_package** - The sub package in the workspace to build by default.
+ ```toml
sub_package = "my-crate"
```
-### Web.App ✍
+### Web.App 🔒
-Configeration specific to web applications:
-
-```
+```toml
[web.app]
-# configuration
```
-1. ***title*** - The title of the web page
- ```
+Web-specific configuration.
+
+1. **title** - The title of the web page.
+ ```toml
# HTML title tag content
- title = "dioxus app | ⛺"
- ```
-2. ***base_path*** - The base path to build the appliation for serving at. This can be useful when serving your application in a subdirectory under a domain. For example when building a site to be served on github pages.
+ title = "project_name"
```
+
+2. **base_path** - The base path to build the application for serving at. This can be useful when serving your application in a subdirectory under a domain. For example when building a site to be served on GitHub Pages.
+ ```toml
# The application will be served at domain.com/my_application/, so we need to modify the base_path to the path where the application will be served
base_path = "my_application"
```
### Web.Watcher ✍
-Configeration related to the development server:
-
-```
+```toml
[web.watcher]
-# configuration
```
-1. ***reload_html*** - If this is true, the cli will rebuild the index.html file every time the application is rebuilt
- ```
+Development server configuration.
+
+1. **reload_html** - If this is true, the cli will rebuild the index.html file every time the application is rebuilt
+ ```toml
reload_html = true
```
-2. ***watch_path*** - The files & directories to moniter for changes
- ```
+
+2. **watch_path** - The files & directories to monitor for changes
+ ```toml
watch_path = ["src", "public"]
```
-3. ***index_on_404*** - If enabled, Dioxus CLI will serve the root page when a route is not found. *This is needed when serving an application that uses the router*
- ```
+
+3. **index_on_404** - If enabled, Dioxus will serve the root page when a route is not found.
+*This is needed when serving an application that uses the router*.
+However, when serving your app using something else than Dioxus (e.g. GitHub Pages), you will have to check how to configure it on that platform.
+In GitHub Pages, you can make a copy of `index.html` named `404.html` in the same directory.
+ ```toml
index_on_404 = true
```
-### Web.Resource ✍
+### Web.Resource 🔒
-Configeration related to static resources your application uses:
-```
+```toml
[web.resource]
-# configuration
```
-1. ***style*** - The styles (`.css` files) to include in your application
- ```
+Static resource configuration.
+
+1. **style** - CSS files to include in your application.
+ ```toml
style = [
- # include from public_dir.
+ # Include from public_dir.
"./assets/style.css",
- # or some asset from online cdn.
+ # Or some asset from online cdn.
"https://cdn.jsdelivr.net/npm/bootstrap/dist/css/bootstrap.css"
]
```
-2. ***script*** - The additional scripts (`.js` files) to include in your application
- ```
- style = [
- # include from public_dir.
- "./assets/index.js",
- # or some asset from online cdn.
+
+2. **script** - JavaScript files to include in your application.
+ ```toml
+ script = [
+ # Include from asset_dir.
+ "./public/index.js",
+ # Or from an online CDN.
"https://cdn.jsdelivr.net/npm/bootstrap/dist/js/bootstrap.js"
]
```
-### Web.Resource.Dev ✍
+### Web.Resource.Dev 🔒
-Configeration related to static resources your application uses in development:
-```
+```toml
[web.resource.dev]
-# configuration
```
-1. ***style*** - The styles (`.css` files) to include in your application
- ```
- style = [
- # include from public_dir.
- "./assets/style.css",
- # or some asset from online cdn.
- "https://cdn.jsdelivr.net/npm/bootstrap/dist/css/bootstrap.css"
- ]
- ```
-2. ***script*** - The additional scripts (`.js` files) to include in your application
- ```
- style = [
- # include from public_dir.
- "./assets/index.js",
- # or some asset from online cdn.
- "https://cdn.jsdelivr.net/npm/bootstrap/dist/js/bootstrap.js"
- ]
- ```
+This is the same as [`[web.resource]`](#webresource-), but it only works in development servers.
+For example, if you want to include a file in a `dx serve` server, but not a `dx serve --release` server, put it here.
### Web.Proxy
-Configeration related to any proxies your application requires durring development. Proxies will forward requests to a new service
-
-```
+```toml
[[web.proxy]]
-# configuration
```
-1. ***backend*** - The URL to the server to proxy. The CLI will forward any requests under the backend relative route to the backend instead of returning 404
- ```
+Configuration related to any proxies your application requires during development. Proxies will forward requests to a new service.
+
+1. **backend** - The URL to the server to proxy. The CLI will forward any requests under the backend relative route to the backend instead of returning 404
+ ```toml
backend = "http://localhost:8000/api/"
```
- This will cause any requests made to the dev server with prefix /api/ to be redirected to the backend server at http://localhost:8000. The path and query parameters will be passed on as-is (path rewriting is not currently supported).
+ This will cause any requests made to the dev server with prefix /api/ to be redirected to the backend server at http://localhost:8000. The path and query parameters will be passed on as-is (path rewriting is currently not supported).
## Config example
+This includes all fields, mandatory or not.
+
```toml
[application]
-# App (Project) Name
-name = "{{project-name}}"
+# App name
+name = "project_name"
# The Dioxus platform to default to
default_platform = "web"
@@ -168,23 +157,23 @@ default_platform = "web"
# `build` & `serve` output path
out_dir = "dist"
-# the static resource path
+# The static resource path
asset_dir = "public"
[web.app]
# HTML title tag content
-title = "dioxus | ⛺"
+title = "project_name"
[web.watcher]
-# when watcher is triggered, regenerate the `index.html`
+# When watcher is triggered, regenerate the `index.html`
reload_html = true
-# which files or dirs will be monitored
+# Which files or dirs will be monitored
watch_path = ["src", "public"]
-# include `assets` in web platform
+# Include style or script assets
[web.resource]
# CSS style file
@@ -195,12 +184,12 @@ script = []
[web.resource.dev]
-# serve: [dev-server] only
+# Same as [web.resource], but for development servers
# CSS style file
style = []
-# Javascript code file
+# JavaScript files
script = []
[[web.proxy]]
diff --git a/packages/cli/docs/src/creating.md b/packages/cli/docs/src/creating.md
index 6c2d5754c..4c594dfd8 100644
--- a/packages/cli/docs/src/creating.md
+++ b/packages/cli/docs/src/creating.md
@@ -1,39 +1,37 @@
# Create a Project
-Once you have the Dioxus CLI tool installed, you can use it to create dioxus project.
+Once you have the Dioxus CLI installed, you can use it to create your own project!
## Initializing a default project
-First, run the `dx create` command to create a new project ready to be used with Dioxus and the Dioxus CLI:
-
+First, run the `dx create` command to create a new project:
```
dx create hello-dioxus
```
-> It will clone a default template from github template: [DioxusLabs/dioxus-template](https://github.com/DioxusLabs/dioxus-template)
-> This default template is use for `web` platform application.
+> It will clone this [template](https://github.com/DioxusLabs/dioxus-template).
+> This default template is used for `web` platform application.
>
> You can choose to create your project from a different template by passing the `template` argument:
> ```
> dx init hello-dioxus --template=gh:dioxuslabs/dioxus-template
> ```
-Next, move the current directory into your new project:
+Next, navigate into your new project:
```
cd hello-dioxus
```
-> Make sure `wasm32 target` is installed before running the Web project.
-> You can install the wasm target for rust using rustup:
+> Make sure the WASM target is installed before running the projects.
+> You can install the WASM target for rust using rustup:
> ```
> rustup target add wasm32-unknown-unknown
> ```
-Finally, create serve your project with the Dioxus CLI:
-
+Finally, serve your project:
```
dx serve
```
-By default, the CLI serve your site at: [`http://127.0.0.1:8080/`](http://127.0.0.1:8080/)
+By default, the CLI serves your website at [`http://127.0.0.1:8080/`](http://127.0.0.1:8080/).
diff --git a/packages/cli/docs/src/installation.md b/packages/cli/docs/src/installation.md
index b4326d296..22803be61 100644
--- a/packages/cli/docs/src/installation.md
+++ b/packages/cli/docs/src/installation.md
@@ -1,22 +1,23 @@
# Installation
-Choose any one of the methods below to install the Dioxus CLI:
+## Install the latest development build through git
-## Install from latest git version
-
-To get the most up to date bug fixes and features of the Dioxus CLI, you can install the development version from git.
+To get the latest bug fixes and features, you can install the development version from git.
```
cargo install --git https://github.com/Dioxuslabs/cli
```
-This will automatically download `Dioxus-CLI` source from github master branch,
+This will download `Dioxus-CLI` source from GitHub master branch,
and install it in Cargo's global binary directory (`~/.cargo/bin/` by default).
-## Install from `crates.io` version
+## Install stable through `crates.io`
-The published version of the Dioxus CLI is updated less often, but should be more stable than the git version of the Dioxus CLI.
+The published version of the Dioxus CLI is updated less often, but is more stable than the git version.
```
-cargo install dioxus-cli
+cargo install dioxus-cli --locked
```
+
+Run `dx --help` for a list of all the available commands.
+Furthermore, you can run `dx --help` to get help with a specific command.
diff --git a/packages/cli/docs/src/introduction.md b/packages/cli/docs/src/introduction.md
index 2f857a2a5..8b10b0546 100644
--- a/packages/cli/docs/src/introduction.md
+++ b/packages/cli/docs/src/introduction.md
@@ -1,21 +1,18 @@
# Introduction
-📦✨ **Dioxus-Cli** is a tool to help get dioxus projects off the ground.
-
-
-
-It includes `dev server`, `hot reload` and some `quick command` to help you use dioxus.
+The 📦✨ **Dioxus CLI** is a tool to help get Dioxus projects off the ground.
## Features
+* Build and pack a Dioxus project
+* `html` to `rsx` conversion tool
+* Hot Reload for `web` platform
+* Create a Dioxus project from `git` repo
+* And more!
+
\ No newline at end of file
diff --git a/packages/cli/docs/src/plugin/README.md b/packages/cli/docs/src/plugin/README.md
index 0a1a7b606..fe7375618 100644
--- a/packages/cli/docs/src/plugin/README.md
+++ b/packages/cli/docs/src/plugin/README.md
@@ -1,24 +1,85 @@
-# CLI Plugin Development
+# CLI Plugin development
-> For Cli 0.2.0 we will add `plugin-develop` support.
+**IMPORTANT: Ignore this documentation. Plugins are yet to be released and chances are it won't work for you. This is just what plugins *could* look like.**
-Before the 0.2.0 we use `dx tool` to use & install some plugin, but we think that is not good for extend cli program, some people want tailwind support, some people want sass support, we can't add all this thing in to the cli source code and we don't have time to maintain a lot of tools that user request, so maybe user make plugin by themself is a good choice.
+In the past we used `dx tool` to use and install tools, but it was a flawed system.
+Tools were hard-coded by us, but people want more tools than we could code, so this plugin system was made to let
+anyone develop plugins and use them in Dioxus projects.
-### Why Lua ?
+Plugin resources:
+* [Source code](https://github.com/DioxusLabs/dioxus/tree/master/packages/cli/src/plugin)
+* [Unofficial Dioxus plugin community](https://github.com/DioxusPluginCommunity). Contains certain plugins you can use right now.
-We choose `Lua: 5.4` to be the plugin develop language, because cli plugin is not complex, just like a workflow, and user & developer can write some easy code for their plugin. We have **vendored** lua in cli program, and user don't need install lua runtime in their computer, and the lua parser & runtime doesn't take up much disk memory.
+### Why Lua?
-### Event Management
+We chose Lua `5.4` to be the plugin developing language,
+because it's extremely lightweight, embeddable and easy to learn.
+We installed Lua into the CLI, so you don't need to do it yourself.
-The plugin library have pre-define some important event you can control:
+Lua resources:
+* [Official website](https://www.lua.org/). You can basically find everything here.
+* [Awesome Lua](https://github.com/LewisJEllis/awesome-lua). Additional resources (such as Lua plugins for your favorite IDE), and other *awesome* tools!
-- `build.on_start`
-- `build.on_finished`
-- `serve.on_start`
-- `serve.on_rebuild`
-- `serve.on_shutdown`
-### Plugin Template
+## Creating a plugin
+
+A plugin is just an `init.lua` file.
+You can include other files using `dofile(path)`.
+You need to have a plugin and a manager instance, which you can get using `require`:
+```lua
+local plugin = require("plugin")
+local manager = require("manager")
+```
+
+You need to set some `manager` fields and then initialize the plugin:
+```lua
+manager.name = "My first plugin"
+manager.repository = "https://github.com/john-doe/my-first-plugin" -- The repository URL.
+manager.author = "John Doe "
+manager.version = "0.1.0"
+plugin.init(manager)
+```
+
+You also need to return the `manager`, which basically represents your plugin:
+```lua
+-- Your code here.
+-- End of file.
+
+manager.serve.interval = 1000
+return manager
+```
+
+And you're ready to go. Now, go and have a look at the stuff below and the API documentation.
+
+### Plugin info
+
+You will encounter this type in the events below. The keys are as follows:
+* `name: string` - The name of the plugin.
+* `repository: string` - The plugin repository URL.
+* `author: string` - The author of the plugin.
+* `version: string` - The plugin version.
+
+### Event management
+
+The plugin library has certain events that you can subscribe to.
+
+* `manager.on_init` - Triggers the first time the plugin is loaded.
+* `manager.build.on_start(info)` - Triggers before the build process. E.g., before `dx build`.
+* `manager.build.on_finish(info)` - Triggers after the build process. E.g., after `dx build`.
+* `manager.serve.on_start(info)` - Triggers before the serving process. E.g., before `dx serve`.
+* `manager.serve.on_rebuild_start(info)` - Triggers before the server rebuilds the web with hot reload.
+* `manager.serve.on_rebuild_end(info)` - Triggers after the server rebuilds the web with hot reload.
+* `manager.serve.on_shutdown` - Triggers when the server is shutdown. E.g., when the `dx serve` process is terminated.
+
+To subscribe to an event, you simply need to assign it to a function:
+
+```lua
+manager.build.on_start = function (info)
+ log.info("[plugin] Build starting: " .. info.name)
+end
+```
+
+### Plugin template
```lua
package.path = library_dir .. "/?.lua"
diff --git a/packages/cli/docs/src/plugin/interface/command.md b/packages/cli/docs/src/plugin/interface/command.md
index 18cd32769..2882e5153 100644
--- a/packages/cli/docs/src/plugin/interface/command.md
+++ b/packages/cli/docs/src/plugin/interface/command.md
@@ -1,15 +1,15 @@
# Command Functions
-> you can use command functions to execute some code & script
+You can use command functions to execute code and scripts.
-Type Define:
+Type definition:
```
Stdio: "Inherit" | "Piped" | "Null"
```
### `exec(commands: [string], stdout: Stdio, stderr: Stdio)`
-you can use this function to run some command on the current system.
+You can use this function to run some commands on the current system.
```lua
local cmd = plugin.command
@@ -18,4 +18,4 @@ manager.test = function ()
cmd.exec({"git", "clone", "https://github.com/DioxusLabs/cli-plugin-library"})
end
```
-> Warning: This function don't have exception catch.
\ No newline at end of file
+> Warning: This function doesn't catch exceptions.
\ No newline at end of file
diff --git a/packages/cli/docs/src/plugin/interface/dirs.md b/packages/cli/docs/src/plugin/interface/dirs.md
index 4173c922f..9984802ff 100644
--- a/packages/cli/docs/src/plugin/interface/dirs.md
+++ b/packages/cli/docs/src/plugin/interface/dirs.md
@@ -1,33 +1,28 @@
# Dirs Functions
-> you can use Dirs functions to get some directory path
+Dirs functions are for getting various directory paths. Not to be confused with `plugin.path`.
+### `plugin_dir() -> string`
-### plugin_dir() -> string
-
-You can get current plugin **root** directory path
+Get the plugin's root directory path.
```lua
local path = plugin.dirs.plugin_dir()
-- example: ~/Development/DioxusCli/plugin/test-plugin/
```
-### bin_dir() -> string
+### `bin_dir() -> string`
-You can get plugin **bin** direcotry path
-
-Sometime you need install some binary file like `tailwind-cli` & `sass-cli` to help your plugin work, then you should put binary file in this directory.
+Get the plugin's binary directory path. Put binary files like `tailwind-cli` or `sass-cli` in this directory.
```lua
local path = plugin.dirs.bin_dir()
-- example: ~/Development/DioxusCli/plugin/test-plugin/bin/
```
-### temp_dir() -> string
+### `temp_dir() -> string`
-You can get plugin **temp** direcotry path
-
-Just put some temporary file in this directory.
+Get the plugin's temporary directory path. Put any temporary files here.
```lua
local path = plugin.dirs.bin_dir()
diff --git a/packages/cli/docs/src/plugin/interface/log.md b/packages/cli/docs/src/plugin/interface/log.md
index fcd72595b..ee437b77a 100644
--- a/packages/cli/docs/src/plugin/interface/log.md
+++ b/packages/cli/docs/src/plugin/interface/log.md
@@ -1,46 +1,46 @@
# Log Functions
-> You can use log function to print some useful log info
+You can use log functions to print various logging information.
-### Trace(info: string)
+### `trace(info: string)`
-Print trace log info
+Print trace log info.
```lua
local log = plugin.log
log.trace("trace information")
```
-### Debug(info: string)
+### `debug(info: string)`
-Print debug log info
+Print debug log info.
```lua
local log = plugin.log
log.debug("debug information")
```
-### Info(info: string)
+### `info(info: string)`
-Print info log info
+Print info log info.
```lua
local log = plugin.log
log.info("info information")
```
-### Warn(info: string)
+### `warn(info: string)`
-Print warning log info
+Print warning log info.
```lua
local log = plugin.log
log.warn("warn information")
```
-### Error(info: string)
+### `error(info: string)`
-Print error log info
+Print error log info.
```lua
local log = plugin.log
diff --git a/packages/cli/docs/src/plugin/interface/network.md b/packages/cli/docs/src/plugin/interface/network.md
index 358c9c498..566bc5073 100644
--- a/packages/cli/docs/src/plugin/interface/network.md
+++ b/packages/cli/docs/src/plugin/interface/network.md
@@ -1,12 +1,13 @@
# Network Functions
-> you can use Network functions to download & read some data from internet
+You can use Network functions to download & read some data from the internet.
-### download_file(url: string, path: string) -> boolean
+### `download_file(url: string, path: string) -> boolean`
-This function can help you download some file from url, and it will return a *boolean* value to check the download status. (true: success | false: fail)
+Downloads a file from the specified URL,
+and returns a `boolean` that represents the download status (true: success, false: failure).
-You need pass a target url and a local path (where you want to save this file)
+You need to pass a target URL and a local path (where you want to save this file).
```lua
-- this file will download to plugin temp directory
@@ -19,9 +20,11 @@ if status != true then
end
```
-### clone_repo(url: string, path: string) -> boolean
+### `clone_repo(url: string, path: string) -> boolean`
-This function can help you use `git clone` command (this system must have been installed git)
+Clone a repository from the given URL into the given path.
+Returns a `boolean` that represents the clone status (true: success, false: failure).
+The system executing this function must have git installed.
```lua
local status = plugin.network.clone_repo(
diff --git a/packages/cli/docs/src/plugin/interface/os.md b/packages/cli/docs/src/plugin/interface/os.md
index 72a17c336..84f4697b8 100644
--- a/packages/cli/docs/src/plugin/interface/os.md
+++ b/packages/cli/docs/src/plugin/interface/os.md
@@ -1,10 +1,10 @@
# OS Functions
-> you can use OS functions to get some system information
+OS functions are for getting system information.
-### current_platform() -> string ("windows" | "macos" | "linux")
+### `current_platform() -> string ("windows" | "macos" | "linux")`
-This function can help you get system & platform type:
+Get the current OS platform.
```lua
local platform = plugin.os.current_platform()
diff --git a/packages/cli/docs/src/plugin/interface/path.md b/packages/cli/docs/src/plugin/interface/path.md
index ee787ecf9..a5bee1eb9 100644
--- a/packages/cli/docs/src/plugin/interface/path.md
+++ b/packages/cli/docs/src/plugin/interface/path.md
@@ -1,10 +1,13 @@
# Path Functions
-> you can use path functions to operate valid path string
+You can use path functions to perform operations on valid path strings.
-### join(path: string, extra: string) -> string
+### `join(path: string, extra: string) -> string`
-This function can help you extend a path, you can extend any path, dirname or filename.
+
+Extend a path; you can extend both directory and file paths.
```lua
local current_path = "~/hello/dioxus"
@@ -12,9 +15,9 @@ local new_path = plugin.path.join(current_path, "world")
-- new_path = "~/hello/dioxus/world"
```
-### parent(path: string) -> string
+### `parent(path: string) -> string`
-This function will return `path` parent-path string, back to the parent.
+Return the parent path of the specified path. The parent path is always a directory.
```lua
local current_path = "~/hello/dioxus"
@@ -22,14 +25,14 @@ local new_path = plugin.path.parent(current_path)
-- new_path = "~/hello/"
```
-### exists(path: string) -> boolean
+### `exists(path: string) -> boolean`
-This function can check some path (dir & file) is exists.
+Check if the specified path exists, as either a file or a directory.
-### is_file(path: string) -> boolean
+### `is_file(path: string) -> boolean`
-This function can check some path is a exist file.
+Check if the specified path is a file.
-### is_dir(path: string) -> boolean
+### `is_dir(path: string) -> boolean`
-This function can check some path is a exist dir.
\ No newline at end of file
+Check if the specified path is a directory.
\ No newline at end of file
diff --git a/packages/cli/src/builder.rs b/packages/cli/src/builder.rs
index 3fa8e7818..c4d1bde6f 100644
--- a/packages/cli/src/builder.rs
+++ b/packages/cli/src/builder.rs
@@ -22,6 +22,7 @@ pub struct BuildResult {
pub elapsed_time: u128,
}
+#[allow(unused)]
pub fn build(config: &CrateConfig, quiet: bool) -> Result {
// [1] Build the project with cargo, generating a wasm32-unknown-unknown target (is there a more specific, better target to leverage?)
// [2] Generate the appropriate build folders
@@ -53,7 +54,8 @@ pub fn build(config: &CrateConfig, quiet: bool) -> Result {
.arg("build")
.arg("--target")
.arg("wasm32-unknown-unknown")
- .arg("--message-format=json");
+ .arg("--message-format=json")
+ .arg("--quiet");
let cmd = if config.release {
cmd.arg("--release")
@@ -66,8 +68,6 @@ pub fn build(config: &CrateConfig, quiet: bool) -> Result {
cmd
};
- let cmd = if quiet { cmd.arg("--quiet") } else { cmd };
-
let cmd = if config.custom_profile.is_some() {
let custom_profile = config.custom_profile.as_ref().unwrap();
cmd.arg("--profile").arg(custom_profile)
@@ -93,18 +93,21 @@ pub fn build(config: &CrateConfig, quiet: bool) -> Result {
// [2] Establish the output directory structure
let bindgen_outdir = out_dir.join("assets").join("dioxus");
- let release_type = match config.release {
- true => "release",
- false => "debug",
+ let build_profile = if config.custom_profile.is_some() {
+ config.custom_profile.as_ref().unwrap()
+ } else if config.release {
+ "release"
+ } else {
+ "debug"
};
let input_path = match executable {
ExecutableType::Binary(name) | ExecutableType::Lib(name) => target_dir
- .join(format!("wasm32-unknown-unknown/{}", release_type))
+ .join(format!("wasm32-unknown-unknown/{}", build_profile))
.join(format!("{}.wasm", name)),
ExecutableType::Example(name) => target_dir
- .join(format!("wasm32-unknown-unknown/{}/examples", release_type))
+ .join(format!("wasm32-unknown-unknown/{}/examples", build_profile))
.join(format!("{}.wasm", name)),
};
@@ -383,10 +386,9 @@ fn prettier_build(cmd: subprocess::Exec) -> anyhow::Result> {
}
}
- StopSpinOnDrop(pb.clone());
-
let stdout = cmd.detached().stream_stdout()?;
let reader = std::io::BufReader::new(stdout);
+
for message in cargo_metadata::Message::parse_stream(reader) {
match message.unwrap() {
Message::CompilerMessage(msg) => {
@@ -406,7 +408,7 @@ fn prettier_build(cmd: subprocess::Exec) -> anyhow::Result> {
}
}
Message::CompilerArtifact(artifact) => {
- pb.set_message(format!("Compiling {} ", artifact.package_id));
+ pb.set_message(format!("⚙️ Compiling {} ", artifact.package_id));
pb.tick();
}
Message::BuildScriptExecuted(script) => {
diff --git a/packages/cli/src/cli/build.rs b/packages/cli/src/cli/build.rs
index 3053a6e5a..7fe29f8ce 100644
--- a/packages/cli/src/cli/build.rs
+++ b/packages/cli/src/cli/build.rs
@@ -42,7 +42,7 @@ impl Build {
match platform {
Platform::Web => {
- crate::builder::build(&crate_config, false)?;
+ crate::builder::build(&crate_config, true)?;
}
Platform::Desktop => {
crate::builder::build_desktop(&crate_config, false)?;
diff --git a/packages/cli/src/config.rs b/packages/cli/src/config.rs
index 2e499451f..0654dc375 100644
--- a/packages/cli/src/config.rs
+++ b/packages/cli/src/config.rs
@@ -381,6 +381,7 @@ impl From for tauri_bundler::DebianSettings {
tauri_bundler::DebianSettings {
depends: val.depends,
files: val.files,
+ desktop_template: None,
}
}
}
@@ -522,6 +523,8 @@ impl From for tauri_bundler::NsisSettings {
install_mode: val.install_mode.into(),
languages: val.languages,
display_language_selector: val.display_language_selector,
+ custom_language_files: None,
+ template: None,
}
}
}
diff --git a/packages/cli/src/lib.rs b/packages/cli/src/lib.rs
index 2d5f6dfcb..c067ab148 100644
--- a/packages/cli/src/lib.rs
+++ b/packages/cli/src/lib.rs
@@ -1,4 +1,4 @@
-pub const DIOXUS_CLI_VERSION: &str = "0.1.5";
+pub const DIOXUS_CLI_VERSION: &str = "0.4.1";
pub mod builder;
pub mod server;
diff --git a/packages/cli/src/server/desktop/mod.rs b/packages/cli/src/server/desktop/mod.rs
index 9b79bdea9..91811857d 100644
--- a/packages/cli/src/server/desktop/mod.rs
+++ b/packages/cli/src/server/desktop/mod.rs
@@ -1,7 +1,7 @@
use crate::{
server::{
output::{print_console_info, PrettierOptions},
- setup_file_watcher, setup_file_watcher_hot_reload,
+ setup_file_watcher,
},
BuildResult, CrateConfig, Result,
};
@@ -19,6 +19,8 @@ use tokio::sync::broadcast::{self};
#[cfg(feature = "plugin")]
use plugin::PluginManager;
+use super::HotReloadState;
+
pub async fn startup(config: CrateConfig) -> Result<()> {
// ctrl-c shutdown checker
let _crate_config = config.clone();
@@ -28,16 +30,36 @@ pub async fn startup(config: CrateConfig) -> Result<()> {
std::process::exit(0);
});
- match config.hot_reload {
- true => serve_hot_reload(config).await?,
- false => serve_default(config).await?,
- }
+ let hot_reload_state = match config.hot_reload {
+ true => {
+ let FileMapBuildResult { map, errors } =
+ FileMap::::create(config.crate_dir.clone()).unwrap();
+
+ for err in errors {
+ log::error!("{}", err);
+ }
+
+ let file_map = Arc::new(Mutex::new(map));
+
+ let hot_reload_tx = broadcast::channel(100).0;
+
+ clear_paths();
+
+ Some(HotReloadState {
+ messages: hot_reload_tx.clone(),
+ file_map: file_map.clone(),
+ })
+ }
+ false => None,
+ };
+
+ serve(config, hot_reload_state).await?;
Ok(())
}
/// Start the server without hot reload
-pub async fn serve_default(config: CrateConfig) -> Result<()> {
+pub async fn serve(config: CrateConfig, hot_reload_state: Option) -> Result<()> {
let (child, first_build_result) = start_desktop(&config)?;
let currently_running_child: RwLock = RwLock::new(child);
@@ -59,6 +81,7 @@ pub async fn serve_default(config: CrateConfig) -> Result<()> {
},
&config,
None,
+ hot_reload_state.clone(),
)
.await?;
@@ -73,79 +96,29 @@ pub async fn serve_default(config: CrateConfig) -> Result<()> {
None,
);
- std::future::pending::<()>().await;
+ match hot_reload_state {
+ Some(hot_reload_state) => {
+ start_desktop_hot_reload(hot_reload_state).await?;
+ }
+ None => {
+ std::future::pending::<()>().await;
+ }
+ }
Ok(())
}
-/// Start the server without hot reload
-
-/// Start dx serve with hot reload
-pub async fn serve_hot_reload(config: CrateConfig) -> Result<()> {
- let (_, first_build_result) = start_desktop(&config)?;
-
- println!("🚀 Starting development server...");
-
- // Setup hot reload
- let FileMapBuildResult { map, errors } =
- FileMap::::create(config.crate_dir.clone()).unwrap();
-
- println!("🚀 Starting development server...");
-
- for err in errors {
- log::error!("{}", err);
- }
-
- let file_map = Arc::new(Mutex::new(map));
-
- let (hot_reload_tx, mut hot_reload_rx) = broadcast::channel(100);
-
- // States
- // The open interprocess sockets
- let channels = Arc::new(Mutex::new(Vec::new()));
-
- // Setup file watcher
- // We got to own watcher so that it exists for the duration of serve
- // Otherwise hot reload won't work.
- let _watcher = setup_file_watcher_hot_reload(
- &config,
- hot_reload_tx,
- file_map.clone(),
- {
- let config = config.clone();
-
- let channels = channels.clone();
- move || {
- for channel in &mut *channels.lock().unwrap() {
- send_msg(HotReloadMsg::Shutdown, channel);
- }
- Ok(start_desktop(&config)?.1)
- }
- },
- None,
- )
- .await?;
-
- // Print serve info
- print_console_info(
- &config,
- PrettierOptions {
- changed: vec![],
- warnings: first_build_result.warnings,
- elapsed_time: first_build_result.elapsed_time,
- },
- None,
- );
-
- clear_paths();
-
+async fn start_desktop_hot_reload(hot_reload_state: HotReloadState) -> Result<()> {
match LocalSocketListener::bind("@dioxusin") {
Ok(local_socket_stream) => {
let aborted = Arc::new(Mutex::new(false));
+ // States
+ // The open interprocess sockets
+ let channels = Arc::new(Mutex::new(Vec::new()));
// listen for connections
std::thread::spawn({
- let file_map = file_map.clone();
+ let file_map = hot_reload_state.file_map.clone();
let channels = channels.clone();
let aborted = aborted.clone();
let _ = local_socket_stream.set_nonblocking(true);
@@ -180,6 +153,8 @@ pub async fn serve_hot_reload(config: CrateConfig) -> Result<()> {
}
});
+ let mut hot_reload_rx = hot_reload_state.messages.subscribe();
+
while let Ok(template) = hot_reload_rx.recv().await {
let channels = &mut *channels.lock().unwrap();
let mut i = 0;
diff --git a/packages/cli/src/server/mod.rs b/packages/cli/src/server/mod.rs
index 19dc44b75..c6073d787 100644
--- a/packages/cli/src/server/mod.rs
+++ b/packages/cli/src/server/mod.rs
@@ -9,7 +9,7 @@ use std::{
path::PathBuf,
sync::{Arc, Mutex},
};
-use tokio::sync::broadcast::Sender;
+use tokio::sync::broadcast::{self};
mod output;
use output::*;
@@ -21,6 +21,7 @@ async fn setup_file_watcher Result + Send + 'static>(
build_with: F,
config: &CrateConfig,
web_info: Option,
+ hot_reload: Option,
) -> Result {
let mut last_update_time = chrono::Local::now().timestamp();
@@ -38,28 +39,81 @@ async fn setup_file_watcher Result + Send + 'static>(
let config = watcher_config.clone();
if let Ok(e) = info {
if chrono::Local::now().timestamp() > last_update_time {
- match build_with() {
- Ok(res) => {
- last_update_time = chrono::Local::now().timestamp();
+ let mut needs_full_rebuild;
+ if let Some(hot_reload) = &hot_reload {
+ // find changes to the rsx in the file
+ let mut rsx_file_map = hot_reload.file_map.lock().unwrap();
+ let mut messages: Vec> = Vec::new();
- #[allow(clippy::redundant_clone)]
- print_console_info(
- &config,
- PrettierOptions {
- changed: e.paths.clone(),
- warnings: res.warnings,
- elapsed_time: res.elapsed_time,
- },
- web_info.clone(),
- );
+ // In hot reload mode, we only need to rebuild if non-rsx code is changed
+ needs_full_rebuild = false;
- #[cfg(feature = "plugin")]
- let _ = PluginManager::on_serve_rebuild(
- chrono::Local::now().timestamp(),
- e.paths,
- );
+ for path in &e.paths {
+ // if this is not a rust file, rebuild the whole project
+ if path.extension().and_then(|p| p.to_str()) != Some("rs") {
+ needs_full_rebuild = true;
+ break;
+ }
+
+ match rsx_file_map.update_rsx(path, &config.crate_dir) {
+ Ok(UpdateResult::UpdatedRsx(msgs)) => {
+ messages.extend(msgs);
+ needs_full_rebuild = false;
+ }
+ Ok(UpdateResult::NeedsRebuild) => {
+ needs_full_rebuild = true;
+ }
+ Err(err) => {
+ log::error!("{}", err);
+ }
+ }
+ }
+
+ if needs_full_rebuild {
+ // Reset the file map to the new state of the project
+ let FileMapBuildResult {
+ map: new_file_map,
+ errors,
+ } = FileMap::::create(config.crate_dir.clone()).unwrap();
+
+ for err in errors {
+ log::error!("{}", err);
+ }
+
+ *rsx_file_map = new_file_map;
+ } else {
+ for msg in messages {
+ let _ = hot_reload.messages.send(msg);
+ }
+ }
+ } else {
+ needs_full_rebuild = true;
+ }
+
+ if needs_full_rebuild {
+ match build_with() {
+ Ok(res) => {
+ last_update_time = chrono::Local::now().timestamp();
+
+ #[allow(clippy::redundant_clone)]
+ print_console_info(
+ &config,
+ PrettierOptions {
+ changed: e.paths.clone(),
+ warnings: res.warnings,
+ elapsed_time: res.elapsed_time,
+ },
+ web_info.clone(),
+ );
+
+ #[cfg(feature = "plugin")]
+ let _ = PluginManager::on_serve_rebuild(
+ chrono::Local::now().timestamp(),
+ e.paths,
+ );
+ }
+ Err(e) => log::error!("{}", e),
}
- Err(e) => log::error!("{}", e),
}
}
}
@@ -77,106 +131,8 @@ async fn setup_file_watcher Result + Send + 'static>(
Ok(watcher)
}
-// Todo: reduce duplication and merge with setup_file_watcher()
-/// Sets up a file watcher with hot reload
-async fn setup_file_watcher_hot_reload Result + Send + 'static>(
- config: &CrateConfig,
- hot_reload_tx: Sender>,
- file_map: Arc>>,
- build_with: F,
- web_info: Option,
-) -> Result {
- // file watcher: check file change
- let allow_watch_path = config
- .dioxus_config
- .web
- .watcher
- .watch_path
- .clone()
- .unwrap_or_else(|| vec![PathBuf::from("src")]);
-
- let watcher_config = config.clone();
- let mut last_update_time = chrono::Local::now().timestamp();
-
- let mut watcher = RecommendedWatcher::new(
- move |evt: notify::Result| {
- let config = watcher_config.clone();
- // Give time for the change to take effect before reading the file
- std::thread::sleep(std::time::Duration::from_millis(100));
- if chrono::Local::now().timestamp() > last_update_time {
- if let Ok(evt) = evt {
- let mut messages: Vec> = Vec::new();
- for path in evt.paths.clone() {
- // if this is not a rust file, rebuild the whole project
- if path.extension().and_then(|p| p.to_str()) != Some("rs") {
- match build_with() {
- Ok(res) => {
- print_console_info(
- &config,
- PrettierOptions {
- changed: evt.paths,
- warnings: res.warnings,
- elapsed_time: res.elapsed_time,
- },
- web_info.clone(),
- );
- }
- Err(err) => {
- log::error!("{}", err);
- }
- }
- return;
- }
- // find changes to the rsx in the file
- let mut map = file_map.lock().unwrap();
-
- match map.update_rsx(&path, &config.crate_dir) {
- Ok(UpdateResult::UpdatedRsx(msgs)) => {
- messages.extend(msgs);
- }
- Ok(UpdateResult::NeedsRebuild) => {
- match build_with() {
- Ok(res) => {
- print_console_info(
- &config,
- PrettierOptions {
- changed: evt.paths,
- warnings: res.warnings,
- elapsed_time: res.elapsed_time,
- },
- web_info.clone(),
- );
- }
- Err(err) => {
- log::error!("{}", err);
- }
- }
- return;
- }
- Err(err) => {
- log::error!("{}", err);
- }
- }
- }
- for msg in messages {
- let _ = hot_reload_tx.send(msg);
- }
- }
- last_update_time = chrono::Local::now().timestamp();
- }
- },
- notify::Config::default(),
- )
- .unwrap();
-
- for sub_path in allow_watch_path {
- if let Err(err) = watcher.watch(
- &config.crate_dir.join(&sub_path),
- notify::RecursiveMode::Recursive,
- ) {
- log::error!("error watching {sub_path:?}: \n{}", err);
- }
- }
-
- Ok(watcher)
+#[derive(Clone)]
+pub struct HotReloadState {
+ pub messages: broadcast::Sender>,
+ pub file_map: Arc>>,
}
diff --git a/packages/cli/src/server/web/hot_reload.rs b/packages/cli/src/server/web/hot_reload.rs
index 49cce38d4..7b47dca4c 100644
--- a/packages/cli/src/server/web/hot_reload.rs
+++ b/packages/cli/src/server/web/hot_reload.rs
@@ -1,27 +1,15 @@
-use std::sync::{Arc, Mutex};
-
use axum::{
extract::{ws::Message, WebSocketUpgrade},
response::IntoResponse,
Extension, TypedHeader,
};
-use dioxus_core::Template;
-use dioxus_html::HtmlCtx;
-use dioxus_rsx::hot_reload::FileMap;
-use tokio::sync::broadcast;
-use crate::CrateConfig;
-
-pub struct HotReloadState {
- pub messages: broadcast::Sender>,
- pub file_map: Arc>>,
- pub watcher_config: CrateConfig,
-}
+use crate::server::HotReloadState;
pub async fn hot_reload_handler(
ws: WebSocketUpgrade,
_: Option>,
- Extension(state): Extension>,
+ Extension(state): Extension,
) -> impl IntoResponse {
ws.on_upgrade(|mut socket| async move {
log::info!("🔥 Hot Reload WebSocket connected");
diff --git a/packages/cli/src/server/web/mod.rs b/packages/cli/src/server/web/mod.rs
index e08d2297a..0e1413597 100644
--- a/packages/cli/src/server/web/mod.rs
+++ b/packages/cli/src/server/web/mod.rs
@@ -3,9 +3,9 @@ use crate::{
serve::Serve,
server::{
output::{print_console_info, PrettierOptions, WebServerInfo},
- setup_file_watcher, setup_file_watcher_hot_reload,
+ setup_file_watcher, HotReloadState,
},
- BuildResult, CrateConfig, Result,
+ BuildResult, CrateConfig, Result, WebHttpsConfig,
};
use axum::{
body::{Full, HttpBody},
@@ -58,22 +58,41 @@ pub async fn startup(port: u16, config: CrateConfig, start_browser: bool) -> Res
let ip = get_ip().unwrap_or(String::from("0.0.0.0"));
- match config.hot_reload {
- true => serve_hot_reload(ip, port, config, start_browser).await?,
- false => serve_default(ip, port, config, start_browser).await?,
- }
+ let hot_reload_state = match config.hot_reload {
+ true => {
+ let FileMapBuildResult { map, errors } =
+ FileMap::::create(config.crate_dir.clone()).unwrap();
+
+ for err in errors {
+ log::error!("{}", err);
+ }
+
+ let file_map = Arc::new(Mutex::new(map));
+
+ let hot_reload_tx = broadcast::channel(100).0;
+
+ Some(HotReloadState {
+ messages: hot_reload_tx.clone(),
+ file_map: file_map.clone(),
+ })
+ }
+ false => None,
+ };
+
+ serve(ip, port, config, start_browser, hot_reload_state).await?;
Ok(())
}
/// Start the server without hot reload
-pub async fn serve_default(
+pub async fn serve(
ip: String,
port: u16,
config: CrateConfig,
start_browser: bool,
+ hot_reload_state: Option,
) -> Result<()> {
- let first_build_result = crate::builder::build(&config, false)?;
+ let first_build_result = crate::builder::build(&config, true)?;
log::info!("🚀 Starting development server...");
@@ -93,6 +112,7 @@ pub async fn serve_default(
ip: ip.clone(),
port,
}),
+ hot_reload_state.clone(),
)
.await?;
@@ -119,88 +139,7 @@ pub async fn serve_default(
);
// Router
- let router = setup_router(config, ws_reload_state, None).await?;
-
- // Start server
- start_server(port, router, start_browser, rustls_config).await?;
-
- Ok(())
-}
-
-/// Start dx serve with hot reload
-pub async fn serve_hot_reload(
- ip: String,
- port: u16,
- config: CrateConfig,
- start_browser: bool,
-) -> Result<()> {
- let first_build_result = crate::builder::build(&config, false)?;
-
- log::info!("🚀 Starting development server...");
-
- // Setup hot reload
- let (reload_tx, _) = broadcast::channel(100);
- let FileMapBuildResult { map, errors } =
- FileMap::::create(config.crate_dir.clone()).unwrap();
-
- for err in errors {
- log::error!("{}", err);
- }
-
- let file_map = Arc::new(Mutex::new(map));
-
- let hot_reload_tx = broadcast::channel(100).0;
-
- // States
- let hot_reload_state = Arc::new(HotReloadState {
- messages: hot_reload_tx.clone(),
- file_map: file_map.clone(),
- watcher_config: config.clone(),
- });
-
- let ws_reload_state = Arc::new(WsReloadState {
- update: reload_tx.clone(),
- });
-
- // Setup file watcher
- // We got to own watcher so that it exists for the duration of serve
- // Otherwise hot reload won't work.
- let _watcher = setup_file_watcher_hot_reload(
- &config,
- hot_reload_tx,
- file_map,
- {
- let config = config.clone();
- let reload_tx = reload_tx.clone();
- move || build(&config, &reload_tx)
- },
- Some(WebServerInfo {
- ip: ip.clone(),
- port,
- }),
- )
- .await?;
-
- // HTTPS
- // Before console info so it can stop if mkcert isn't installed or fails
- let rustls_config = get_rustls(&config).await?;
-
- // Print serve info
- print_console_info(
- &config,
- PrettierOptions {
- changed: vec![],
- warnings: first_build_result.warnings,
- elapsed_time: first_build_result.elapsed_time,
- },
- Some(WebServerInfo {
- ip: ip.clone(),
- port,
- }),
- );
-
- // Router
- let router = setup_router(config, ws_reload_state, Some(hot_reload_state)).await?;
+ let router = setup_router(config, ws_reload_state, hot_reload_state).await?;
// Start server
start_server(port, router, start_browser, rustls_config).await?;
@@ -218,67 +157,12 @@ async fn get_rustls(config: &CrateConfig) -> Result> {
return Ok(None);
}
- let (cert_path, key_path) = match web_config.mkcert {
+ let (cert_path, key_path) = if let Some(true) = web_config.mkcert {
// mkcert, use it
- Some(true) => {
- // Get paths to store certs, otherwise use ssl/item.pem
- let key_path = web_config
- .key_path
- .clone()
- .unwrap_or(DEFAULT_KEY_PATH.to_string());
-
- let cert_path = web_config
- .cert_path
- .clone()
- .unwrap_or(DEFAULT_CERT_PATH.to_string());
-
- // Create ssl directory if using defaults
- if key_path == DEFAULT_KEY_PATH && cert_path == DEFAULT_CERT_PATH {
- _ = fs::create_dir("ssl");
- }
-
- let cmd = Command::new("mkcert")
- .args([
- "-install",
- "-key-file",
- &key_path,
- "-cert-file",
- &cert_path,
- "localhost",
- "::1",
- "127.0.0.1",
- ])
- .spawn();
-
- match cmd {
- Err(e) => {
- match e.kind() {
- io::ErrorKind::NotFound => log::error!("mkcert is not installed. See https://github.com/FiloSottile/mkcert#installation for installation instructions."),
- e => log::error!("an error occured while generating mkcert certificates: {}", e.to_string()),
- };
- return Err("failed to generate mkcert certificates".into());
- }
- Ok(mut cmd) => {
- cmd.wait()?;
- }
- }
-
- (cert_path, key_path)
- }
- // not mkcert
- Some(false) => {
- // get paths to cert & key
- if let (Some(key), Some(cert)) =
- (web_config.key_path.clone(), web_config.cert_path.clone())
- {
- (cert, key)
- } else {
- // missing cert or key
- return Err("https is enabled but cert or key path is missing".into());
- }
- }
- // other
- _ => return Ok(None),
+ get_rustls_with_mkcert(web_config)?
+ } else {
+ // if mkcert not specified or false, don't use it
+ get_rustls_without_mkcert(web_config)?
};
Ok(Some(
@@ -286,11 +170,67 @@ async fn get_rustls(config: &CrateConfig) -> Result > {
))
}
+fn get_rustls_with_mkcert(web_config: &WebHttpsConfig) -> Result<(String, String)> {
+ // Get paths to store certs, otherwise use ssl/item.pem
+ let key_path = web_config
+ .key_path
+ .clone()
+ .unwrap_or(DEFAULT_KEY_PATH.to_string());
+
+ let cert_path = web_config
+ .cert_path
+ .clone()
+ .unwrap_or(DEFAULT_CERT_PATH.to_string());
+
+ // Create ssl directory if using defaults
+ if key_path == DEFAULT_KEY_PATH && cert_path == DEFAULT_CERT_PATH {
+ _ = fs::create_dir("ssl");
+ }
+
+ let cmd = Command::new("mkcert")
+ .args([
+ "-install",
+ "-key-file",
+ &key_path,
+ "-cert-file",
+ &cert_path,
+ "localhost",
+ "::1",
+ "127.0.0.1",
+ ])
+ .spawn();
+
+ match cmd {
+ Err(e) => {
+ match e.kind() {
+ io::ErrorKind::NotFound => log::error!("mkcert is not installed. See https://github.com/FiloSottile/mkcert#installation for installation instructions."),
+ e => log::error!("an error occured while generating mkcert certificates: {}", e.to_string()),
+ };
+ return Err("failed to generate mkcert certificates".into());
+ }
+ Ok(mut cmd) => {
+ cmd.wait()?;
+ }
+ }
+
+ Ok((cert_path, key_path))
+}
+
+fn get_rustls_without_mkcert(web_config: &WebHttpsConfig) -> Result<(String, String)> {
+ // get paths to cert & key
+ if let (Some(key), Some(cert)) = (web_config.key_path.clone(), web_config.cert_path.clone()) {
+ Ok((cert, key))
+ } else {
+ // missing cert or key
+ Err("https is enabled but cert or key path is missing".into())
+ }
+}
+
/// Sets up and returns a router
async fn setup_router(
config: CrateConfig,
ws_reload: Arc,
- hot_reload: Option>,
+ hot_reload: Option,
) -> Result {
// Setup cors
let cors = CorsLayer::new()
diff --git a/packages/core-macro/Cargo.toml b/packages/core-macro/Cargo.toml
index f3d6f6b3b..d928d5fec 100644
--- a/packages/core-macro/Cargo.toml
+++ b/packages/core-macro/Cargo.toml
@@ -17,6 +17,8 @@ proc-macro2 = { version = "1.0" }
quote = "1.0"
syn = { version = "2.0", features = ["full", "extra-traits"] }
dioxus-rsx = { workspace = true }
+dioxus-core = { workspace = true }
+constcat = "0.3.0"
# testing
[dev-dependencies]
diff --git a/packages/core-macro/README.md b/packages/core-macro/README.md
index bcf1572cf..31b0cca90 100644
--- a/packages/core-macro/README.md
+++ b/packages/core-macro/README.md
@@ -1,6 +1,5 @@
# dioxus-core-macro
-
[![Crates.io][crates-badge]][crates-url]
[![MIT licensed][mit-badge]][mit-url]
[![Build Status][actions-badge]][actions-url]
@@ -8,22 +7,18 @@
[crates-badge]: https://img.shields.io/crates/v/dioxus-core-macro.svg
[crates-url]: https://crates.io/crates/dioxus-core-macro
-
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/dioxuslabs/dioxus/blob/master/LICENSE
-
[actions-badge]: https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg
[actions-url]: https://github.com/dioxuslabs/dioxus/actions?query=workflow%3ACI+branch%3Amaster
-
[discord-badge]: https://img.shields.io/discord/899851952891002890.svg?logo=discord&style=flat-square
[discord-url]: https://discord.gg/XgGxMSkvUM
[Website](https://dioxuslabs.com) |
-[Guides](https://dioxuslabs.com/docs/0.3/guide/en/) |
+[Guides](https://dioxuslabs.com/learn/0.4/) |
[API Docs](https://docs.rs/dioxus-core-macro/latest/dioxus_core_macro) |
[Chat](https://discord.gg/XgGxMSkvUM)
-
## Overview
`dioxus-core-macro` provides a handful of helpful macros used by the `dioxus` crate. These include:
@@ -32,13 +27,13 @@
- The `inline_props` macro transforms function arguments into an auto-derived struct
- The `format_args_f` macro which allows f-string formatting with support for expressions
-
## Contributing
- Report issues on our [issue tracker](https://github.com/dioxuslabs/dioxus/issues).
- Join the discord and ask questions!
## License
+
This project is licensed under the [MIT license].
[mit license]: https://github.com/DioxusLabs/dioxus/blob/master/LICENSE-MIT
diff --git a/packages/core-macro/src/component_body/mod.rs b/packages/core-macro/src/component_body/mod.rs
new file mode 100644
index 000000000..91e66c42c
--- /dev/null
+++ b/packages/core-macro/src/component_body/mod.rs
@@ -0,0 +1,237 @@
+//! This module is used for parsing a component function into a struct that is subsequently
+//! deserialized into something useful using deserializer arguments.
+//!
+//! Let's break that down with a term glossary and examples which show usage and implementing.
+//!
+//! # Glossary
+//! * `component body` - The [`ComponentBody`] struct. It's used to parse a component function [`proc_macro::TokenStream`]
+//! to a reusable struct that deserializers use to modify the token stream.
+//! * `deserializer` - A struct that deserializes the [`ComponentBody`] into a [`DeserializerOutput`].
+//! It implements the [`DeserializerArgs`] trait, but as you can see, it's called "DeserializerArgs",
+//! not "Deserializer". Why?
+//! Because "args" makes more sense to the caller of [`ComponentBody::deserialize`], which
+//! takes an [`DeserializerArgs`] argument. However, you can think of "DeserializerArgs" as the deserializer.
+//! * `deserializer output` - A struct that implements the [`DeserializerOutput`] trait.
+//! This struct is what enables deserializers to use each other, since it contains the fields that
+//! a deserializer needs to turn a token stream to a different token stream.
+//! This means a deserializer can get the output of another deserializer, and use that output,
+//! thereby using the functionality of a different deserializer.
+//! This struct also implements [`ToTokens`], which means that this is the final stage of the whole process.
+//!
+//! # Examples
+//! *Not all imports might be included.*
+//!
+//! ## Usage in a procedural macro attribute
+//! ```rs,ignore
+//! use proc_macro::TokenStream;
+//!
+//! // Some documentation. You can reuse this in your deserializer structs.
+//! /// This attribute changes the name of a component function to whatever the first argument is.
+//! #[proc_macro_attribute]
+//! pub fn name_changer(args: TokenStream, input: TokenStream) -> TokenStream {
+//! // Parse the component body.
+//! let component_body = parse_macro_input!(input as ComponentBody);
+//!
+//! // Parse the first argument, which is going to be the components new name.
+//! let new_name: String = match Punctuated::::parse_terminated.parse(args) {
+//! Err(e) => return e.to_compile_error().into(), // Convert to a compile error and return
+//! Ok(args) => {
+//! // If the argument exists, then convert it to a string
+//! if let Some(first) = args.first() {
+//! first.to_token_stream().to_string()
+//! } else {
+//! // If the argument doesn't exist, return an error with the appropriate message.
+//! // The "span" is the location of some code.
+//! // The error occurred in the "args" token stream, so point the error there.
+//! return Error::new(args.span(), "No new name provided").to_compile_error().into();
+//! }
+//! }
+//! };
+//!
+//! let new_name = &*new_name;
+//!
+//! // Deserialize the component body to an output with the given args.
+//! let output = component_body.deserialize(NameChangerDeserializerArgs { new_name });
+//!
+//! // Error handling like before, except now you're ready to return the final value.
+//! match output {
+//! Err(e) => e.to_compile_error().into(),
+//! Ok(output) => output.to_token_stream().into(),
+//! }
+//! }
+//! ```
+//! ## Using the macro in Dioxus code:
+//! ```rs
+//! use your_proc_macro_library::name_changer;
+//! use dioxus::prelude::*;
+//!
+//! #[name_changer(CoolName)]
+//! pub fn LameName(cx: Scope) -> Element {
+//! render! { "I want a cool name!" }
+//! }
+//!
+//! pub fn App(cx: Scope) -> Element {
+//! render! { CoolName {} } // Renders: "I want a cool name!"
+//! }
+//! ```
+//! ## Implementing a component body deserializer
+//! ```rs
+//! use syn::{Result, ItemFn, Signature, Ident};
+//! use quote::quote;
+//!
+//! // Create a list of arguments.
+//! // If there was no args, just make it empty. The "args" struct is also the deserializer struct.
+//! // For the docs, you can basically copy paste this text and replace "name_changer" with your macro path.
+//! // Although unfortunately, the link does not work
+//! // Just make sure that your macro is well documented.
+//! /// The args and deserializing implementation for the [`name_changer`] macro.
+//! #[derive(Clone)]
+//! pub struct NameChangerDeserializerArgs<'a> {
+//! pub new_name: &'a str,
+//! }
+//!
+//! // Create an output struct.
+//! // The ItemFn represents a modified component function.
+//! // To read what fields should be here, check out the `DeserializerOutput` struct docs.
+//! // For the docs, you can basically copy paste this text and replace "name_changer" with your macro path.
+//! // Just make sure that your macro is well documented.
+//! /// The output fields and [`ToTokens`] implementation for the [`name_changer`] macro.
+//! #[derive(Clone)]
+//! pub struct NameChangerDeserializerOutput {
+//! pub comp_fn: ItemFn,
+//! }
+//!
+//! // Implement `ToTokens`, which is forced by `DeserializerOutput`.
+//! // This will usually be very simple like this, even for complex deserializers.
+//! // That's because of the way the `DeserializerOutput` is designed.
+//! impl ToTokens for NameChangerDeserializerOutput {
+//! fn to_tokens(&self, tokens: &mut TokenStream) {
+//! let comp_fn = &self.comp_fn;
+//!
+//! tokens.append_all(quote! {
+//! #comp_fn
+//! });
+//! }
+//! }
+//!
+//! impl DeserializerOutput for NameChangerDeserializerOutput {}
+//!
+//! // Implement `DeserializerArgs`. This is the core part of deserializers.
+//! impl<'a> DeserializerArgs for NameChangerDeserializerArgs<'a> {
+//! fn to_output(&self, component_body: &ComponentBody) -> Result {
+//! let old_fn = &component_body.item_fn;
+//! let old_sig = &old_fn.sig;
+//!
+//! // For more complex uses, you will probably use `quote::parse_quote!` in combination with
+//! // creating the structs manually.
+//! // However, create the structs manually if you can.
+//! // It's more reliable, because you only modify a certain struct field
+//! // and set the others to be the clone of the original component body.
+//! // That ensures that no information will be accidentally removed.
+//! let new_sig = Signature {
+//! ident: Ident::new(self.new_name, old_sig.ident.span()),
+//! ..old_sig.clone()
+//! };
+//! let new_fn = ItemFn {
+//! sig: new_sig,
+//! ..old_fn.clone()
+//! };
+//!
+//! Ok(NameChangerDeserializerOutput {
+//! comp_fn: new_fn
+//! })
+//! }
+//! ```
+
+pub mod utils;
+
+pub use utils::DeserializerArgs;
+pub use utils::DeserializerOutput;
+pub use utils::TypeHelper;
+
+use dioxus_core::{Element, Scope};
+use syn::parse::{Parse, ParseStream};
+use syn::spanned::Spanned;
+use syn::*;
+
+/// General struct for parsing a component body.
+/// However, because it's ambiguous, it does not implement [`ToTokens`](quote::to_tokens::ToTokens).
+///
+/// Refer to the [module documentation](crate::component_body) for more.
+pub struct ComponentBody {
+ /// The component function definition. You can parse this back into a [`ComponentBody`].
+ /// For example, you might modify it, parse it into a [`ComponentBody`], and deserialize that
+ /// using some deserializer. This is how deserializers use other deserializers.
+ ///
+ /// **`item_fn.sig.inputs` includes the context argument!**
+ /// Keep this in mind when creating deserializers, because you often might want to ignore it.
+ /// That might be annoying, but it would be bad design for this kind of struct to not be parsable from itself.
+ pub item_fn: ItemFn,
+ /// Parsing tries to ensure that this argument will be a [`Scope`].
+ /// **However, macros have limitations that prevent this from always working,
+ /// so don't take this for granted!**
+ pub cx_arg: FnArg,
+ /// The pattern (name) and type of the context argument.
+ pub cx_pat_type: PatType,
+ /// If the function has any arguments other than the context.
+ pub has_extra_args: bool,
+}
+
+impl ComponentBody {
+ /// Deserializes the body into the [`TOutput`] with the specific [`TArgs`].
+ /// Even if the args are empty, the [`TArg`] type still determines what [`TOutput`] will be generated.
+ pub fn deserialize(&self, args: TArgs) -> Result
+ where
+ TOutput: DeserializerOutput,
+ TArgs: DeserializerArgs,
+ {
+ args.to_output(self)
+ }
+}
+
+impl Parse for ComponentBody {
+ fn parse(input: ParseStream) -> Result {
+ let item_fn: ItemFn = input.parse()?;
+ let scope_type_path = Scope::get_path_string();
+
+ let (cx_arg, cx_pat_type) = if let Some(first_arg) = item_fn.sig.inputs.first() {
+ let incorrect_first_arg_err = Err(Error::new(
+ first_arg.span(),
+ format!("First argument must be a <{}>", scope_type_path),
+ ));
+
+ match first_arg.to_owned() {
+ FnArg::Receiver(_) => {
+ return incorrect_first_arg_err;
+ }
+ FnArg::Typed(f) => (first_arg.to_owned(), f),
+ }
+ } else {
+ return Err(Error::new(
+ item_fn.sig.ident.span(), // Or maybe just item_f.sig.span()?
+ format!(
+ "Must have at least one argument that's a <{}>",
+ scope_type_path
+ ),
+ ));
+ };
+
+ let element_type_path = Element::get_path_string();
+
+ if item_fn.sig.output == ReturnType::Default {
+ return Err(Error::new(
+ item_fn.sig.output.span(),
+ format!("Must return a <{}>", element_type_path),
+ ));
+ }
+
+ let has_extra_args = item_fn.sig.inputs.len() > 1;
+
+ Ok(Self {
+ item_fn,
+ cx_arg,
+ cx_pat_type,
+ has_extra_args,
+ })
+ }
+}
diff --git a/packages/core-macro/src/component_body/utils.rs b/packages/core-macro/src/component_body/utils.rs
new file mode 100644
index 000000000..05a2869d7
--- /dev/null
+++ b/packages/core-macro/src/component_body/utils.rs
@@ -0,0 +1,57 @@
+use crate::component_body::ComponentBody;
+use dioxus_core::{Element, Scope};
+use quote::ToTokens;
+use syn::{parse_quote, Path};
+
+/// The output produced by a deserializer.
+///
+/// # For implementors
+/// Struct field guidelines:
+/// * Must be public, so that other deserializers can utilize them.
+/// * Should usually be [`Item`]s that you then simply combine in a [`quote!`]
+/// in the [`ComponentBodyDeserializer::output_to_token_stream2`] function.
+/// * If an [`Item`] might not be included, wrap it in an [`Option`].
+/// * Must be at the component function "level"/"context".
+/// For example, the [`InlinePropsDeserializer`](crate::component_body_deserializers::inline_props::InlinePropsDeserializer)
+/// produces two [`Item`]s; the function but with arguments turned into props, and the props struct.
+/// It does not return any [`Item`]s inside the struct or function.
+pub trait DeserializerOutput: ToTokens {}
+
+impl DeserializerOutput for T {}
+
+/// The args passed to a [`ComponentBody`] when deserializing it.
+///
+/// It's also the struct that does the deserializing.
+/// It's called "DeserializerArgs", not "Deserializer". Why?
+/// Because "args" makes more sense to the caller of [`ComponentBody::deserialize`], which
+/// takes an [`DeserializerArgs`] argument. However, you can think of "DeserializerArgs" as the deserializer.
+pub trait DeserializerArgs: Clone
+where
+ TOutput: ToTokens,
+{
+ // There's a lot of Results out there... let's make sure that this is a syn::Result.
+ // Let's also make sure there's not a warning.
+ /// Creates a [`ToTokens`] struct from the `self` args and a [`ComponentBody`].
+ /// The [`ComponentBody::deserialize`] provides a cleaner way of calling this function.
+ #[allow(unused_qualifications)]
+ fn to_output(&self, component_body: &ComponentBody) -> syn::Result;
+}
+
+pub trait TypeHelper {
+ fn get_path() -> Path;
+ fn get_path_string() -> String {
+ Self::get_path().to_token_stream().to_string()
+ }
+}
+
+impl<'a> TypeHelper for Scope<'a> {
+ fn get_path() -> Path {
+ parse_quote!(::dioxus::core::Scope)
+ }
+}
+
+impl<'a> TypeHelper for Element<'a> {
+ fn get_path() -> Path {
+ parse_quote!(::dioxus::core::Element)
+ }
+}
diff --git a/packages/core-macro/src/component_body_deserializers/component.rs b/packages/core-macro/src/component_body_deserializers/component.rs
new file mode 100644
index 000000000..e43b1819f
--- /dev/null
+++ b/packages/core-macro/src/component_body_deserializers/component.rs
@@ -0,0 +1,152 @@
+use crate::component_body::{ComponentBody, DeserializerArgs};
+use crate::component_body_deserializers::inline_props::InlinePropsDeserializerArgs;
+use constcat::concat;
+use proc_macro2::TokenStream as TokenStream2;
+use quote::{quote, ToTokens, TokenStreamExt};
+use syn::*;
+
+pub(crate) const COMPONENT_ARG_CASE_CHECK_ERROR: &str = concat!(
+ "This component does not use PascalCase. \
+To ignore this check, pass the \"",
+ crate::COMPONENT_ARG_CASE_CHECK_OFF,
+ "\" argument, like so: #[component(",
+ crate::COMPONENT_ARG_CASE_CHECK_OFF,
+ ")]"
+);
+
+const INNER_FN_NAME: &str = "__dx_inner_comp";
+
+fn get_out_comp_fn(orig_comp_fn: &ItemFn, cx_pat: &Pat) -> ItemFn {
+ let inner_comp_ident = Ident::new(INNER_FN_NAME, orig_comp_fn.sig.ident.span());
+
+ let inner_comp_fn = ItemFn {
+ sig: Signature {
+ ident: inner_comp_ident.clone(),
+ ..orig_comp_fn.sig.clone()
+ },
+ ..orig_comp_fn.clone()
+ };
+
+ ItemFn {
+ block: parse_quote! {
+ {
+ #[warn(non_snake_case)]
+ #[inline(always)]
+ #inner_comp_fn
+ #inner_comp_ident (#cx_pat)
+ }
+ },
+ ..orig_comp_fn.clone()
+ }
+}
+
+/// The args and deserializing implementation for the [`crate::component`] macro.
+#[derive(Clone)]
+pub struct ComponentDeserializerArgs {
+ pub case_check: bool,
+}
+
+/// The output fields and [`ToTokens`] implementation for the [`crate::component`] macro.
+#[derive(Clone)]
+pub struct ComponentDeserializerOutput {
+ pub comp_fn: ItemFn,
+ pub props_struct: Option,
+}
+
+impl ToTokens for ComponentDeserializerOutput {
+ fn to_tokens(&self, tokens: &mut TokenStream2) {
+ let comp_fn = &self.comp_fn;
+ let props_struct = &self.props_struct;
+
+ tokens.append_all(quote! {
+ #props_struct
+ #[allow(non_snake_case)]
+ #comp_fn
+ });
+ }
+}
+
+impl DeserializerArgs for ComponentDeserializerArgs {
+ fn to_output(&self, component_body: &ComponentBody) -> Result {
+ let Signature { ident, .. } = &component_body.item_fn.sig;
+
+ if self.case_check && !is_pascal_case(&ident.to_string()) {
+ return Err(Error::new(ident.span(), COMPONENT_ARG_CASE_CHECK_ERROR));
+ }
+
+ if component_body.has_extra_args {
+ Self::deserialize_with_props(component_body)
+ } else {
+ Ok(Self::deserialize_no_props(component_body))
+ }
+ }
+}
+
+impl ComponentDeserializerArgs {
+ fn deserialize_no_props(component_body: &ComponentBody) -> ComponentDeserializerOutput {
+ let ComponentBody {
+ item_fn,
+ cx_pat_type,
+ ..
+ } = component_body;
+ let cx_pat = &cx_pat_type.pat;
+
+ let comp_fn = get_out_comp_fn(item_fn, cx_pat);
+
+ ComponentDeserializerOutput {
+ comp_fn,
+ props_struct: None,
+ }
+ }
+
+ fn deserialize_with_props(
+ component_body: &ComponentBody,
+ ) -> Result {
+ let ComponentBody {
+ item_fn,
+ cx_pat_type,
+ ..
+ } = component_body;
+ let cx_pat = &cx_pat_type.pat;
+
+ let comp_parsed = match parse2::(quote!(#item_fn)) {
+ Ok(comp_body) => comp_body,
+ Err(e) => {
+ return Err(Error::new(
+ e.span(),
+ format!(
+ "This is probably a bug in our code, please report it! Error: {}",
+ e
+ ),
+ ))
+ }
+ };
+
+ let inlined_props_output = comp_parsed.deserialize(InlinePropsDeserializerArgs {})?;
+ let props_struct = inlined_props_output.props_struct;
+ let props_fn = inlined_props_output.comp_fn;
+
+ let comp_fn = get_out_comp_fn(&props_fn, cx_pat);
+
+ Ok(ComponentDeserializerOutput {
+ comp_fn,
+ props_struct: Some(props_struct),
+ })
+ }
+}
+
+fn is_pascal_case(input: &str) -> bool {
+ let mut is_next_lowercase = false;
+
+ for c in input.chars() {
+ let is_upper = c.is_ascii_uppercase();
+
+ if (c == '_') || (is_upper && is_next_lowercase) {
+ return false;
+ }
+
+ is_next_lowercase = is_upper;
+ }
+
+ true
+}
diff --git a/packages/core-macro/src/component_body_deserializers/inline_props.rs b/packages/core-macro/src/component_body_deserializers/inline_props.rs
new file mode 100644
index 000000000..8e4581c19
--- /dev/null
+++ b/packages/core-macro/src/component_body_deserializers/inline_props.rs
@@ -0,0 +1,195 @@
+use crate::component_body::{ComponentBody, DeserializerArgs};
+use proc_macro2::TokenStream as TokenStream2;
+use quote::{quote, ToTokens, TokenStreamExt};
+use syn::token::Comma;
+use syn::{punctuated::Punctuated, *};
+
+/// The args and deserializing implementation for the [`crate::inline_props`] macro.
+#[derive(Clone)]
+pub struct InlinePropsDeserializerArgs;
+
+/// The output fields and [`ToTokens`] implementation for the [`crate::inline_props`] macro.
+#[derive(Clone)]
+pub struct InlinePropsDeserializerOutput {
+ pub comp_fn: ItemFn,
+ pub props_struct: ItemStruct,
+}
+
+impl ToTokens for InlinePropsDeserializerOutput {
+ fn to_tokens(&self, tokens: &mut TokenStream2) {
+ let function = &self.comp_fn;
+ let props_struct = &self.props_struct;
+
+ tokens.append_all(quote! {
+ #function
+ #props_struct
+ });
+ }
+}
+
+impl DeserializerArgs for InlinePropsDeserializerArgs {
+ fn to_output(&self, component_body: &ComponentBody) -> Result {
+ Ok(InlinePropsDeserializerOutput {
+ comp_fn: Self::get_function(component_body),
+ props_struct: Self::get_props_struct(component_body),
+ })
+ }
+}
+
+impl InlinePropsDeserializerArgs {
+ fn get_props_struct(component_body: &ComponentBody) -> ItemStruct {
+ let ComponentBody { item_fn, .. } = component_body;
+ let ItemFn { vis, sig, .. } = item_fn;
+ let Signature {
+ inputs,
+ ident: fn_ident,
+ generics,
+ ..
+ } = sig;
+
+ // Skip first arg since that's the context
+ let struct_fields = inputs.iter().skip(1).map(move |f| {
+ match f {
+ FnArg::Receiver(_) => unreachable!(), // Unreachable because of ComponentBody parsing
+ FnArg::Typed(pt) => {
+ let arg_pat = &pt.pat; // Pattern (identifier)
+ let arg_colon = &pt.colon_token;
+ let arg_ty = &pt.ty; // Type
+ let arg_attrs = &pt.attrs; // Attributes
+
+ quote! {
+ #(#arg_attrs)
+ *
+ #vis #arg_pat #arg_colon #arg_ty
+ }
+ }
+ }
+ });
+
+ let struct_ident = Ident::new(&format!("{fn_ident}Props"), fn_ident.span());
+
+ let first_lifetime = if let Some(GenericParam::Lifetime(lt)) = generics.params.first() {
+ Some(lt)
+ } else {
+ None
+ };
+
+ let struct_attrs = if first_lifetime.is_some() {
+ quote! { #[derive(Props)] }
+ } else {
+ quote! { #[derive(Props, PartialEq)] }
+ };
+
+ let struct_generics = if first_lifetime.is_some() {
+ let struct_generics: Punctuated = component_body
+ .item_fn
+ .sig
+ .generics
+ .params
+ .iter()
+ .map(|it| match it {
+ GenericParam::Type(tp) => {
+ let mut tp = tp.clone();
+ tp.bounds.push(parse_quote!( 'a ));
+
+ GenericParam::Type(tp)
+ }
+ _ => it.clone(),
+ })
+ .collect();
+
+ quote! { <#struct_generics> }
+ } else {
+ quote! { #generics }
+ };
+
+ parse_quote! {
+ #struct_attrs
+ #[allow(non_camel_case_types)]
+ #vis struct #struct_ident #struct_generics
+ {
+ #(#struct_fields),*
+ }
+ }
+ }
+
+ fn get_function(component_body: &ComponentBody) -> ItemFn {
+ let ComponentBody {
+ item_fn,
+ cx_pat_type,
+ ..
+ } = component_body;
+ let ItemFn {
+ attrs: fn_attrs,
+ vis,
+ sig,
+ block: fn_block,
+ } = item_fn;
+ let Signature {
+ inputs,
+ ident: fn_ident,
+ generics,
+ output: fn_output,
+ asyncness,
+ ..
+ } = sig;
+ let Generics { where_clause, .. } = generics;
+
+ let cx_pat = &cx_pat_type.pat;
+ let struct_ident = Ident::new(&format!("{fn_ident}Props"), fn_ident.span());
+
+ // Skip first arg since that's the context
+ let struct_field_names = inputs.iter().skip(1).filter_map(|f| match f {
+ FnArg::Receiver(_) => unreachable!(), // ComponentBody prohibits receiver parameters.
+ FnArg::Typed(t) => Some(&t.pat),
+ });
+
+ let first_lifetime = if let Some(GenericParam::Lifetime(lt)) = generics.params.first() {
+ Some(lt)
+ } else {
+ None
+ };
+
+ let (scope_lifetime, fn_generics) = if let Some(lt) = first_lifetime {
+ (quote! { #lt, }, generics.clone())
+ } else {
+ let lifetime: LifetimeParam = parse_quote! { 'a };
+
+ let mut fn_generics = generics.clone();
+ fn_generics
+ .params
+ .insert(0, GenericParam::Lifetime(lifetime.clone()));
+
+ (quote! { #lifetime, }, fn_generics)
+ };
+
+ let generics_no_bounds = {
+ let mut generics = generics.clone();
+ generics.params = generics
+ .params
+ .iter()
+ .map(|it| match it {
+ GenericParam::Type(tp) => {
+ let mut tp = tp.clone();
+ tp.bounds.clear();
+
+ GenericParam::Type(tp)
+ }
+ _ => it.clone(),
+ })
+ .collect();
+
+ generics
+ };
+
+ parse_quote! {
+ #(#fn_attrs)*
+ #asyncness #vis fn #fn_ident #fn_generics (#cx_pat: Scope<#scope_lifetime #struct_ident #generics_no_bounds>) #fn_output
+ #where_clause
+ {
+ let #struct_ident { #(#struct_field_names),* } = cx_pat.props;
+ #fn_block
+ }
+ }
+ }
+}
diff --git a/packages/core-macro/src/component_body_deserializers/mod.rs b/packages/core-macro/src/component_body_deserializers/mod.rs
new file mode 100644
index 000000000..a3027796d
--- /dev/null
+++ b/packages/core-macro/src/component_body_deserializers/mod.rs
@@ -0,0 +1,4 @@
+//! This module contains all [`ComponentBody`](crate::component_body::ComponentBody) deserializers.
+
+pub mod component;
+pub mod inline_props;
diff --git a/packages/core-macro/src/inlineprops.rs b/packages/core-macro/src/inlineprops.rs
deleted file mode 100644
index ccc00f4f9..000000000
--- a/packages/core-macro/src/inlineprops.rs
+++ /dev/null
@@ -1,185 +0,0 @@
-use proc_macro2::{Span, TokenStream as TokenStream2};
-use quote::{quote, ToTokens, TokenStreamExt};
-use syn::{
- parse::{Parse, ParseStream},
- punctuated::Punctuated,
- *,
-};
-
-pub struct InlinePropsBody {
- pub attrs: Vec,
- pub vis: syn::Visibility,
- pub maybe_async: Option,
- pub fn_token: Token![fn],
- pub ident: Ident,
- pub cx_token: Box,
- pub generics: Generics,
- pub paren_token: token::Paren,
- pub inputs: Punctuated,
- // pub fields: FieldsNamed,
- pub output: ReturnType,
- pub where_clause: Option,
- pub block: Box,
-}
-
-/// The custom rusty variant of parsing rsx!
-impl Parse for InlinePropsBody {
- fn parse(input: ParseStream) -> Result {
- let attrs: Vec = input.call(Attribute::parse_outer)?;
- let maybe_async: Option = input.parse().ok();
- let vis: Visibility = input.parse()?;
-
- let fn_token = input.parse()?;
- let ident = input.parse()?;
- let generics: Generics = input.parse()?;
-
- let content;
- let paren_token = syn::parenthesized!(content in input);
-
- let first_arg: FnArg = content.parse()?;
- let cx_token = {
- match first_arg {
- FnArg::Receiver(_) => panic!("first argument must not be a receiver argument"),
- FnArg::Typed(f) => f.pat,
- }
- };
-
- let _: Result = content.parse();
-
- let inputs = syn::punctuated::Punctuated::parse_terminated(&content)?;
-
- let output = input.parse()?;
-
- let where_clause = input
- .peek(syn::token::Where)
- .then(|| input.parse())
- .transpose()?;
-
- let block = input.parse()?;
-
- Ok(Self {
- vis,
- maybe_async,
- fn_token,
- ident,
- generics,
- paren_token,
- inputs,
- output,
- where_clause,
- block,
- cx_token,
- attrs,
- })
- }
-}
-
-/// Serialize the same way, regardless of flavor
-impl ToTokens for InlinePropsBody {
- fn to_tokens(&self, out_tokens: &mut TokenStream2) {
- let Self {
- vis,
- ident,
- generics,
- inputs,
- output,
- where_clause,
- block,
- cx_token,
- attrs,
- maybe_async,
- ..
- } = self;
-
- let fields = inputs.iter().map(|f| {
- quote! { #vis #f }
- });
-
- let struct_name = Ident::new(&format!("{ident}Props"), Span::call_site());
-
- let field_names = inputs.iter().filter_map(|f| match f {
- FnArg::Receiver(_) => todo!(),
- FnArg::Typed(t) => Some(&t.pat),
- });
-
- let first_lifetime = if let Some(GenericParam::Lifetime(lt)) = generics.params.first() {
- Some(lt)
- } else {
- None
- };
-
- let modifiers = if first_lifetime.is_some() {
- quote! { #[derive(Props)] }
- } else {
- quote! { #[derive(Props, PartialEq)] }
- };
-
- let (scope_lifetime, fn_generics, struct_generics) = if let Some(lt) = first_lifetime {
- let struct_generics: Punctuated<_, token::Comma> = generics
- .params
- .iter()
- .map(|it| match it {
- GenericParam::Type(tp) => {
- let mut tp = tp.clone();
- tp.bounds.push(parse_quote!( 'a ));
-
- GenericParam::Type(tp)
- }
- _ => it.clone(),
- })
- .collect();
-
- (
- quote! { #lt, },
- generics.clone(),
- quote! { <#struct_generics> },
- )
- } else {
- let lifetime: LifetimeParam = parse_quote! { 'a };
-
- let mut fn_generics = generics.clone();
- fn_generics
- .params
- .insert(0, GenericParam::Lifetime(lifetime.clone()));
-
- (quote! { #lifetime, }, fn_generics, quote! { #generics })
- };
-
- let generics_no_bounds = {
- let mut generics = generics.clone();
- generics.params = generics
- .params
- .iter()
- .map(|it| match it {
- GenericParam::Type(tp) => {
- let mut tp = tp.clone();
- tp.bounds.clear();
-
- GenericParam::Type(tp)
- }
- _ => it.clone(),
- })
- .collect();
-
- generics
- };
-
- out_tokens.append_all(quote! {
- #modifiers
- #[allow(non_camel_case_types)]
- #vis struct #struct_name #struct_generics
- #where_clause
- {
- #(#fields),*
- }
-
- #(#attrs)*
- #maybe_async #vis fn #ident #fn_generics (#cx_token: Scope<#scope_lifetime #struct_name #generics_no_bounds>) #output
- #where_clause
- {
- let #struct_name { #(#field_names),* } = cx_token.props;
- #block
- }
- });
- }
-}
diff --git a/packages/core-macro/src/lib.rs b/packages/core-macro/src/lib.rs
index 501c38e7b..d91c72e39 100644
--- a/packages/core-macro/src/lib.rs
+++ b/packages/core-macro/src/lib.rs
@@ -1,12 +1,18 @@
use proc_macro::TokenStream;
use quote::ToTokens;
use rsx::RenderCallBody;
-use syn::parse_macro_input;
+use syn::parse::Parser;
+use syn::punctuated::Punctuated;
+use syn::{parse_macro_input, Path, Token};
-mod inlineprops;
+mod component_body;
+mod component_body_deserializers;
mod props;
// mod rsx;
+use crate::component_body::ComponentBody;
+use crate::component_body_deserializers::component::ComponentDeserializerArgs;
+use crate::component_body_deserializers::inline_props::InlinePropsDeserializerArgs;
use dioxus_rsx as rsx;
#[proc_macro]
@@ -18,7 +24,7 @@ pub fn format_args_f(input: TokenStream) -> TokenStream {
}
#[proc_macro_derive(Props, attributes(props))]
-pub fn derive_typed_builder(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
+pub fn derive_typed_builder(input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input as syn::DeriveInput);
match props::impl_my_derive(&input) {
Ok(output) => output.into(),
@@ -37,7 +43,7 @@ pub fn rsx(s: TokenStream) -> TokenStream {
/// The render! macro makes it easy for developers to write jsx-style markup in their components.
///
-/// The render macro automatically renders rsx - making it unhygenic.
+/// The render macro automatically renders rsx - making it unhygienic.
#[proc_macro]
pub fn render(s: TokenStream) -> TokenStream {
match syn::parse::(s) {
@@ -55,7 +61,7 @@ pub fn render(s: TokenStream) -> TokenStream {
/// you would be repeating a lot of the usual Rust boilerplate.
///
/// # Example
-/// ```ignore
+/// ```rust,ignore
/// #[inline_props]
/// fn app(cx: Scope, bob: String) -> Element {
/// cx.render(rsx!("hello, {bob}"))
@@ -73,9 +79,118 @@ pub fn render(s: TokenStream) -> TokenStream {
/// }
/// ```
#[proc_macro_attribute]
-pub fn inline_props(_args: proc_macro::TokenStream, s: TokenStream) -> TokenStream {
- match syn::parse::(s) {
+#[deprecated(note = "Use `#[component]` instead.")]
+pub fn inline_props(_args: TokenStream, s: TokenStream) -> TokenStream {
+ let comp_body = parse_macro_input!(s as ComponentBody);
+
+ match comp_body.deserialize(InlinePropsDeserializerArgs {}) {
Err(e) => e.to_compile_error().into(),
- Ok(s) => s.to_token_stream().into(),
+ Ok(output) => output.to_token_stream().into(),
+ }
+}
+
+pub(crate) const COMPONENT_ARG_CASE_CHECK_OFF: &str = "no_case_check";
+
+/// Streamlines component creation.
+/// This is the recommended way of creating components,
+/// though you might want lower-level control with more advanced uses.
+///
+/// # Arguments
+/// * `no_case_check` - Doesn't enforce `PascalCase` on your component names.
+/// **This will be removed/deprecated in a future update in favor of a more complete Clippy-backed linting system.**
+/// The reasoning behind this is that Clippy allows more robust and powerful lints, whereas
+/// macros are extremely limited.
+///
+/// # Features
+/// This attribute:
+/// * Enforces that your component uses `PascalCase`.
+/// No warnings are generated for the `PascalCase`
+/// function name, but everything else will still raise a warning if it's incorrectly `PascalCase`.
+/// Does not disable warnings anywhere else, so if you, for example,
+/// accidentally don't use `snake_case`
+/// for a variable name in the function, the compiler will still warn you.
+/// * Automatically uses `#[inline_props]` if there's more than 1 parameter in the function.
+/// * Verifies the validity of your component.
+/// E.g. if it has a [`Scope`](dioxus_core::Scope) argument.
+/// Notes:
+/// * This doesn't work 100% of the time, because of macro limitations.
+/// * Provides helpful messages if your component is not correct.
+/// Possible bugs (please, report these!):
+/// * There might be bugs where it incorrectly *denies* validity.
+/// This is bad as it means that you can't use the attribute or you have to change the component.
+/// * There might be bugs where it incorrectly *confirms* validity.
+/// You will still know if the component is invalid once you use it,
+/// but the error might be less helpful.
+///
+/// # Examples
+/// * Without props:
+/// ```rust,ignore
+/// #[component]
+/// fn GreetBob(cx: Scope) -> Element {
+/// render! { "hello, bob" }
+/// }
+///
+/// // is equivalent to
+///
+/// #[allow(non_snake_case)]
+/// fn GreetBob(cx: Scope) -> Element {
+/// #[warn(non_snake_case)]
+/// #[inline(always)]
+/// fn __dx_inner_comp(cx: Scope) -> Element {
+/// render! { "hello, bob" }
+/// }
+/// // There's no function call overhead since __dx_inner_comp has the #[inline(always)] attribute,
+/// // so don't worry about performance.
+/// __dx_inner_comp(cx)
+/// }
+/// ```
+/// * With props:
+/// ```rust,ignore
+/// #[component(no_case_check)]
+/// fn GreetPerson(cx: Scope, person: String) -> Element {
+/// render! { "hello, {person}" }
+/// }
+///
+/// // is equivalent to
+///
+/// #[derive(Props, PartialEq)]
+/// #[allow(non_camel_case_types)]
+/// struct GreetPersonProps {
+/// person: String,
+/// }
+///
+/// #[allow(non_snake_case)]
+/// fn GreetPerson<'a>(cx: Scope<'a, GreetPersonProps>) -> Element {
+/// #[warn(non_snake_case)]
+/// #[inline(always)]
+/// fn __dx_inner_comp<'a>(cx: Scope<'a, GreetPersonProps>e) -> Element {
+/// let GreetPersonProps { person } = &cx.props;
+/// {
+/// render! { "hello, {person}" }
+/// }
+/// }
+///
+/// __dx_inner_comp(cx)
+/// }
+/// ```
+// TODO: Maybe add an option to input a custom component name through the args.
+// I think that's unnecessary, but there might be some scenario where it could be useful.
+#[proc_macro_attribute]
+pub fn component(args: TokenStream, input: TokenStream) -> TokenStream {
+ let component_body = parse_macro_input!(input as ComponentBody);
+ let case_check = match Punctuated::::parse_terminated.parse(args) {
+ Err(e) => return e.to_compile_error().into(),
+ Ok(args) => {
+ if let Some(first) = args.first() {
+ !first.is_ident(COMPONENT_ARG_CASE_CHECK_OFF)
+ } else {
+ true
+ }
+ }
+ };
+
+ match component_body.deserialize(ComponentDeserializerArgs { case_check }) {
+ Err(e) => e.to_compile_error().into(),
+ Ok(output) => output.to_token_stream().into(),
}
}
diff --git a/packages/core-macro/src/props/mod.rs b/packages/core-macro/src/props/mod.rs
index 6a0d24a95..c1931e497 100644
--- a/packages/core-macro/src/props/mod.rs
+++ b/packages/core-macro/src/props/mod.rs
@@ -2,9 +2,9 @@
//!
//! However, it has been adopted to fit the Dioxus Props builder pattern.
//!
-//! For dioxus, we make a few changes:
-//! - [ ] automatically implement Into on the setters (IE the strip setter option)
-//! - [ ] automatically implement a default of none for optional fields (those explicitly wrapped with Option)
+//! For Dioxus, we make a few changes:
+//! - [ ] Automatically implement Into on the setters (IE the strip setter option)
+//! - [ ] Automatically implement a default of none for optional fields (those explicitly wrapped with Option)
use proc_macro2::TokenStream;
@@ -194,8 +194,9 @@ mod field_info {
// children field is automatically defaulted to None
if name == "children" {
- builder_attr.default =
- Some(syn::parse(quote!(Default::default()).into()).unwrap());
+ builder_attr.default = Some(
+ syn::parse(quote!(::core::default::Default::default()).into()).unwrap(),
+ );
}
// auto detect optional
@@ -204,8 +205,9 @@ mod field_info {
&& type_from_inside_option(&field.ty, true).is_some();
if !builder_attr.strip_option && strip_option_auto {
builder_attr.strip_option = true;
- builder_attr.default =
- Some(syn::parse(quote!(Default::default()).into()).unwrap());
+ builder_attr.default = Some(
+ syn::parse(quote!(::core::default::Default::default()).into()).unwrap(),
+ );
}
Ok(FieldInfo {
@@ -213,7 +215,7 @@ mod field_info {
name,
generic_ident: syn::Ident::new(
&format!("__{}", strip_raw_ident_prefix(name.to_string())),
- proc_macro2::Span::call_site(),
+ name.span(),
),
ty: &field.ty,
builder_attr,
@@ -345,14 +347,18 @@ mod field_info {
.ok_or_else(|| Error::new_spanned(&path, "Expected identifier"))?;
match name.as_str() {
"default" => {
- self.default =
- Some(syn::parse(quote!(Default::default()).into()).unwrap());
+ self.default = Some(
+ syn::parse(quote!(::core::default::Default::default()).into())
+ .unwrap(),
+ );
Ok(())
}
"optional" => {
- self.default =
- Some(syn::parse(quote!(Default::default()).into()).unwrap());
+ self.default = Some(
+ syn::parse(quote!(::core::default::Default::default()).into())
+ .unwrap(),
+ );
self.strip_option = true;
Ok(())
}
@@ -505,15 +511,12 @@ mod struct_info {
.map(|(i, f)| FieldInfo::new(i, f, builder_attr.field_defaults.clone()))
.collect::>()?,
builder_attr,
- builder_name: syn::Ident::new(&builder_name, proc_macro2::Span::call_site()),
+ builder_name: syn::Ident::new(&builder_name, ast.ident.span()),
conversion_helper_trait_name: syn::Ident::new(
&format!("{builder_name}_Optional"),
- proc_macro2::Span::call_site(),
- ),
- core: syn::Ident::new(
- &format!("{builder_name}_core"),
- proc_macro2::Span::call_site(),
+ ast.ident.span(),
),
+ core: syn::Ident::new(&format!("{builder_name}_core"), ast.ident.span()),
})
}
@@ -551,11 +554,11 @@ mod struct_info {
let phantom_generics = self.generics.params.iter().map(|param| match param {
syn::GenericParam::Lifetime(lifetime) => {
let lifetime = &lifetime.lifetime;
- quote!(core::marker::PhantomData<lifetime ()>)
+ quote!(::core::marker::PhantomData<lifetime ()>)
}
syn::GenericParam::Type(ty) => {
let ty = &ty.ident;
- quote!(core::marker::PhantomData<#ty>)
+ quote!(::core::marker::PhantomData<#ty>)
}
syn::GenericParam::Const(_cnst) => {
quote!()
@@ -634,7 +637,7 @@ Finally, call `.build()` to create the instance of `{name}`.
#vis fn builder() -> #builder_name #generics_with_empty {
#builder_name {
fields: #empties_tuple,
- _phantom: core::default::Default::default(),
+ _phantom: ::core::default::Default::default(),
}
}
}
@@ -651,12 +654,12 @@ Finally, call `.build()` to create the instance of `{name}`.
fn clone(&self) -> Self {
Self {
fields: self.fields.clone(),
- _phantom: Default::default(),
+ _phantom: ::core::default::Default::default(),
}
}
}
- impl #impl_generics dioxus::prelude::Properties for #name #ty_generics
+ impl #impl_generics ::dioxus::prelude::Properties for #name #ty_generics
#b_generics_where_extras_predicates
{
type Builder = #builder_name #generics_with_empty;
@@ -793,7 +796,7 @@ Finally, call `.build()` to create the instance of `{name}`.
};
let (arg_type, arg_expr) = if field.builder_attr.auto_into {
(
- quote!(impl core::convert::Into<#arg_type>),
+ quote!(impl ::core::convert::Into<#arg_type>),
quote!(#field_name.into()),
)
} else {
@@ -811,7 +814,7 @@ Finally, call `.build()` to create the instance of `{name}`.
builder_name,
strip_raw_ident_prefix(field_name.to_string())
),
- proc_macro2::Span::call_site(),
+ builder_name.span(),
);
let repeated_fields_error_message = format!("Repeated field {field_name}");
@@ -930,7 +933,7 @@ Finally, call `.build()` to create the instance of `{name}`.
builder_name,
strip_raw_ident_prefix(field_name.to_string())
),
- proc_macro2::Span::call_site(),
+ builder_name.span(),
);
let early_build_error_message = format!("Missing required field {field_name}");
diff --git a/packages/core/Cargo.toml b/packages/core/Cargo.toml
index 7c9515fc0..ce7c6bccf 100644
--- a/packages/core/Cargo.toml
+++ b/packages/core/Cargo.toml
@@ -28,7 +28,7 @@ slab = { workspace = true }
futures-channel = { workspace = true }
smallbox = "0.8.1"
-log = { workspace = true }
+tracing = { workspace = true }
# Serialize the Edits for use in Webview/Liveview instances
serde = { version = "1", features = ["derive"], optional = true }
@@ -39,6 +39,7 @@ dioxus = { workspace = true }
pretty_assertions = "1.3.0"
rand = "0.8.5"
dioxus-ssr = { workspace = true }
+trybuild = "1.0"
[features]
default = []
diff --git a/packages/core/compile_tests/props_safety.rs b/packages/core/compile_tests/props_safety.rs
new file mode 100644
index 000000000..a9729cec9
--- /dev/null
+++ b/packages/core/compile_tests/props_safety.rs
@@ -0,0 +1,32 @@
+use dioxus::prelude::*;
+
+fn main() {}
+
+fn app(cx: Scope) -> Element {
+ let count: &RefCell> = cx.use_hook(|| RefCell::new(Vec::new()));
+
+ render! {
+ unsafe_child_component {
+ borrowed: count
+ }
+ }
+}
+
+#[derive(Props)]
+struct Testing<'a> {
+ borrowed: &'a RefCell>>,
+}
+
+fn unsafe_child_component<'a>(cx: Scope<'a, Testing<'a>>) -> Element<'a> {
+ let Testing { borrowed } = cx.props;
+ let borrowed_temporary_data =
+ cx.use_hook(|| String::from("This data is only valid for the lifetime of the child"));
+
+ borrowed
+ .borrow_mut()
+ .push(render! {"{borrowed_temporary_data}"});
+
+ cx.render(rsx! {
+ div { "Hello, world!" }
+ })
+}
diff --git a/packages/core/compile_tests/props_safety.stderr b/packages/core/compile_tests/props_safety.stderr
new file mode 100644
index 000000000..565d7b6cc
--- /dev/null
+++ b/packages/core/compile_tests/props_safety.stderr
@@ -0,0 +1,20 @@
+error[E0521]: borrowed data escapes outside of function
+ --> compile_tests/props_safety.rs:8:5
+ |
+5 | fn app(cx: Scope) -> Element {
+ | --
+ | |
+ | `cx` is a reference that is only valid in the function body
+ | has type `&'1 Scoped<'1>`
+...
+8 | / render! {
+9 | | unsafe_child_component {
+10 | | borrowed: count
+11 | | }
+12 | | }
+ | | ^
+ | | |
+ | |_____`cx` escapes the function body here
+ | argument requires that `'1` must outlive `'static`
+ |
+ = note: this error originates in the macro `render` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/packages/core/compile_tests/props_safety_temporary_values.rs b/packages/core/compile_tests/props_safety_temporary_values.rs
new file mode 100644
index 000000000..c332f63c4
--- /dev/null
+++ b/packages/core/compile_tests/props_safety_temporary_values.rs
@@ -0,0 +1,24 @@
+use dioxus::prelude::*;
+
+fn main() {}
+
+fn app(cx: Scope) -> Element {
+ let count = vec![1, 2, 3];
+
+ render! {
+ unsafe_child_component {
+ borrowed: &count
+ }
+ }
+}
+
+#[derive(Props)]
+struct Testing<'a> {
+ borrowed: &'a Vec,
+}
+
+fn unsafe_child_component<'a>(cx: Scope<'a, Testing<'a>>) -> Element<'a> {
+ cx.render(rsx! {
+ div { "{cx.props.borrowed:?}" }
+ })
+}
diff --git a/packages/core/compile_tests/props_safety_temporary_values.stderr b/packages/core/compile_tests/props_safety_temporary_values.stderr
new file mode 100644
index 000000000..c1ef443c9
--- /dev/null
+++ b/packages/core/compile_tests/props_safety_temporary_values.stderr
@@ -0,0 +1,12 @@
+error[E0515]: cannot return value referencing local variable `count`
+ --> compile_tests/props_safety_temporary_values.rs:8:5
+ |
+8 | / render! {
+9 | | unsafe_child_component {
+10 | | borrowed: &count
+ | | ------ `count` is borrowed here
+11 | | }
+12 | | }
+ | |_____^ returns a value referencing data owned by the current function
+ |
+ = note: this error originates in the macro `render` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/packages/core/src/any_props.rs b/packages/core/src/any_props.rs
index de403e5c6..f14a78065 100644
--- a/packages/core/src/any_props.rs
+++ b/packages/core/src/any_props.rs
@@ -68,7 +68,7 @@ unsafe impl<'a, P> AnyProps<'a> for VProps<'a, P> {
Ok(None) => RenderReturn::default(),
Err(err) => {
let component_name = cx.name();
- log::error!("Error while rendering component `{component_name}`: {err:?}");
+ tracing::error!("Error while rendering component `{component_name}`: {err:?}");
RenderReturn::default()
}
}
diff --git a/packages/core/src/arena.rs b/packages/core/src/arena.rs
index b6254136d..b7f768755 100644
--- a/packages/core/src/arena.rs
+++ b/packages/core/src/arena.rs
@@ -19,6 +19,9 @@ pub(crate) struct ElementRef {
// The actual template
pub template: Option>>,
+
+ // The scope the element belongs to
+ pub scope: ScopeId,
}
#[derive(Clone, Copy, Debug)]
@@ -32,6 +35,7 @@ impl ElementRef {
Self {
template: None,
path: ElementPath::Root(0),
+ scope: ScopeId::ROOT,
}
}
}
@@ -56,11 +60,13 @@ impl VirtualDom {
fn next_reference(&mut self, template: &VNode, path: ElementPath) -> ElementId {
let entry = self.elements.vacant_entry();
let id = entry.key();
+ let scope = self.runtime.current_scope_id().unwrap_or(ScopeId::ROOT);
entry.insert(ElementRef {
// We know this is non-null because it comes from a reference
template: Some(unsafe { NonNull::new_unchecked(template as *const _ as *mut _) }),
path,
+ scope,
});
ElementId(id)
}
@@ -91,7 +97,7 @@ impl VirtualDom {
// Note: This will not remove any ids from the arena
pub(crate) fn drop_scope(&mut self, id: ScopeId, recursive: bool) {
self.dirty_scopes.remove(&DirtyScope {
- height: self.scopes[id.0].height,
+ height: self.scopes[id.0].height(),
id,
});
@@ -110,10 +116,13 @@ impl VirtualDom {
// Drop all the hooks once the children are dropped
// this means we'll drop hooks bottom-up
scope.hooks.get_mut().clear();
+ {
+ let context = scope.context();
- // Drop all the futures once the hooks are dropped
- for task_id in scope.spawned_tasks.borrow_mut().drain() {
- scope.tasks.remove(task_id);
+ // Drop all the futures once the hooks are dropped
+ for task_id in context.spawned_tasks.borrow_mut().drain() {
+ context.tasks.remove(task_id);
+ }
}
self.scopes.remove(id.0);
diff --git a/packages/core/src/create.rs b/packages/core/src/create.rs
index 6159c882b..a61a8cace 100644
--- a/packages/core/src/create.rs
+++ b/packages/core/src/create.rs
@@ -66,10 +66,10 @@ impl<'b> VirtualDom {
///
/// This method pushes the ScopeID to the internal scopestack and returns the number of nodes created.
pub(crate) fn create_scope(&mut self, scope: ScopeId, template: &'b VNode<'b>) -> usize {
- self.scope_stack.push(scope);
- let out = self.create(template);
- self.scope_stack.pop();
- out
+ self.runtime.scope_stack.borrow_mut().push(scope);
+ let nodes = self.create(template);
+ self.runtime.scope_stack.borrow_mut().pop();
+ nodes
}
/// Create this template and write its mutations
@@ -87,8 +87,12 @@ impl<'b> VirtualDom {
}
}
- // Intialize the root nodes slice
- *node.root_ids.borrow_mut() = vec![ElementId(0); node.template.get().roots.len()];
+ // Initialize the root nodes slice
+ {
+ let mut nodes_mut = node.root_ids.borrow_mut();
+ let len = node.template.get().roots.len();
+ nodes_mut.resize(len, ElementId::default());
+ };
// The best renderers will have templates prehydrated and registered
// Just in case, let's create the template using instructions anyways
@@ -522,7 +526,7 @@ impl<'b> VirtualDom {
.take()
.map(|props| {
let unbounded_props: Box = unsafe { std::mem::transmute(props) };
- self.new_scope(unbounded_props, component.name).id
+ self.new_scope(unbounded_props, component.name).context().id
})
.unwrap_or_else(|| component.scope.get().unwrap())
}
diff --git a/packages/core/src/diff.rs b/packages/core/src/diff.rs
index 7865224aa..74017db0f 100644
--- a/packages/core/src/diff.rs
+++ b/packages/core/src/diff.rs
@@ -15,9 +15,8 @@ use DynamicNode::*;
impl<'b> VirtualDom {
pub(super) fn diff_scope(&mut self, scope: ScopeId) {
- let scope_state = &mut self.scopes[scope.0];
-
- self.scope_stack.push(scope);
+ self.runtime.scope_stack.borrow_mut().push(scope);
+ let scope_state = &mut self.get_scope(scope).unwrap();
unsafe {
// Load the old and new bump arenas
let old = scope_state
@@ -47,7 +46,7 @@ impl<'b> VirtualDom {
(Aborted(l), Ready(r)) => self.replace_placeholder(l, [r]),
};
}
- self.scope_stack.pop();
+ self.runtime.scope_stack.borrow_mut().pop();
}
fn diff_ok_to_err(&mut self, l: &'b VNode<'b>, p: &'b VPlaceholder) {
@@ -129,7 +128,13 @@ impl<'b> VirtualDom {
});
// Make sure the roots get transferred over while we're here
- *right_template.root_ids.borrow_mut() = left_template.root_ids.borrow().clone();
+ {
+ let mut right = right_template.root_ids.borrow_mut();
+ right.clear();
+ for &element in left_template.root_ids.borrow().iter() {
+ right.push(element);
+ }
+ }
let root_ids = right_template.root_ids.borrow();
@@ -191,7 +196,8 @@ impl<'b> VirtualDom {
right.scope.set(Some(scope_id));
// copy out the box for both
- let old = self.scopes[scope_id.0].props.as_ref();
+ let old_scope = &self.scopes[scope_id.0];
+ let old = old_scope.props.as_ref();
let new: Box = right.props.take().unwrap();
let new: Box = unsafe { std::mem::transmute(new) };
@@ -199,6 +205,11 @@ impl<'b> VirtualDom {
// The target scopestate still has the reference to the old props, so there's no need to update anything
// This also implicitly drops the new props since they're not used
if left.static_props && unsafe { old.as_ref().unwrap().memoize(new.as_ref()) } {
+ tracing::trace!(
+ "Memoized props for component {:#?} ({})",
+ scope_id,
+ old_scope.context().name
+ );
return;
}
@@ -210,7 +221,7 @@ impl<'b> VirtualDom {
self.diff_scope(scope_id);
self.dirty_scopes.remove(&DirtyScope {
- height: self.scopes[scope_id.0].height,
+ height: self.runtime.get_context(scope_id).unwrap().height,
id: scope_id,
});
}
@@ -572,8 +583,7 @@ impl<'b> VirtualDom {
}
// 4. Compute the LIS of this list
- let mut lis_sequence = Vec::default();
- lis_sequence.reserve(new_index_to_old_index.len());
+ let mut lis_sequence = Vec::with_capacity(new_index_to_old_index.len());
let mut predecessors = vec![0; new_index_to_old_index.len()];
let mut starts = vec![0; new_index_to_old_index.len()];
@@ -714,7 +724,12 @@ impl<'b> VirtualDom {
Component(comp) => {
let scope = comp.scope.get().unwrap();
- match unsafe { self.scopes[scope.0].root_node().extend_lifetime_ref() } {
+ match unsafe {
+ self.get_scope(scope)
+ .unwrap()
+ .root_node()
+ .extend_lifetime_ref()
+ } {
RenderReturn::Ready(node) => self.push_all_real_nodes(node),
RenderReturn::Aborted(_node) => todo!(),
}
@@ -915,7 +930,12 @@ impl<'b> VirtualDom {
.expect("VComponents to always have a scope");
// Remove the component from the dom
- match unsafe { self.scopes[scope.0].root_node().extend_lifetime_ref() } {
+ match unsafe {
+ self.get_scope(scope)
+ .unwrap()
+ .root_node()
+ .extend_lifetime_ref()
+ } {
RenderReturn::Ready(t) => self.remove_node(t, gen_muts),
RenderReturn::Aborted(placeholder) => self.remove_placeholder(placeholder, gen_muts),
};
@@ -936,7 +956,12 @@ impl<'b> VirtualDom {
Some(Placeholder(t)) => t.id.get().unwrap(),
Some(Component(comp)) => {
let scope = comp.scope.get().unwrap();
- match unsafe { self.scopes[scope.0].root_node().extend_lifetime_ref() } {
+ match unsafe {
+ self.get_scope(scope)
+ .unwrap()
+ .root_node()
+ .extend_lifetime_ref()
+ } {
RenderReturn::Ready(t) => self.find_first_element(t),
_ => todo!("cannot handle nonstandard nodes"),
}
@@ -952,7 +977,12 @@ impl<'b> VirtualDom {
Some(Placeholder(t)) => t.id.get().unwrap(),
Some(Component(comp)) => {
let scope = comp.scope.get().unwrap();
- match unsafe { self.scopes[scope.0].root_node().extend_lifetime_ref() } {
+ match unsafe {
+ self.get_scope(scope)
+ .unwrap()
+ .root_node()
+ .extend_lifetime_ref()
+ } {
RenderReturn::Ready(t) => self.find_last_element(t),
_ => todo!("cannot handle nonstandard nodes"),
}
diff --git a/packages/core/src/error_boundary.rs b/packages/core/src/error_boundary.rs
index 071fbe48b..819d2f99e 100644
--- a/packages/core/src/error_boundary.rs
+++ b/packages/core/src/error_boundary.rs
@@ -49,17 +49,16 @@ impl ErrorBoundary {
/// A trait to allow results to be thrown upwards to the nearest Error Boundary
///
/// The canonical way of using this trait is to throw results from hooks, aborting rendering
-/// through question mark synax. The throw method returns an option that evalutes to None
+/// through question mark syntax. The throw method returns an option that evaluates to None
/// if there is an error, injecting the error to the nearest error boundary.
///
-/// If the value is `Ok`, then throw returns the value, not aborting the rendering preocess.
+/// If the value is `Ok`, then throw returns the value, not aborting the rendering process.
///
/// The call stack is saved for this component and provided to the error boundary
///
/// ```rust, ignore
-///
-/// #[inline_props]
-/// fn app(cx: Scope, count: String) -> Element {
+/// #[component]
+/// fn App(cx: Scope, count: String) -> Element {
/// let id: i32 = count.parse().throw(cx)?;
///
/// cx.render(rsx! {
@@ -71,9 +70,9 @@ pub trait Throw: Sized {
/// The value that will be returned in if the given value is `Ok`.
type Out;
- /// Returns an option that evalutes to None if there is an error, injecting the error to the nearest error boundary.
+ /// Returns an option that evaluates to None if there is an error, injecting the error to the nearest error boundary.
///
- /// If the value is `Ok`, then throw returns the value, not aborting the rendering preocess.
+ /// If the value is `Ok`, then throw returns the value, not aborting the rendering process.
///
/// The call stack is saved for this component and provided to the error boundary
///
@@ -83,9 +82,8 @@ pub trait Throw: Sized {
///
///
/// ```rust, ignore
- ///
- /// #[inline_props]
- /// fn app(cx: Scope, count: String) -> Element {
+ /// #[component]
+ /// fn App(cx: Scope, count: String) -> Element {
/// let id: i32 = count.parse().throw(cx)?;
///
/// cx.render(rsx! {
@@ -95,9 +93,9 @@ pub trait Throw: Sized {
/// ```
fn throw(self, cx: &ScopeState) -> Option;
- /// Returns an option that evalutes to None if there is an error, injecting the error to the nearest error boundary.
+ /// Returns an option that evaluates to None if there is an error, injecting the error to the nearest error boundary.
///
- /// If the value is `Ok`, then throw returns the value, not aborting the rendering preocess.
+ /// If the value is `Ok`, then throw returns the value, not aborting the rendering process.
///
/// The call stack is saved for this component and provided to the error boundary
///
@@ -107,9 +105,8 @@ pub trait Throw: Sized {
///
///
/// ```rust, ignore
- ///
- /// #[inline_props]
- /// fn app(cx: Scope, count: String) -> Element {
+ /// #[component]
+ /// fn App(cx: Scope, count: String) -> Element {
/// let id: i32 = count.parse().throw(cx)?;
///
/// cx.render(rsx! {
diff --git a/packages/core/src/events.rs b/packages/core/src/events.rs
index ce958db40..3b8edb05c 100644
--- a/packages/core/src/events.rs
+++ b/packages/core/src/events.rs
@@ -1,3 +1,4 @@
+use crate::{runtime::with_runtime, ScopeId};
use std::{
cell::{Cell, RefCell},
rc::Rc,
@@ -117,7 +118,7 @@ impl std::fmt::Debug for Event {
///
/// ```rust, ignore
/// rsx!{
-/// MyComponent { onclick: move |evt| log::info!("clicked") }
+/// MyComponent { onclick: move |evt| tracing::debug!("clicked") }
/// }
///
/// #[derive(Props)]
@@ -135,12 +136,14 @@ impl std::fmt::Debug for Event {
///
/// ```
pub struct EventHandler<'bump, T = ()> {
+ pub(crate) origin: ScopeId,
pub(super) callback: RefCell>>,
}
impl Default for EventHandler<'_, T> {
fn default() -> Self {
Self {
+ origin: ScopeId::ROOT,
callback: Default::default(),
}
}
@@ -154,7 +157,13 @@ impl EventHandler<'_, T> {
/// This borrows the event using a RefCell. Recursively calling a listener will cause a panic.
pub fn call(&self, event: T) {
if let Some(callback) = self.callback.borrow_mut().as_mut() {
+ with_runtime(|rt| {
+ rt.scope_stack.borrow_mut().push(self.origin);
+ });
callback(event);
+ with_runtime(|rt| {
+ rt.scope_stack.borrow_mut().pop();
+ });
}
}
diff --git a/packages/core/src/lib.rs b/packages/core/src/lib.rs
index 565ae12be..5b2f83305 100644
--- a/packages/core/src/lib.rs
+++ b/packages/core/src/lib.rs
@@ -14,8 +14,10 @@ mod lazynodes;
mod mutations;
mod nodes;
mod properties;
+mod runtime;
mod scheduler;
mod scope_arena;
+mod scope_context;
mod scopes;
mod virtual_dom;
@@ -30,7 +32,9 @@ pub(crate) mod innerlude {
pub use crate::nodes::RenderReturn;
pub use crate::nodes::*;
pub use crate::properties::*;
+ pub use crate::runtime::{in_runtime, override_runtime, Runtime};
pub use crate::scheduler::*;
+ pub use crate::scope_context::*;
pub use crate::scopes::*;
pub use crate::virtual_dom::*;
@@ -70,10 +74,11 @@ pub(crate) mod innerlude {
}
pub use crate::innerlude::{
- fc_to_builder, AnyValue, Attribute, AttributeValue, BorrowedAttributeValue, CapturedError,
- Component, DynamicNode, Element, ElementId, Event, Fragment, IntoDynNode, LazyNodes, Mutation,
- Mutations, Properties, RenderReturn, Scope, ScopeId, ScopeState, Scoped, TaskId, Template,
- TemplateAttribute, TemplateNode, VComponent, VNode, VPlaceholder, VText, VirtualDom,
+ fc_to_builder, vdom_is_rendering, AnyValue, Attribute, AttributeValue, BorrowedAttributeValue,
+ CapturedError, Component, DynamicNode, Element, ElementId, Event, Fragment, IntoDynNode,
+ LazyNodes, Mutation, Mutations, Properties, RenderReturn, Scope, ScopeId, ScopeState, Scoped,
+ TaskId, Template, TemplateAttribute, TemplateNode, VComponent, VNode, VPlaceholder, VText,
+ VirtualDom,
};
/// The purpose of this module is to alleviate imports of many common types
@@ -81,9 +86,12 @@ pub use crate::innerlude::{
/// This includes types like [`Scope`], [`Element`], and [`Component`].
pub mod prelude {
pub use crate::innerlude::{
- fc_to_builder, AnyValue, Component, Element, Event, EventHandler, Fragment,
- IntoAttributeValue, LazyNodes, Properties, Scope, ScopeId, ScopeState, Scoped, TaskId,
- Template, TemplateAttribute, TemplateNode, Throw, VNode, VirtualDom,
+ consume_context, consume_context_from_scope, current_scope_id, fc_to_builder, has_context,
+ in_runtime, override_runtime, provide_context, provide_context_to_scope,
+ provide_root_context, push_future, remove_future, schedule_update_any, spawn,
+ spawn_forever, suspend, throw, AnyValue, Component, Element, Event, EventHandler, Fragment,
+ IntoAttributeValue, LazyNodes, Properties, Runtime, Scope, ScopeId, ScopeState, Scoped,
+ TaskId, Template, TemplateAttribute, TemplateNode, Throw, VNode, VirtualDom,
};
}
diff --git a/packages/core/src/nodes.rs b/packages/core/src/nodes.rs
index a108f3577..c83b1059a 100644
--- a/packages/core/src/nodes.rs
+++ b/packages/core/src/nodes.rs
@@ -54,7 +54,7 @@ pub struct VNode<'a> {
/// The IDs for the roots of this template - to be used when moving the template around and removing it from
/// the actual Dom
- pub root_ids: RefCell>,
+ pub root_ids: RefCell>,
/// The dynamic parts of the template
pub dynamic_nodes: &'a [DynamicNode<'a>],
@@ -65,11 +65,11 @@ pub struct VNode<'a> {
impl<'a> VNode<'a> {
/// Create a template with no nodes that will be skipped over during diffing
- pub fn empty() -> Element<'a> {
+ pub fn empty(cx: &'a ScopeState) -> Element<'a> {
Some(VNode {
key: None,
parent: None,
- root_ids: Default::default(),
+ root_ids: RefCell::new(bumpalo::collections::Vec::new_in(cx.bump())),
dynamic_nodes: &[],
dynamic_attrs: &[],
template: Cell::new(Template {
@@ -691,14 +691,14 @@ impl<'a> IntoDynNode<'a> for &Element<'a> {
impl<'a, 'b> IntoDynNode<'a> for LazyNodes<'a, 'b> {
fn into_vnode(self, cx: &'a ScopeState) -> DynamicNode<'a> {
- DynamicNode::Fragment(cx.bump().alloc([self.call(cx)]))
+ DynamicNode::Fragment(cx.bump().alloc([cx.render(self).unwrap()]))
}
}
impl<'a, 'b> IntoDynNode<'b> for &'a str {
fn into_vnode(self, cx: &'b ScopeState) -> DynamicNode<'b> {
DynamicNode::Text(VText {
- value: bumpalo::collections::String::from_str_in(self, cx.bump()).into_bump_str(),
+ value: cx.bump().alloc_str(self),
id: Default::default(),
})
}
@@ -741,16 +741,16 @@ impl<'a> IntoTemplate<'a> for VNode<'a> {
}
}
impl<'a> IntoTemplate<'a> for Element<'a> {
- fn into_template(self, _cx: &'a ScopeState) -> VNode<'a> {
+ fn into_template(self, cx: &'a ScopeState) -> VNode<'a> {
match self {
- Some(val) => val.into_template(_cx),
- _ => VNode::empty().unwrap(),
+ Some(val) => val.into_template(cx),
+ _ => VNode::empty(cx).unwrap(),
}
}
}
impl<'a, 'b> IntoTemplate<'a> for LazyNodes<'a, 'b> {
fn into_template(self, cx: &'a ScopeState) -> VNode<'a> {
- self.call(cx)
+ cx.render(self).unwrap()
}
}
diff --git a/packages/core/src/properties.rs b/packages/core/src/properties.rs
index 834b0cabd..3f0d9ef97 100644
--- a/packages/core/src/properties.rs
+++ b/packages/core/src/properties.rs
@@ -73,3 +73,11 @@ impl EmptyBuilder {
pub fn fc_to_builder<'a, T: Properties + 'a>(_: fn(Scope<'a, T>) -> Element<'a>) -> T::Builder {
T::builder()
}
+
+#[cfg(not(miri))]
+#[test]
+fn unsafe_props_fail() {
+ let t = trybuild::TestCases::new();
+ t.compile_fail("compile_tests/props_safety.rs");
+ t.compile_fail("compile_tests/props_safety_temporary_values.rs");
+}
diff --git a/packages/core/src/runtime.rs b/packages/core/src/runtime.rs
new file mode 100644
index 000000000..4b9dcdab0
--- /dev/null
+++ b/packages/core/src/runtime.rs
@@ -0,0 +1,159 @@
+use std::cell::{Cell, Ref, RefCell};
+
+use crate::{innerlude::Scheduler, scope_context::ScopeContext, scopes::ScopeId};
+use std::rc::Rc;
+
+thread_local! {
+ static RUNTIMES: RefCell>> = RefCell::new(vec![]);
+}
+
+/// Run some code within a runtime
+pub fn in_runtime(runtime: Rc, f: impl FnOnce() -> R) -> R {
+ let _guard = RuntimeGuard::new(runtime);
+ f()
+}
+
+/// Override the current runtime. This must be used to override the current runtime when importing components from a dynamic library that has it's own runtime.
+///
+/// ```rust
+/// use dioxus::prelude::*;
+///
+/// fn main() {
+/// let virtual_dom = VirtualDom::new(app);
+/// }
+///
+/// fn app(cx: Scope) -> Element {
+/// render!{ Component { runtime: Runtime::current().unwrap() } }
+/// }
+///
+/// // In a dynamic library
+/// #[derive(Props)]
+/// struct ComponentProps {
+/// runtime: std::rc::Rc,
+/// }
+///
+/// impl PartialEq for ComponentProps {
+/// fn eq(&self, _other: &Self) -> bool {
+/// true
+/// }
+/// }
+///
+/// fn Component(cx: Scope) -> Element {
+/// cx.use_hook(|| override_runtime(cx.props.runtime.clone()));
+///
+/// render! { div {} }
+/// }
+/// ```
+pub fn override_runtime(runtime: Rc) {
+ RUNTIMES.with(|stack| {
+ let mut stack = stack.borrow_mut();
+ stack.pop();
+ stack.push(runtime);
+ });
+}
+
+/// Pushes a new scope onto the stack
+pub(crate) fn push_runtime(runtime: Rc) {
+ RUNTIMES.with(|stack| stack.borrow_mut().push(runtime));
+}
+
+/// Pops a scope off the stack
+pub(crate) fn pop_runtime() {
+ RUNTIMES.with(|stack| stack.borrow_mut().pop());
+}
+
+/// Runs a function with the current runtime
+pub(crate) fn with_runtime(f: F) -> Option
+where
+ F: FnOnce(&Runtime) -> R,
+{
+ RUNTIMES.with(|stack| {
+ let stack = stack.borrow();
+ stack.last().map(|r| f(r))
+ })
+}
+
+/// Runs a function with the current scope
+pub(crate) fn with_current_scope(f: F) -> Option
+where
+ F: FnOnce(&ScopeContext) -> R,
+{
+ with_runtime(|runtime| {
+ runtime
+ .current_scope_id()
+ .and_then(|scope| runtime.get_context(scope).map(|sc| f(&sc)))
+ })
+ .flatten()
+}
+
+/// A global runtime that is shared across all scopes that provides the async runtime and context API
+pub struct Runtime {
+ pub(crate) scope_contexts: RefCell>>,
+ pub(crate) scheduler: Rc,
+
+ // We use this to track the current scope
+ pub(crate) scope_stack: RefCell>,
+ pub(crate) rendering: Cell,
+}
+
+impl Runtime {
+ pub(crate) fn new(scheduler: Rc) -> Rc {
+ Rc::new(Self {
+ scheduler,
+
+ scope_contexts: Default::default(),
+
+ scope_stack: Default::default(),
+
+ rendering: Cell::new(true),
+ })
+ }
+
+ /// Get the current runtime
+ pub fn current() -> Option> {
+ RUNTIMES.with(|stack| stack.borrow().last().cloned())
+ }
+
+ /// Create a scope context. This slab is synchronized with the scope slab.
+ pub(crate) fn create_context_at(&self, id: ScopeId, context: ScopeContext) {
+ let mut contexts = self.scope_contexts.borrow_mut();
+ if contexts.len() <= id.0 {
+ contexts.resize_with(id.0 + 1, Default::default);
+ }
+ contexts[id.0] = Some(context);
+ }
+
+ pub(crate) fn remove_context(&self, id: ScopeId) {
+ self.scope_contexts.borrow_mut()[id.0] = None;
+ }
+
+ /// Get the current scope id
+ pub(crate) fn current_scope_id(&self) -> Option {
+ self.scope_stack.borrow().last().copied()
+ }
+
+ /// Get the context for any scope given its ID
+ ///
+ /// This is useful for inserting or removing contexts from a scope, or rendering out its root node
+ pub(crate) fn get_context(&self, id: ScopeId) -> Option[> {
+ Ref::filter_map(self.scope_contexts.borrow(), |contexts| {
+ contexts.get(id.0).and_then(|f| f.as_ref())
+ })
+ .ok()
+ }
+}
+
+pub(crate) struct RuntimeGuard(Rc]);
+
+impl RuntimeGuard {
+ pub(crate) fn new(runtime: Rc) -> Self {
+ push_runtime(runtime.clone());
+ Self(runtime)
+ }
+}
+
+impl Drop for RuntimeGuard {
+ fn drop(&mut self) {
+ pop_runtime();
+ }
+}
diff --git a/packages/core/src/scheduler/wait.rs b/packages/core/src/scheduler/wait.rs
index b475c6751..625873293 100644
--- a/packages/core/src/scheduler/wait.rs
+++ b/packages/core/src/scheduler/wait.rs
@@ -1,4 +1,4 @@
-use crate::{TaskId, VirtualDom};
+use crate::{runtime::RuntimeGuard, TaskId, VirtualDom};
use std::task::Context;
impl VirtualDom {
@@ -7,7 +7,8 @@ impl VirtualDom {
/// This is precise, meaning we won't poll every task, just tasks that have woken up as notified to use by the
/// queue
pub(crate) fn handle_task_wakeup(&mut self, id: TaskId) {
- let mut tasks = self.scheduler.tasks.borrow_mut();
+ let _runtime = RuntimeGuard::new(self.runtime.clone());
+ let mut tasks = self.runtime.scheduler.tasks.borrow_mut();
let task = match tasks.get(id.0) {
Some(task) => task,
@@ -17,14 +18,22 @@ impl VirtualDom {
let mut cx = Context::from_waker(&task.waker);
+ // update the scope stack
+ self.runtime.scope_stack.borrow_mut().push(task.scope);
+ self.runtime.rendering.set(false);
+
// If the task completes...
if task.task.borrow_mut().as_mut().poll(&mut cx).is_ready() {
// Remove it from the scope so we dont try to double drop it when the scope dropes
- let scope = &self.scopes[task.scope.0];
- scope.spawned_tasks.borrow_mut().remove(&id);
+ let scope = &self.get_scope(task.scope).unwrap();
+ scope.context().spawned_tasks.borrow_mut().remove(&id);
// Remove it from the scheduler
tasks.try_remove(id.0);
}
+
+ // Remove the scope from the stack
+ self.runtime.scope_stack.borrow_mut().pop();
+ self.runtime.rendering.set(true);
}
}
diff --git a/packages/core/src/scope_arena.rs b/packages/core/src/scope_arena.rs
index b298a8996..1ed5b816c 100644
--- a/packages/core/src/scope_arena.rs
+++ b/packages/core/src/scope_arena.rs
@@ -3,6 +3,7 @@ use crate::{
bump_frame::BumpFrame,
innerlude::DirtyScope,
nodes::RenderReturn,
+ scope_context::ScopeContext,
scopes::{ScopeId, ScopeState},
virtual_dom::VirtualDom,
};
@@ -13,48 +14,49 @@ impl VirtualDom {
props: Box>,
name: &'static str,
) -> &ScopeState {
- let parent = self.acquire_current_scope_raw();
+ let parent_id = self.runtime.current_scope_id();
+ let height = parent_id
+ .and_then(|parent_id| self.get_scope(parent_id).map(|f| f.context().height + 1))
+ .unwrap_or(0);
let entry = self.scopes.vacant_entry();
- let height = unsafe { parent.map(|f| (*f).height + 1).unwrap_or(0) };
let id = ScopeId(entry.key());
- entry.insert(Box::new(ScopeState {
- parent,
- id,
- height,
- name,
+ let scope = entry.insert(Box::new(ScopeState {
+ runtime: self.runtime.clone(),
+ context_id: id,
+
props: Some(props),
- tasks: self.scheduler.clone(),
+
node_arena_1: BumpFrame::new(0),
node_arena_2: BumpFrame::new(0),
- spawned_tasks: Default::default(),
- suspended: Default::default(),
+
render_cnt: Default::default(),
hooks: Default::default(),
hook_idx: Default::default(),
- shared_contexts: Default::default(),
+
borrowed_props: Default::default(),
attributes_to_drop: Default::default(),
- }))
- }
+ }));
- fn acquire_current_scope_raw(&self) -> Option<*const ScopeState> {
- let id = self.scope_stack.last().copied()?;
- let scope = self.scopes.get(id.0)?;
- Some(scope.as_ref())
+ let context =
+ ScopeContext::new(name, id, parent_id, height, self.runtime.scheduler.clone());
+ self.runtime.create_context_at(id, context);
+
+ scope
}
pub(crate) fn run_scope(&mut self, scope_id: ScopeId) -> &RenderReturn {
+ self.runtime.scope_stack.borrow_mut().push(scope_id);
// Cycle to the next frame and then reset it
// This breaks any latent references, invalidating every pointer referencing into it.
// Remove all the outdated listeners
self.ensure_drop_safety(scope_id);
let new_nodes = unsafe {
- self.scopes[scope_id.0].previous_frame().bump_mut().reset();
-
let scope = &self.scopes[scope_id.0];
- scope.suspended.set(false);
+ scope.previous_frame().bump_mut().reset();
+
+ scope.context().suspended.set(false);
scope.hook_idx.set(0);
@@ -62,6 +64,7 @@ impl VirtualDom {
let props: &dyn AnyProps = scope.props.as_ref().unwrap().as_ref();
let props: &dyn AnyProps = std::mem::transmute(props);
+ let _span = tracing::trace_span!("render", scope = %scope.context().name);
props.render(scope).extend_lifetime()
};
@@ -77,21 +80,26 @@ impl VirtualDom {
// And move the render generation forward by one
scope.render_cnt.set(scope.render_cnt.get() + 1);
+ let context = scope.context();
// remove this scope from dirty scopes
self.dirty_scopes.remove(&DirtyScope {
- height: scope.height,
- id: scope.id,
+ height: context.height,
+ id: context.id,
});
- if scope.suspended.get() {
+ if context.suspended.get() {
if matches!(allocated, RenderReturn::Aborted(_)) {
- self.suspended_scopes.insert(scope.id);
+ self.suspended_scopes.insert(context.id);
}
} else if !self.suspended_scopes.is_empty() {
- _ = self.suspended_scopes.remove(&scope.id);
+ _ = self.suspended_scopes.remove(&context.id);
}
// rebind the lifetime now that its stored internally
- unsafe { allocated.extend_lifetime_ref() }
+ let result = unsafe { allocated.extend_lifetime_ref() };
+
+ self.runtime.scope_stack.borrow_mut().pop();
+
+ result
}
}
diff --git a/packages/core/src/scope_context.rs b/packages/core/src/scope_context.rs
new file mode 100644
index 000000000..79ed05d75
--- /dev/null
+++ b/packages/core/src/scope_context.rs
@@ -0,0 +1,362 @@
+use crate::{
+ innerlude::{ErrorBoundary, Scheduler, SchedulerMsg},
+ runtime::{with_current_scope, with_runtime},
+ Element, ScopeId, TaskId,
+};
+use rustc_hash::FxHashSet;
+use std::{
+ any::Any,
+ cell::{Cell, RefCell},
+ fmt::Debug,
+ future::Future,
+ rc::Rc,
+ sync::Arc,
+};
+
+/// A component's state separate from its props.
+///
+/// This struct exists to provide a common interface for all scopes without relying on generics.
+pub(crate) struct ScopeContext {
+ pub(crate) name: &'static str,
+
+ pub(crate) id: ScopeId,
+ pub(crate) parent_id: Option,
+
+ pub(crate) height: u32,
+ pub(crate) suspended: Cell,
+
+ pub(crate) shared_contexts: RefCell>>,
+
+ pub(crate) tasks: Rc