Add ui_macros
crate & DerivePathStr
derive macro (#17811)
This PR adds the `ui_macros` crate to allow building supporting macros for the `ui` crate. Additionally, it implements the `DerivePathStr` derive macro and the `path_str` attribute macro. These macros work together to generate a `path` method for enum variants, which is useful for creating standardized string representations of enum variants. The `DerivePathStr` macro provides the following functionality: - Generates a `path` method for each enum variant. - Allows specifying a prefix (required) and suffix (optional) for all paths. - Supports `strum` attributes for case conversion (e.g., snake_case, lowercase). Usage example: ```rust #[derive(DerivePathStr)] #[path_str(prefix = "my_prefix", suffix = ".txt")] #[strum(serialize_all = "snake_case")] enum MyEnum { VariantOne, VariantTwo, } // Generated paths: // MyEnum::VariantOne.path() -> "my_prefix/variant_one.txt" // MyEnum::VariantTwo.path() -> "my_prefix/variant_two.txt" ``` In a later PR this will be used to automate the creation of icon & image paths in the `ui` crate. This gives the following benefits: 1. Ensures standard naming of assets as paths are not manually specified. 2. Makes adding new enum variants less tedious and error-prone. 3. Quickly catches missing or incorrect paths during compilation. 3. Adds a building block towards being able to lint for unused assets in the future. Release Notes: - N/A
This commit is contained in:
parent
d245f5e75c
commit
fac9ee5f86
10 changed files with 228 additions and 1 deletions
19
crates/ui_macros/Cargo.toml
Normal file
19
crates/ui_macros/Cargo.toml
Normal file
|
@ -0,0 +1,19 @@
|
|||
[package]
|
||||
name = "ui_macros"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
publish = false
|
||||
license = "GPL-3.0-or-later"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[lib]
|
||||
path = "src/ui_macros.rs"
|
||||
proc-macro = true
|
||||
|
||||
[dependencies]
|
||||
proc-macro2 = "1.0.66"
|
||||
quote = "1.0.9"
|
||||
syn = { version = "1.0.72", features = ["full", "extra-traits"] }
|
||||
convert_case.workspace = true
|
Loading…
Add table
Add a link
Reference in a new issue