Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli): update subcommand comments #1303

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/cli/docs/src/cmd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Commands:
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
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/cli/autoformat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use super::*;
// For reference, the rustfmt main.rs file
// https://github.com/rust-lang/rustfmt/blob/master/src/bin/main.rs

/// Build the Rust WASM app and all of its assets.
/// Format some rsx
#[derive(Clone, Debug, Parser)]
pub struct Autoformat {
/// Run in 'check' mode. Exits with 0 if input is formatted correctly. Exits
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/cli/bundle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use tauri_bundler::{BundleSettings, PackageSettings, SettingsBuilder};
use super::*;
use crate::{build_desktop, cfg::ConfigOptsBundle};

/// Build the Rust WASM app and all of its assets.
/// Bundle the Rust desktop app and all of its assets
#[derive(Clone, Debug, Parser)]
#[clap(name = "bundle")]
pub struct Bundle {
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/cli/config.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use super::*;

/// Build the Rust WASM app and all of its assets.
/// Dioxus config file controls
#[derive(Clone, Debug, Deserialize, Subcommand)]
#[clap(name = "config")]
pub enum Config {
Expand Down
1 change: 1 addition & 0 deletions packages/cli/src/cli/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ pub enum Commands {
#[clap(name = "fmt")]
Autoformat(autoformat::Autoformat),

/// Check the Rust files in the project for issues.
#[clap(name = "check")]
Check(check::Check),

Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/cli/plugin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

use super::*;

/// Build the Rust WASM app and all of its assets.
/// Manage plugins for dioxus cli
#[derive(Clone, Debug, Deserialize, Subcommand)]
#[clap(name = "plugin")]
pub enum Plugin {
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/cli/translate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use dioxus_rsx::{BodyNode, CallBody};

use super::*;

/// Build the Rust WASM app and all of its assets.
/// Translate some source file into Dioxus code
#[derive(Clone, Debug, Parser)]
#[clap(name = "translate")]
pub struct Translate {
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/cli/version.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use super::*;

/// Build the Rust WASM app and all of its assets.
/// Print the version of this extension
#[derive(Clone, Debug, Parser)]
#[clap(name = "version")]
pub struct Version {}
Expand Down
Loading