Merge pull request #9 from oovm/master

Replace StructOpt with Clap

.gitignore

@@ -1,2 +1,3 @@
 /target
 Cargo.lock
+.idea/

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dioxus-cli"
-version = "0.1.2"
+version = "0.1.3"
 authors = ["Jonathan Kelley"]
 edition = "2018"
 description = "CLI tool for developing, testing, and publishing Dioxus apps"
@@ -9,31 +9,34 @@ license = "MIT/Apache-2.0"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-thiserror = "1.0.23"
+# cli core
-log = "0.4.13"
+clap = {version = "3.0.14", features = ["derive"]}
-fern = { version = "0.6.0", features = ["colored"] }
+thiserror = "1.0.30"
 wasm-bindgen-cli-support = "0.2.79"
-anyhow = "1.0.38"
+# features
-serde = { version = "1.0.133", features = ["derive"] }
+log = "0.4.14"
-serde_json = "1"
+fern = { version = "0.6.0", features = ["colored"] }
+serde = { version = "1.0.136", features = ["derive"] }
+serde_json = "1.0.79"
 toml = "0.5.8"
 fs_extra = "1.2.0"
-cargo_toml = "0.10.0"
+cargo_toml = "0.11.4"
-futures = "0.3.12"
+futures = "0.3.21"
 notify = { version = "5.0.0-pre.13", features = ["serde"] }
 html_parser = "0.6.2"
 binary-install = "0.0.2"
 convert_case = "0.5.0"
-structopt = "0.3.25"
 cargo_metadata = "0.14.1"
-tokio = { version = "1.15.0", features = ["full"] }
+tokio = { version = "1.16.1", features = ["full"] }
 atty = "0.2.14"
 regex = "1.5.4"
 chrono = "0.4.19"
+anyhow = "1.0.53"
+hyper = "0.14.17"
 
-axum = { version = "0.4.4", features = ["ws", "headers"] }
+axum = { version = "0.4.5", features = ["ws", "headers"] }
-tower-http = { version = "0.2.0", features = ["fs", "trace"] }
+tower-http = { version = "0.2.2", features = ["fs", "trace"] }
-headers = "0.3"
+headers = "0.3.7"
 # hyper = { version = "0.14.11", features = ["full"] }
 
 [[bin]]

README.md

@@ -15,8 +15,13 @@ dioxus-cli (inspired by wasm-pack and webpack) is a tool to help get dioxus proj
 
 ## Installation
 
-```
+```shell
+# for stable
 $ cargo install dioxus-cli
+# for latest
+$ cargo install --git https://github.com/DioxusLabs/cli
+# for developing
+$ cargo install --path . --debug
 ```
 
 Now, `dioxus` is in your path.

rustfmt.toml

@@ -0,0 +1,8 @@
+version = "Two"
+edition = "2018"
+
+imports_granularity = "Crate"
+#use_small_heuristics = "Max"
+#control_brace_style = "ClosingNextLine"
+normalize_comments = true
+format_code_in_doc_comments = true

src/builder.rs

@@ -11,13 +11,11 @@ use std::{
 use wasm_bindgen_cli_support::Bindgen;
 
 pub fn build(config: &CrateConfig) -> Result<()> {
-    /*
+    // [1] Build the project with cargo, generating a wasm32-unknown-unknown target (is there a more specific, better target to leverage?)
-    [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
-    [2] Generate the appropriate build folders
+    // [3] Wasm-bindgen the .wasm fiile, and move it into the {builddir}/modules/xxxx/xxxx_bg.wasm
-    [3] Wasm-bindgen the .wasm fiile, and move it into the {builddir}/modules/xxxx/xxxx_bg.wasm
+    // [4] Wasm-opt the .wasm file with whatever optimizations need to be done
-    [4] Wasm-opt the .wasm file with whatever optimizations need to be done
+    // [5] Link up the html page to the wasm module
-    [5] Link up the html page to the wasm module
-    */
 
     let CrateConfig {
         out_dir,

src/cli/build/mod.rs

@@ -1,21 +1,18 @@
-use std::{io::Write, path::PathBuf};
+use super::*;
-
-use crate::{cfg::ConfigOptsBuild, gen_page};
-use structopt::StructOpt;
 
 /// Build the Rust WASM app and all of its assets.
-#[derive(Clone, Debug, StructOpt)]
+#[derive(Clone, Debug, Parser)]
-#[structopt(name = "build")]
+#[clap(name = "build")]
 pub struct Build {
-    #[structopt(flatten)]
+    #[clap(flatten)]
     pub build: ConfigOptsBuild,
 }
 
 impl Build {
-    pub fn build(self) -> anyhow::Result<()> {
+    pub fn build(self) -> Result<()> {
         let mut crate_config = crate::CrateConfig::new()?;
 
-        // change the relase state.
+        // change the release state.
         crate_config.with_release(self.build.release);
 
         if self.build.example.is_some() {
@@ -30,7 +27,7 @@ impl Build {
                 crate::builder::build_desktop(&crate_config)?;
             }
             _ => {
-                return Err(anyhow::anyhow!("Unsoppurt platform target."));
+                return custom_error!("Unsoppurt platform target.");
             }
         }
 

src/cli/cfg.rs

@@ -1,46 +1,43 @@
-use std::path::PathBuf;
+use super::*;
-use structopt::StructOpt;
-
-use serde::Deserialize;
 
 /// Config options for the build system.
-#[derive(Clone, Debug, Default, Deserialize, StructOpt)]
+#[derive(Clone, Debug, Default, Deserialize, Parser)]
 pub struct ConfigOptsBuild {
     /// The index HTML file to drive the bundling process [default: index.html]
-    #[structopt(parse(from_os_str))]
+    #[clap(parse(from_os_str))]
     pub target: Option<PathBuf>,
 
     /// Build in release mode [default: false]
-    #[structopt(long)]
+    #[clap(long)]
     #[serde(default)]
     pub release: bool,
 
     /// Build a example [default: ""]
-    #[structopt(long)]
+    #[clap(long)]
     pub example: Option<String>,
 
     /// Build platform: support Web & Desktop [default: "web"]
-    #[structopt(long, default_value = "web")]
+    #[clap(long, default_value = "web")]
     pub platform: String,
 }
 
-#[derive(Clone, Debug, Default, Deserialize, StructOpt)]
+#[derive(Clone, Debug, Default, Deserialize, Parser)]
 pub struct ConfigOptsServe {
     /// The index HTML file to drive the bundling process [default: index.html]
-    #[structopt(parse(from_os_str))]
+    #[clap(parse(from_os_str))]
     pub target: Option<PathBuf>,
 
     /// Build a example [default: ""]
-    #[structopt(long)]
+    #[clap(long)]
     pub example: Option<String>,
 
     /// Build in release mode [default: false]
-    #[structopt(long)]
+    #[clap(long)]
     #[serde(default)]
     pub release: bool,
 
     /// Build platform: support Web & Desktop [default: "web"]
-    #[structopt(long, default_value = "web")]
+    #[clap(long, default_value = "web")]
     pub platform: String,
 }
 

src/cli/clean/mod.rs

@@ -1,18 +1,12 @@
-use std::{
+use super::*;
-    fs::remove_dir_all,
-    path::PathBuf,
-    process::{Command, Stdio},
-};
-
-use structopt::StructOpt;
 
 /// Build the Rust WASM app and all of its assets.
-#[derive(Clone, Debug, StructOpt)]
+#[derive(Clone, Debug, Parser)]
-#[structopt(name = "clean")]
+#[clap(name = "clean")]
 pub struct Clean {}
 
 impl Clean {
-    pub fn clean(self) -> anyhow::Result<()> {
+    pub fn clean(self) -> Result<()> {
         let crate_config = crate::CrateConfig::new()?;
 
         let output = Command::new("cargo")

src/cli/config/mod.rs

@@ -1,11 +1,8 @@
-use std::{fs::File, io::Write};
+use super::*;
-
-use serde::Deserialize;
-use structopt::StructOpt;
 
 /// Build the Rust WASM app and all of its assets.
-#[derive(Clone, Debug, Deserialize, StructOpt)]
+#[derive(Clone, Debug, Deserialize, Subcommand)]
-#[structopt(name = "config")]
+#[clap(name = "config")]
 pub enum Config {
     /// Init `Dioxus.toml` for project/folder.
     Init {
@@ -13,14 +10,14 @@ pub enum Config {
         name: String,
 
         /// Cover old config
-        #[structopt(long)]
+        #[clap(long)]
         #[serde(default)]
         force: bool,
     },
 }
 
 impl Config {
-    pub fn config(self) -> anyhow::Result<()> {
+    pub fn config(self) -> Result<()> {
         let crate_root = crate::cargo::crate_root()?;
         match self {
             Config::Init { name, force } => {

src/cli/create/mod.rs

@@ -1,26 +1,16 @@
-use std::{
+use super::*;
-    fs::File,
+use crate::custom_error;
-    io::{Read, Write},
-    path::PathBuf,
-    process::{Command, Stdio},
-};
-
-use regex::Regex;
-use serde::Deserialize;
-use structopt::StructOpt;
-
-use crate::{error::Result, Error};
 
 /// Build the Rust WASM app and all of its assets.
-#[derive(Clone, Debug, Default, Deserialize, StructOpt)]
+#[derive(Clone, Debug, Default, Deserialize, Parser)]
-#[structopt(name = "create")]
+#[clap(name = "create")]
 pub struct Create {
     /// Init project name
-    #[structopt(default_value = ".")]
+    #[clap(default_value = ".")]
     name: String,
 
     /// Template path
-    #[structopt(default_value = "gh:dioxuslabs/dioxus-template", long)]
+    #[clap(default_value = "gh:dioxuslabs/dioxus-template", long)]
     template: String,
 }
 
@@ -34,10 +24,7 @@ impl Create {
         let project_path = PathBuf::from(&self.name);
 
         if project_path.join("Dioxus.toml").is_file() || project_path.join("Cargo.toml").is_file() {
-            return Err(Error::Other(anyhow::anyhow!(
+            return custom_error!("🧨 Folder '{}' is initialized.", &self.name);
-                "🧨 Folder '{}' is initialized.",
-                &self.name
-            )));
         }
 
         log::info!("🔧 Start to create a new project '{}'.", self.name);
@@ -58,9 +45,7 @@ impl Create {
                 .stderr(Stdio::inherit())
                 .output()?;
             if !install_output.status.success() {
-                return Err(Error::Other(anyhow::anyhow!(
+                return custom_error!("Try to install cargo-generate failed.");
-                    "Try to install cargo-generate failed."
-                )));
             }
         }
 
@@ -74,7 +59,7 @@ impl Create {
             .output()?;
 
         if !generate_output.status.success() {
-            return Err(Error::Other(anyhow::anyhow!("Generate project failed.")));
+            return custom_error!("Generate project failed.");
         }
 
         let mut dioxus_file = File::open(project_path.join("Dioxus.toml"))?;

src/cli/mod.rs

@@ -1,5 +1,3 @@
-use structopt::StructOpt;
-
 pub mod build;
 pub mod cfg;
 pub mod clean;
@@ -8,26 +6,41 @@ pub mod create;
 pub mod serve;
 pub mod translate;
 
+use crate::{
+    cfg::{ConfigOptsBuild, ConfigOptsServe},
+    custom_error,
+    error::Result,
+    gen_page, server, CrateConfig, Error,
+};
+use clap::{Parser, Subcommand};
+use html_parser::{Dom, Element, Node};
+use regex::Regex;
+use serde::Deserialize;
+use std::{
+    fmt::{Display, Formatter},
+    fs::{remove_dir_all, File},
+    io::{Read, Write},
+    path::PathBuf,
+    process::{exit, Command, Stdio},
+};
+
 /// Build, bundle, & ship your Dioxus app.
-///
+#[derive(Parser)]
-///
+#[clap(name = "dioxus")]
-#[derive(StructOpt)]
-#[structopt(name = "dioxus")]
 pub struct Cli {
-    #[structopt(subcommand)]
+    #[clap(subcommand)]
     pub action: Commands,
 
     /// Enable verbose logging.
-    #[structopt(short)]
+    #[clap(short)]
     pub v: bool,
-    //
     // // note: dioxus is still roughly compatible with trunk
     // /// Path to the Trunk config file [default: Trunk.toml]
-    // #[structopt(long, parse(from_os_str), env = "TRUNK_CONFIG")]
+    // #[clap(long, parse(from_os_str), env = "TRUNK_CONFIG")]
     // pub config: Option<PathBuf>,
 }
 
-#[derive(StructOpt)]
+#[derive(Parser)]
 pub enum Commands {
     /// Build the Rust WASM app and all of its assets.
     Build(build::Build),
@@ -40,5 +53,6 @@ pub enum Commands {
     /// Clean output artifacts.
     Clean(clean::Clean),
     /// Dioxus config file controls.
+    #[clap(subcommand)]
     Config(config::Config),
 }

src/cli/serve/mod.rs

@@ -1,17 +1,15 @@
-use crate::{cfg::ConfigOptsServe, gen_page, server, CrateConfig};
+use super::*;
-use std::{io::Write, path::PathBuf, process::{Command, Stdio}};
-use structopt::StructOpt;
 
 /// Run the WASM project on dev-server
-#[derive(Clone, Debug, StructOpt)]
+#[derive(Clone, Debug, Parser)]
-#[structopt(name = "serve")]
+#[clap(name = "serve")]
 pub struct Serve {
-    #[structopt(flatten)]
+    #[clap(flatten)]
     pub serve: ConfigOptsServe,
 }
 
 impl Serve {
-    pub async fn serve(self) -> anyhow::Result<()> {
+    pub async fn serve(self) -> Result<()> {
         let mut crate_config = crate::CrateConfig::new()?;
 
         // change the relase state.
@@ -51,7 +49,7 @@ impl Serve {
                 return Ok(());
             }
             _ => {
-                return Err(anyhow::anyhow!("Unsoppurt platform target."));
+                return custom_error!("Unsoppurt platform target.");
             }
         }
 
@@ -64,7 +62,7 @@ impl Serve {
         Ok(())
     }
 
-    pub fn regen_dev_page(crate_config: &CrateConfig) -> anyhow::Result<()> {
+    pub fn regen_dev_page(crate_config: &CrateConfig) -> Result<()> {
         let serve_html = gen_page(&crate_config.dioxus_config, true);
 
         let mut file = std::fs::File::create(

src/cli/translate/mod.rs

@@ -1,34 +1,25 @@
-use anyhow::Result;
+use super::*;
-use html_parser::Dom;
-use html_parser::Element;
-use html_parser::Node;
-#[allow(unused_imports)]
-use std::fmt::{Display, Formatter};
-use std::io::Read;
-use std::path::PathBuf;
-use std::process::exit;
-use structopt::StructOpt;
 
 /// Build the Rust WASM app and all of its assets.
-#[derive(Clone, Debug, StructOpt)]
+#[derive(Clone, Debug, Parser)]
-#[structopt(name = "translate")]
+#[clap(name = "translate")]
 pub struct Translate {
     /// Activate debug mode
     // short and long flags (-d, --debug) will be deduced from the field's name
-    #[structopt(short, long)]
+    #[clap(short, long)]
     pub component: bool,
 
     /// Input file
-    #[structopt(short, long)]
+    #[clap(short, long)]
     pub file: Option<String>,
 
     /// Output file, stdout if not present
-    #[structopt(parse(from_os_str))]
+    #[clap(parse(from_os_str))]
     pub output: Option<PathBuf>,
 }
 
 impl Translate {
-    pub fn translate(self) -> anyhow::Result<()> {
+    pub fn translate(self) -> Result<()> {
         let Translate {
             component,
             output,

src/error.rs

@@ -11,6 +11,15 @@ pub enum Error {
     #[error("I/O Error: {0}")]
     IO(#[from] std::io::Error),
 
+    #[error("Format Error: {0}")]
+    FormatError(#[from] std::fmt::Error),
+
+    #[error("Format failed: {0}")]
+    ParseError(String),
+
+    #[error("Runtime Error: {0}")]
+    RuntimeError(String),
+
     #[error("Failed to write error")]
     FailedToWrite,
 
@@ -20,6 +29,9 @@ pub enum Error {
     #[error("Failed to write error")]
     CargoError(String),
 
+    #[error("{0}")]
+    CustomError(String),
+
     #[error(transparent)]
     Other(#[from] anyhow::Error),
 }
@@ -35,3 +47,28 @@ impl From<String> for Error {
         Error::Unique(s)
     }
 }
+
+impl From<html_parser::Error> for Error {
+    fn from(e: html_parser::Error) -> Self {
+        Self::ParseError(e.to_string())
+    }
+}
+
+impl From<hyper::Error> for Error {
+    fn from(e: hyper::Error) -> Self {
+        Self::RuntimeError(e.to_string())
+    }
+}
+
+#[macro_export]
+macro_rules! custom_error {
+    ($msg:literal $(,)?) => {
+        Err(Error::CustomError($msg.to_string()))
+    };
+    ($err:expr $(,)?) => {
+        Err(Error::from($err))
+    };
+    ($fmt:expr, $($arg:tt)*) => {
+        Err(Error::CustomError(format!($fmt, $($arg)*)))
+    };
+}

src/main.rs

@@ -1,9 +1,9 @@
+use clap::Parser;
 use dioxus_cli::*;
-use structopt::StructOpt;
 
 #[tokio::main]
 async fn main() -> Result<()> {
-    let args = Cli::from_args();
+    let args = Cli::parse();
     set_up_logging();
 
     match args.action {

src/server/mod.rs

@@ -10,14 +10,14 @@ use notify::{RecommendedWatcher, Watcher};
 use std::{path::PathBuf, sync::Arc};
 use tower_http::services::ServeDir;
 
-use crate::{builder, serve::Serve, CrateConfig};
+use crate::{builder, serve::Serve, CrateConfig, Result};
 use tokio::sync::broadcast;
 
 struct WsRelodState {
     update: broadcast::Sender<String>,
 }
 
-pub async fn startup(config: CrateConfig) -> anyhow::Result<()> {
+pub async fn startup(config: CrateConfig) -> Result<()> {
     log::info!("🚀 Starting development server...");
 
     let dist_path = config.out_dir.clone();

tests/main.rs

@@ -0,0 +1,4 @@
+#[test]
+fn ready() {
+    println!("Compiled successfully!")
+}