From bde83a20ffabfa4262e8b0ae8d8cf7bfa4b61042 Mon Sep 17 00:00:00 2001 From: Miles Murgaw Date: Fri, 5 Apr 2024 09:15:55 -0400 Subject: [PATCH] SDK Rename (#31) * revision: readme * revision: readme warning * revision: note readme * revision: update date * revision: notice * revision: rename to sdk * revision: description * revision: geolocation example readme * revision: title --- .github/workflows/rust.yml | 4 ++-- .github/workflows/testing.yml | 6 ++--- Cargo.toml | 19 ++++++++-------- README.md | 22 +++++++++---------- examples/channel/Cargo.toml | 5 +++-- examples/channel/src/main.rs | 2 +- examples/clipboard/Cargo.toml | 4 ++-- examples/clipboard/src/main.rs | 2 +- examples/color_scheme/Cargo.toml | 2 +- examples/color_scheme/src/main.rs | 2 +- examples/geolocation/Cargo.toml | 3 ++- examples/geolocation/README.md | 2 +- examples/geolocation/src/main.rs | 2 +- examples/i18n/Cargo.toml | 2 +- examples/i18n/src/main.rs | 4 ++-- examples/storage/Cargo.toml | 2 +- examples/storage/src/main.rs | 4 ++-- {std => sdk}/Cargo.toml | 4 ++-- {std => sdk}/src/clipboard/mod.rs | 0 {std => sdk}/src/clipboard/use_clipboard.rs | 2 +- {std => sdk}/src/color_scheme/mod.rs | 0 .../use_preferred_color_scheme.rs | 0 {std => sdk}/src/geolocation/core.rs | 0 {std => sdk}/src/geolocation/mod.rs | 0 {std => sdk}/src/geolocation/platform/mod.rs | 0 {std => sdk}/src/geolocation/platform/wasm.rs | 0 .../src/geolocation/platform/windows.rs | 0 .../src/geolocation/use_geolocation.rs | 0 {std => sdk}/src/i18n/mod.rs | 0 {std => sdk}/src/i18n/tanslate.rs | 0 {std => sdk}/src/i18n/use_i18n.rs | 0 {std => sdk}/src/i18n/use_init_i18n.rs | 0 {std => sdk}/src/lib.rs | 0 {std => sdk}/src/notification/mod.rs | 0 {std => sdk}/src/notification/notification.rs | 2 +- {std => sdk}/src/storage/client_storage/fs.rs | 0 .../src/storage/client_storage/memory.rs | 0 .../src/storage/client_storage/mod.rs | 4 ++-- .../src/storage/client_storage/web.rs | 0 {std => sdk}/src/storage/mod.rs | 6 ++--- {std => sdk}/src/storage/persistence.rs | 0 {std => sdk}/src/utils/channel/mod.rs | 0 {std => sdk}/src/utils/channel/use_channel.rs | 0 .../src/utils/channel/use_listen_channel.rs | 0 {std => sdk}/src/utils/mod.rs | 0 45 files changed, 53 insertions(+), 52 deletions(-) rename {std => sdk}/Cargo.toml (97%) rename {std => sdk}/src/clipboard/mod.rs (100%) rename {std => sdk}/src/clipboard/use_clipboard.rs (97%) rename {std => sdk}/src/color_scheme/mod.rs (100%) rename {std => sdk}/src/color_scheme/use_preferred_color_scheme.rs (100%) rename {std => sdk}/src/geolocation/core.rs (100%) rename {std => sdk}/src/geolocation/mod.rs (100%) rename {std => sdk}/src/geolocation/platform/mod.rs (100%) rename {std => sdk}/src/geolocation/platform/wasm.rs (100%) rename {std => sdk}/src/geolocation/platform/windows.rs (100%) rename {std => sdk}/src/geolocation/use_geolocation.rs (100%) rename {std => sdk}/src/i18n/mod.rs (100%) rename {std => sdk}/src/i18n/tanslate.rs (100%) rename {std => sdk}/src/i18n/use_i18n.rs (100%) rename {std => sdk}/src/i18n/use_init_i18n.rs (100%) rename {std => sdk}/src/lib.rs (100%) rename {std => sdk}/src/notification/mod.rs (100%) rename {std => sdk}/src/notification/notification.rs (98%) rename {std => sdk}/src/storage/client_storage/fs.rs (100%) rename {std => sdk}/src/storage/client_storage/memory.rs (100%) rename {std => sdk}/src/storage/client_storage/mod.rs (94%) rename {std => sdk}/src/storage/client_storage/web.rs (100%) rename {std => sdk}/src/storage/mod.rs (99%) rename {std => sdk}/src/storage/persistence.rs (100%) rename {std => sdk}/src/utils/channel/mod.rs (100%) rename {std => sdk}/src/utils/channel/use_channel.rs (100%) rename {std => sdk}/src/utils/channel/use_listen_channel.rs (100%) rename {std => sdk}/src/utils/mod.rs (100%) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index e0510fe..fffc8ba 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -32,5 +32,5 @@ jobs: - run: rustup target add wasm32-unknown-unknown - run: rustup component add clippy - uses: actions/checkout@v3 - - run: cargo clippy --package dioxus-std --target wasm32-unknown-unknown --tests --features wasm-testing -- -D warnings - - run: cargo clippy --package dioxus-std --tests --features desktop-testing -- -D warnings + - run: cargo clippy --package dioxus-sdk --target wasm32-unknown-unknown --tests --features wasm-testing -- -D warnings + - run: cargo clippy --package dioxus-sdk --tests --features desktop-testing -- -D warnings diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index cdc9e5e..76913ec 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -19,7 +19,7 @@ jobs: - uses: actions/checkout@v3 - run: rustup target add wasm32-unknown-unknown - uses: Swatinem/rust-cache@v2 - - run: cargo build --package dioxus-std --verbose --target wasm32-unknown-unknown --no-default-features --features wasm-testing + - run: cargo build --package dioxus-sdk --verbose --target wasm32-unknown-unknown --no-default-features --features wasm-testing # need to run tests here desktop: @@ -29,5 +29,5 @@ jobs: steps: - uses: actions/checkout@v3 - uses: Swatinem/rust-cache@v2 - - run: cargo build --package dioxus-std --verbose --no-default-features --features desktop-testing - - run: cargo test --package dioxus-std --verbose --no-default-features --features desktop-testing + - run: cargo build --package dioxus-sdk --verbose --no-default-features --features desktop-testing + - run: cargo test --package dioxus-sdk --verbose --no-default-features --features desktop-testing diff --git a/Cargo.toml b/Cargo.toml index 537314d..7fb07ad 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,10 +1,9 @@ -[workspace] -resolver = "2" -members = [ - "std", - "examples/*", -] - -[workspace.dependencies] -dioxus-std = { path = "./std" } -dioxus = { version = "0.5" } +[workspace] +resolver = "2" +members = ["sdk", "examples/*"] + +[workspace.dependencies] +dioxus-sdk = { path = "./sdk" } +dioxus = { version = "0.5" } +dioxus-web = { version = "0.5" } +dioxus-desktop = { version = "0.5" } diff --git a/README.md b/README.md index 7c84b52..85f21ad 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,23 @@
-

🧰 Dioxus Standard Library 🚀

+

🧰 Dioxus Development Kit 🚀

A platform agnostic library for supercharging your productivity with Dioxus.

- - + Crates.io version - - + Download - + docs.rs docs @@ -32,7 +32,7 @@

This library is still under development. Expect breaking changes!


-`dioxus-std` is a Dioxus standard library that provides abstractions for your Dioxus app. Abstractions included are notifications, clipboard, geolocation and storage with more to come! +`dioxus-sdk` is a development kit for Dioxus that provides abstractions for your Dioxus app. Abstractions included are notifications, clipboard, geolocation and storage with more to come! **Features** - [x] Geolocation - (Web, Windows) @@ -51,7 +51,7 @@ Geolocation example: ```rust -use dioxus_std::geolocation::{ +use dioxus_sdk::geolocation::{ init_geolocator, use_geolocation, PowerMode }; @@ -82,10 +82,10 @@ sudo apt-get install xorg-dev ``` ## Usage -You can add `dioxus-std` to your application by adding it to your dependencies. +You can add `dioxus-sdk` to your application by adding it to your dependencies. ```toml [dependencies] -dioxus-std = { version = "0.5", features = [] } +dioxus-sdk= { version = "0.5", features = [] } ``` ## License @@ -93,4 +93,4 @@ This project is licensed under the [MIT license]. [mit license]: ./LICENSE -Every contribution intentionally submitted for inclusion in `dioxus-std` by you, shall be licensed as MIT, without any additional terms or conditions. +Every contribution intentionally submitted for inclusion in `dioxus-sdk` by you, shall be licensed as MIT, without any additional terms or conditions. diff --git a/examples/channel/Cargo.toml b/examples/channel/Cargo.toml index 866be64..650dd82 100644 --- a/examples/channel/Cargo.toml +++ b/examples/channel/Cargo.toml @@ -4,8 +4,9 @@ version = "0.1.0" edition = "2021" [dependencies] -dioxus-std = { workspace = true, features = ["utils"]} -dioxus = { workspace = true, features = ["web"]} +dioxus-sdk = { workspace = true, features = ["utils"] } +dioxus = { workspace = true, features = ["web"] } + log = "0.4.6" diff --git a/examples/channel/src/main.rs b/examples/channel/src/main.rs index ac96c42..9be318d 100644 --- a/examples/channel/src/main.rs +++ b/examples/channel/src/main.rs @@ -1,5 +1,5 @@ use dioxus::prelude::*; -use dioxus_std::utils::channel::{use_channel, use_listen_channel}; +use dioxus_sdk::utils::channel::{use_channel, use_listen_channel}; fn main() { // init debug tool for WebAssembly diff --git a/examples/clipboard/Cargo.toml b/examples/clipboard/Cargo.toml index a484f30..91530c1 100644 --- a/examples/clipboard/Cargo.toml +++ b/examples/clipboard/Cargo.toml @@ -4,5 +4,5 @@ version = "0.1.0" edition = "2021" [dependencies] -dioxus-std = { workspace = true, features = ["clipboard"] } -dioxus = { workspace = true, features = ["desktop"]} +dioxus-sdk = { workspace = true, features = ["clipboard"] } +dioxus = { workspace = true, features = ["desktop"] } diff --git a/examples/clipboard/src/main.rs b/examples/clipboard/src/main.rs index 27f3f4c..5e06527 100644 --- a/examples/clipboard/src/main.rs +++ b/examples/clipboard/src/main.rs @@ -1,5 +1,5 @@ use dioxus::prelude::*; -use dioxus_std::clipboard::use_clipboard; +use dioxus_sdk::clipboard::use_clipboard; fn main() { launch(app); diff --git a/examples/color_scheme/Cargo.toml b/examples/color_scheme/Cargo.toml index 935881d..4ec541e 100644 --- a/examples/color_scheme/Cargo.toml +++ b/examples/color_scheme/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" edition = "2021" [dependencies] -dioxus-std = { workspace = true, features = ["color_scheme"] } +dioxus-sdk = { workspace = true, features = ["color_scheme"] } dioxus = { workspace = true, features = ["web"]} log = "0.4.6" diff --git a/examples/color_scheme/src/main.rs b/examples/color_scheme/src/main.rs index c0c2ae3..b0d8b3d 100644 --- a/examples/color_scheme/src/main.rs +++ b/examples/color_scheme/src/main.rs @@ -1,5 +1,5 @@ use dioxus::prelude::*; -use dioxus_std::color_scheme::use_preferred_color_scheme; +use dioxus_sdk::color_scheme::use_preferred_color_scheme; fn main() { // init debug tool for WebAssembly diff --git a/examples/geolocation/Cargo.toml b/examples/geolocation/Cargo.toml index a65dbff..53c9f69 100644 --- a/examples/geolocation/Cargo.toml +++ b/examples/geolocation/Cargo.toml @@ -4,6 +4,7 @@ version = "0.1.0" edition = "2021" [dependencies] -dioxus-std = { workspace = true, features = ["geolocation"] } +dioxus-sdk = { workspace = true, features = ["geolocation"] } # You can change from 'desktop' to 'web' as well dioxus = { workspace = true, features = ["desktop"] } + diff --git a/examples/geolocation/README.md b/examples/geolocation/README.md index d3a1c5e..78950e9 100644 --- a/examples/geolocation/README.md +++ b/examples/geolocation/README.md @@ -4,4 +4,4 @@ Learn how to use the `geolocation` abstraction. Run: -```cargo run``` \ No newline at end of file +```dx serve``` \ No newline at end of file diff --git a/examples/geolocation/src/main.rs b/examples/geolocation/src/main.rs index c133216..9407c49 100644 --- a/examples/geolocation/src/main.rs +++ b/examples/geolocation/src/main.rs @@ -1,5 +1,5 @@ use dioxus::prelude::*; -use dioxus_std::geolocation::{init_geolocator, use_geolocation, PowerMode}; +use dioxus_sdk::geolocation::{init_geolocator, use_geolocation, PowerMode}; fn main() { launch(app); diff --git a/examples/i18n/Cargo.toml b/examples/i18n/Cargo.toml index 22217e2..904bddb 100644 --- a/examples/i18n/Cargo.toml +++ b/examples/i18n/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" edition = "2021" [dependencies] -dioxus-std = { workspace = true, features = ["i18n"] } +dioxus-sdk = { workspace = true, features = ["i18n"] } dioxus = { workspace = true, features = ["web"] } log = "0.4.6" diff --git a/examples/i18n/src/main.rs b/examples/i18n/src/main.rs index 84472c5..d6cd156 100644 --- a/examples/i18n/src/main.rs +++ b/examples/i18n/src/main.rs @@ -1,6 +1,6 @@ use dioxus::prelude::*; -use dioxus_std::i18n::*; -use dioxus_std::translate; +use dioxus_sdk::i18n::*; +use dioxus_sdk::translate; use std::str::FromStr; fn main() { diff --git a/examples/storage/Cargo.toml b/examples/storage/Cargo.toml index f4d790f..e427ee0 100644 --- a/examples/storage/Cargo.toml +++ b/examples/storage/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" edition = "2021" [dependencies] -dioxus-std = { workspace = true, features = ["storage"] } +dioxus-sdk = { workspace = true, features = ["storage"] } dioxus = { workspace = true, features = ["router"] } [features] diff --git a/examples/storage/src/main.rs b/examples/storage/src/main.rs index a488508..7e93d63 100644 --- a/examples/storage/src/main.rs +++ b/examples/storage/src/main.rs @@ -1,9 +1,9 @@ use dioxus::prelude::*; use dioxus_router::prelude::*; -use dioxus_std::storage::*; +use dioxus_sdk::storage::*; fn main() { - dioxus_std::storage::set_dir!(); + dioxus_sdk::storage::set_dir!(); launch(app); } diff --git a/std/Cargo.toml b/sdk/Cargo.toml similarity index 97% rename from std/Cargo.toml rename to sdk/Cargo.toml index e6e143c..1c4bbac 100644 --- a/std/Cargo.toml +++ b/sdk/Cargo.toml @@ -1,12 +1,12 @@ [package] -name = "dioxus-std" +name = "dioxus-sdk" version = "0.5.0" authors = ["Jonathan Kelley", "Dioxus Labs", "ealmloff", "DogeDark", "marc2332"] edition = "2021" description = "Platform agnostic library for supercharging your productivity with Dioxus" license = "MIT" readme = "../README.md" -repository = "https://github.com/DioxusLabs/dioxus-std/" +repository = "https://github.com/DioxusLabs/dioxus-sdk/" homepage = "https://dioxuslabs.com" keywords = ["dom", "gui", "dioxus", "standard", "hooks"] categories = ["multimedia", "os", "wasm"] diff --git a/std/src/clipboard/mod.rs b/sdk/src/clipboard/mod.rs similarity index 100% rename from std/src/clipboard/mod.rs rename to sdk/src/clipboard/mod.rs diff --git a/std/src/clipboard/use_clipboard.rs b/sdk/src/clipboard/use_clipboard.rs similarity index 97% rename from std/src/clipboard/use_clipboard.rs rename to sdk/src/clipboard/use_clipboard.rs index 499bd7d..53f1940 100644 --- a/std/src/clipboard/use_clipboard.rs +++ b/sdk/src/clipboard/use_clipboard.rs @@ -43,7 +43,7 @@ impl UseClipboard { /// # Examples /// /// ```ignore -/// use dioxus_std::clipboard::use_clipboard; +/// use dioxus_sdk::clipboard::use_clipboard; /// /// // Get a handle to the clipboard /// let mut clipboard = use_clipboard(); diff --git a/std/src/color_scheme/mod.rs b/sdk/src/color_scheme/mod.rs similarity index 100% rename from std/src/color_scheme/mod.rs rename to sdk/src/color_scheme/mod.rs diff --git a/std/src/color_scheme/use_preferred_color_scheme.rs b/sdk/src/color_scheme/use_preferred_color_scheme.rs similarity index 100% rename from std/src/color_scheme/use_preferred_color_scheme.rs rename to sdk/src/color_scheme/use_preferred_color_scheme.rs diff --git a/std/src/geolocation/core.rs b/sdk/src/geolocation/core.rs similarity index 100% rename from std/src/geolocation/core.rs rename to sdk/src/geolocation/core.rs diff --git a/std/src/geolocation/mod.rs b/sdk/src/geolocation/mod.rs similarity index 100% rename from std/src/geolocation/mod.rs rename to sdk/src/geolocation/mod.rs diff --git a/std/src/geolocation/platform/mod.rs b/sdk/src/geolocation/platform/mod.rs similarity index 100% rename from std/src/geolocation/platform/mod.rs rename to sdk/src/geolocation/platform/mod.rs diff --git a/std/src/geolocation/platform/wasm.rs b/sdk/src/geolocation/platform/wasm.rs similarity index 100% rename from std/src/geolocation/platform/wasm.rs rename to sdk/src/geolocation/platform/wasm.rs diff --git a/std/src/geolocation/platform/windows.rs b/sdk/src/geolocation/platform/windows.rs similarity index 100% rename from std/src/geolocation/platform/windows.rs rename to sdk/src/geolocation/platform/windows.rs diff --git a/std/src/geolocation/use_geolocation.rs b/sdk/src/geolocation/use_geolocation.rs similarity index 100% rename from std/src/geolocation/use_geolocation.rs rename to sdk/src/geolocation/use_geolocation.rs diff --git a/std/src/i18n/mod.rs b/sdk/src/i18n/mod.rs similarity index 100% rename from std/src/i18n/mod.rs rename to sdk/src/i18n/mod.rs diff --git a/std/src/i18n/tanslate.rs b/sdk/src/i18n/tanslate.rs similarity index 100% rename from std/src/i18n/tanslate.rs rename to sdk/src/i18n/tanslate.rs diff --git a/std/src/i18n/use_i18n.rs b/sdk/src/i18n/use_i18n.rs similarity index 100% rename from std/src/i18n/use_i18n.rs rename to sdk/src/i18n/use_i18n.rs diff --git a/std/src/i18n/use_init_i18n.rs b/sdk/src/i18n/use_init_i18n.rs similarity index 100% rename from std/src/i18n/use_init_i18n.rs rename to sdk/src/i18n/use_init_i18n.rs diff --git a/std/src/lib.rs b/sdk/src/lib.rs similarity index 100% rename from std/src/lib.rs rename to sdk/src/lib.rs diff --git a/std/src/notification/mod.rs b/sdk/src/notification/mod.rs similarity index 100% rename from std/src/notification/mod.rs rename to sdk/src/notification/mod.rs diff --git a/std/src/notification/notification.rs b/sdk/src/notification/notification.rs similarity index 98% rename from std/src/notification/notification.rs rename to sdk/src/notification/notification.rs index 73931b2..1797c46 100644 --- a/std/src/notification/notification.rs +++ b/sdk/src/notification/notification.rs @@ -8,7 +8,7 @@ use std::fmt; /// # Examples /// /// ``` -/// use dioxus_std::notification::Notification; +/// use dioxus_sdk::notification::Notification; /// /// Notification::new() /// .app_name("dioxus test".to_string()) diff --git a/std/src/storage/client_storage/fs.rs b/sdk/src/storage/client_storage/fs.rs similarity index 100% rename from std/src/storage/client_storage/fs.rs rename to sdk/src/storage/client_storage/fs.rs diff --git a/std/src/storage/client_storage/memory.rs b/sdk/src/storage/client_storage/memory.rs similarity index 100% rename from std/src/storage/client_storage/memory.rs rename to sdk/src/storage/client_storage/memory.rs diff --git a/std/src/storage/client_storage/mod.rs b/sdk/src/storage/client_storage/mod.rs similarity index 94% rename from std/src/storage/client_storage/mod.rs rename to sdk/src/storage/client_storage/mod.rs index 6acd450..32f18e0 100644 --- a/std/src/storage/client_storage/mod.rs +++ b/sdk/src/storage/client_storage/mod.rs @@ -2,7 +2,7 @@ /// Set the directory where the storage files are located on non-wasm targets. /// /// ```rust -/// use dioxus_std::set_dir; +/// use dioxus_sdk::set_dir; /// /// fn main(){ /// // set the directory to the default location @@ -10,7 +10,7 @@ /// } /// ``` /// ```rust -/// use dioxus_std::set_dir; +/// use dioxus_sdk::set_dir; /// /// fn main(){ /// // set the directory to a custom location diff --git a/std/src/storage/client_storage/web.rs b/sdk/src/storage/client_storage/web.rs similarity index 100% rename from std/src/storage/client_storage/web.rs rename to sdk/src/storage/client_storage/web.rs diff --git a/std/src/storage/mod.rs b/sdk/src/storage/mod.rs similarity index 99% rename from std/src/storage/mod.rs rename to sdk/src/storage/mod.rs index 884995b..9635020 100644 --- a/std/src/storage/mod.rs +++ b/sdk/src/storage/mod.rs @@ -2,7 +2,7 @@ //! A library for handling local storage ergonomically in Dioxus //! ## Usage //! ```rust -//! use dioxus_std::storage::use_persistent; +//! use dioxus_sdk::storage::use_persistent; //! use dioxus::prelude::*; //! //! fn app() -> Element { @@ -53,7 +53,7 @@ pub use client_storage::{set_dir_name, set_directory}; /// ## Usage /// /// ```rust -/// use dioxus_std::storage::{use_storage, StorageBacking}; +/// use dioxus_sdk::storage::{use_storage, StorageBacking}; /// use dioxus::prelude::*; /// use dioxus_signals::Signal; /// @@ -78,7 +78,7 @@ where /// ## Usage /// /// ```rust -/// use dioxus_std::storage::{new_storage, StorageBacking}; +/// use dioxus_sdk::storage::{new_storage, StorageBacking}; /// use dioxus::prelude::*; /// use dioxus_signals::Signal; /// diff --git a/std/src/storage/persistence.rs b/sdk/src/storage/persistence.rs similarity index 100% rename from std/src/storage/persistence.rs rename to sdk/src/storage/persistence.rs diff --git a/std/src/utils/channel/mod.rs b/sdk/src/utils/channel/mod.rs similarity index 100% rename from std/src/utils/channel/mod.rs rename to sdk/src/utils/channel/mod.rs diff --git a/std/src/utils/channel/use_channel.rs b/sdk/src/utils/channel/use_channel.rs similarity index 100% rename from std/src/utils/channel/use_channel.rs rename to sdk/src/utils/channel/use_channel.rs diff --git a/std/src/utils/channel/use_listen_channel.rs b/sdk/src/utils/channel/use_listen_channel.rs similarity index 100% rename from std/src/utils/channel/use_listen_channel.rs rename to sdk/src/utils/channel/use_listen_channel.rs diff --git a/std/src/utils/mod.rs b/sdk/src/utils/mod.rs similarity index 100% rename from std/src/utils/mod.rs rename to sdk/src/utils/mod.rs