Plugin System

Cargo.toml

@@ -72,6 +72,7 @@ mlua = { version = "0.8.1", features = [
     "async",
     "send",
     "macros",
+    "serialize",
 ] }
 ctrlc = "3.2.3"
 # dioxus-rsx = "0.0.1"

docs/src/SUMMARY.md

@@ -8,11 +8,14 @@
   - [Build](./cmd/build.md)
   - [Serve](./cmd/serve.md)
   - [Clean](./cmd/clean.md)
+  - [Plugin](./cmd/plugin.md)
   - [Translate](./cmd/translate.md)
+  - [Format](./cmd/fmt.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)
+  - [API.Path](./plugin/interface/path.md)
+  - [API.FileSystem](./plugin/interface/fs.md)

docs/src/cmd/build.md

@@ -44,4 +44,13 @@ You can use `--example {name}` to build a example code.
 ```
 # build `example/test` code
 dioxus build --exmaple test
-```
+```
+
+## Enable Features 
+
+You can use `--features {features}` to enable different features.
+
+```sh
+dioxus build --feautres desktop
+```
+

docs/src/cmd/fmt.md

@@ -0,0 +1,15 @@
+# Fmt
+
+`dioxus fmt` can help you format your `rsx` code.
+
+```
+USAGE:
+    dioxus fmt [OPTIONS]
+
+OPTIONS:
+    -c, --check          Run in 'check' mode. 
+    -f, --file <FILE>    Input file
+    -h, --help           Print help information
+    -r, --raw <RAW>      Input rsx (selection)
+```
+

docs/src/cmd/plugin.md

@@ -0,0 +1,33 @@
+# Plugin
+
+`dioxus plugin` can help developer manage & develop their own cli plugin.
+
+### Init plugin system
+
+This command will download a plugin core library in your project, and enable plugin system.
+
+```shell
+dioxus plugin init
+```
+
+
+
+### Install & add new plugin
+
+This command can help you install a new plugin from git.
+
+> currently it just support install from git repository.
+
+```shell
+dioxus plugin add --git {GIT_URL}
+```
+
+
+
+### Upgrade core library
+
+Beacause of the core library must be sync with cli version, so you need use upgrade core library after updated cli version.
+
+```shell
+dioxus plugin upgrade
+```

docs/src/configure.md

@@ -25,29 +25,7 @@ We use `toml` to define some info for `dioxus` project.
    asset_dir = "public"
    ```
 
-### Application.Tools
-
-You can combine different tools with `dioxus`.
-
-1. ***binaryen*** - Use the `binaryen` tooling suite.
-   ```
-   # current support: wasm-opt
-   # default: web
-   binaryen = { wasm_opt = true }
-   ```
-   Use the `wasm_opt = true` key/pair value to activate optimization with wasm-opt.
-   When building on `release` profile, Dioxus will run `wasm_opt` with `-Oz` option.
-2. ***tailwindcss*** - Use the `tailwindcss` standalone binary to generate a Tailwind CSS bundle file.
-   ```
-   tailwindcss = { input = "main.css", config = "tailwind.config.js" }
-   ```
-   You can set two optional keys :
-    - input: path of the input CSS file (default value is "public/tailwind.css")
-    - config: path to the config file for Tailwind (default value is "src/tailwind.config.js")
-
-    When building on `release` profile, Dioxus will run `tailwindcss` with the `--minify` option.
-
-    Note : Dioxus will automatically include the generated tailwind file in the `index.html`
+5. **sub_package** - build & work on a sub-package.
 
 ### Web.App
 
@@ -59,6 +37,13 @@ Web platform application config:
    title = "dioxus app | ⛺"
    ```
 
+ 2. **base_path** - custom web service root path.
+
+    ```
+    base = "my-site"
+    # url will be: http://localhost:8080/my-site
+    ```
+
 ### Web.Watcher
 
 Web platform `dev-server` watcher config:

docs/src/introduction.md

@@ -2,7 +2,7 @@
 
 📦✨ **Dioxus-Cli** is a tool to help get dioxus projects off the ground.
 
-![dioxus-logo](https://dioxuslabs.com/guide/images/dioxuslogo_full.png)
+![dioxus-logo](https://github.com/DioxusLabs/dioxus/raw/master/notes/header.svg)
 
 It includes `dev server`, `hot reload` and some `quick command` to help you use dioxus.
 

docs/src/plugin/README.md

@@ -15,7 +15,8 @@ The plugin library have pre-define some important event you can control:
 - `build.on_start`
 - `build.on_finished`
 - `serve.on_start`
-- `serve.on_rebuild`
+- `serve.on_rebuild_start`
+- `serve.on_rebuild_end`
 - `serve.on_shutdown`
 
 ### Plugin Template
@@ -63,7 +64,13 @@ manager.serve.on_start = function (info)
 end
 
 ---@param info ServeRebuildInfo
-manager.serve.on_rebuild = function (info)
+manager.serve.on_rebuild_start = function (info)
+    -- this function will execute before the CLI rebuilds
+    log.info("[plugin] Before rebuild: " .. info.name)
+end
+
+---@param info ServeRebuildInfo
+manager.serve.on_rebuild_end = function (info)
     -- this function will after clean & print to run, so you can print some thing.
     local files = plugin.tool.dump(info.changed_files)
     log.info("[plugin] Serve rebuild: '" .. files .. "'")
@@ -73,7 +80,5 @@ manager.serve.on_shutdown = function ()
     log.info("[plugin] Serve shutdown")
 end
 
-manager.serve.interval = 1000
-
 return manager
 ```

docs/src/plugin/interface/dirs.md

@@ -3,33 +3,11 @@
 > you can use Dirs functions to get some directory path
 
 
-### plugin_dir() -> string
+### crate_dir() -> string
 
-You can get current plugin **root** directory path
+You can get current crate **root** directory path
 
 ```lua
-local path = plugin.dirs.plugin_dir()
--- example: ~/Development/DioxusCli/plugin/test-plugin/
+local path = plugin.dirs.crate_dir()
+-- path = "~/MyProject/dioxus-starter/"
 ```
-
-### 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.
-
-```lua
-local path = plugin.dirs.bin_dir()
--- example: ~/Development/DioxusCli/plugin/test-plugin/bin/
-```
-
-### temp_dir() -> string
-
-You can get plugin **temp** direcotry path
-
-Just put some temporary file in this directory.
-
-```lua
-local path = plugin.dirs.bin_dir()
--- example: ~/Development/DioxusCli/plugin/test-plugin/temp/
-```

docs/src/plugin/interface/fs.md

@@ -0,0 +1,116 @@
+# FileSystem Functions
+
+> you can use FileSystem functions to handle file.
+
+### create_dir(path: string, recursive: boolean): boolean
+
+This function can help you create a directory, if `recursive` is `true`, API will auto-create missing directory.
+
+```lua
+local path = "~/MyProject/temp/hello"
+
+-- before
+-- - MyProject
+
+plugin.fs.create_dir(path, true)
+-- after (recursive)
+-- - MyProject
+-- - - temp
+-- - - - hello
+```
+
+### remove_dir(path: string): boolean
+
+This function will remove a single directory.
+
+```lua
+local path = "~/MyProject/temp/hello"
+
+-- before
+-- - MyProject
+-- - - temp
+-- - - - hello
+
+plugin.fs.create_dir(path, true)
+-- after
+-- - MyProject
+-- - - temp
+```
+
+### file_get_content(path: string): string
+
+This function can read a file's content.
+
+```lua
+local path = "~/MyProject/hello.txt"
+local content = plugin.fs.file_get_content(path)
+-- content = "hello world"
+```
+
+### file_set_content(path:  string, content: string): boolean
+
+This function can write file's content.
+
+```lua
+local path = "~/MyProject/hello.txt"
+-- before: "Hello World"
+plugin.fs.file_set_content(path, "Hello Dioxus")
+-- after: "Hello Dioxus"
+```
+
+### remove_file(path: string): boolean
+
+This function can remove a file from path.
+
+```lua
+local file = "~/MyProject/hello.txt"
+plugin.fs.remove_file(file)
+```
+
+### move_file(path: string, target: string): boolean
+
+This function can move a file from a path to another path.
+
+```lua
+local file = "~/MyProject/hello.txt"
+plugin.fs.move_file(file, "~/MyProject/temp/hello.txt")
+```
+
+### copy_file(path: string, target: string): boolean
+
+This function can move a file from a path to another path.
+
+> The different and `move_file` is `copy_file` will keep origin file.
+
+```lua
+local file = "~/MyProject/hello.txt"
+plugin.fs.copy_file(file, "~/MyProject/temp/hello.txt")
+```
+
+### unzip_file(path: string, target: string): boolean
+
+This function can let you **unzip** a `.zip` file.
+
+```lua
+local file = "~/MyProject/package.zip"
+plugin.fs.unzip(file, "~/MyProject/unpackaged")
+```
+
+### untar_gz_file(path: string, target: string): boolean
+
+This function can let you **unpackage** a `.tar.gz` file.
+
+```lua
+local file = "~/MyProject/package.tar.gz"
+plugin.fs.untar_gz_file(file, "~/MyProject/unpackaged")
+```
+
+### read_dir(path: string): string []
+
+This function can read a directory and get a list.
+
+```lua
+local path = "~/MyProject/"
+local list = plugin.fs.read_dir(path)
+-- list = ["temp", "package.zip", "package.tar.gz"]
+```