2 unstable releases
0.2.0 | Mar 8, 2024 |
---|---|
0.1.0 | Mar 8, 2024 |
#6 in #base16
75KB
649 lines
builder-rust
Note: This project has been renamed to tinted-builder-rust to have a less generic name. Please update to use tinted-builder-rust.
A builder for base16 and base24 templates using the 0.11.0
builder
specification.
This crate contains a command-line tool to build base16 and base24 templates. It is also a library crate which you can use to directly build templates within your own Rust application.
Table of Contents
CLI
Installation
Cargo
cargo install builder-rust
Homebrew
brew tap tinted-theming/tinted
brew install builder-rust
Binaries
Download the relevant binary from the repository releases page.
Basic Usage
builder-rust sync # To sync with latest schemes
builder-rust build path/to/base16-template
Commands
The following is a table of the available subcommands for the CLI tool (builder-rust), including the descriptions and any notable arguments.
Subcommand | Description | Arguments | Example Usage |
---|---|---|---|
sync |
Installs and or updates latest schemes. | - | builder-rust sync |
build |
Builds the themes of a template. | template_path : Path to template directory. |
builder-rust build ./path/to/base16-template |
Flags
Flag/Option | Description | Applicable Subcommands | Default Value | Example Usage |
---|---|---|---|---|
--schemes-dir -s |
Path to a custom local schemes directory to use when building. Only necessary if the latest schemes repository is not desired. | build |
builder-rust build . --schemes-dir=/path/to/schemes/dir |
|
--data-dir -d |
Specifies a custom path for the data directory. | All | Linux: $XDG_DATA_HOME/tinted-theming/builder-rust or ~/.local/share . MacOS: ~/Library/Application\ Support/tinted-theming/builder-rust |
builder-rust sync --data-dir /path/to/custom/data-dir |
--help -h |
Displays help information for the subcommand. | All | - | builder-rust --help , builder-rust build --help , etc |
--version -V |
Shows the version of builder-rust. | All | - | builder-rust --version |
Builder specification
builder-rust implements the 0.11.0
builder specification. This
specification details the scheme yaml format or schema as well as the
variables the builder should provide when rendering template mustache
file. Have a look at the builder specification document for more
details.
Library
This library exposes a Scheme
and Template
struct which you can
use to generate your own themes using base16 and base24 templates and
0.11.0
compliant base16 and base24 scheme files.
Internally builder-rust uses ramhorns to render the templates.
Library installation
cargo add builder-rust
Library Usage
use builder_rust::{Scheme, Template};
use std::fs::read_to_string;
let template_str = read_to_string("path/to/template.mustache").unwrap();
let scheme_str = read_to_string("path/to/scheme.yml").unwrap();
let template = Template::new(template_str).unwrap();
let scheme: Scheme = serde_yaml::from_str(&scheme_str).unwrap();
template
.render_to_file("path/to/rendered/template", &scheme)
.unwrap();
The Scheme struct is as follows:
pub struct Scheme {
pub system: String,
pub name: String,
pub slug: String,
pub author: String,
pub description: Option<String>,
pub variant: String,
pub palette: HashMap<String, Color>,
}
pub struct Color {
pub hex: (String, String, String),
pub rgb: (u8, u8, u8),
pub dec: (f32, f32, f32),
}
Template::new
The Template
struct simply sets the content provided to it via
Template::new
.
template.render_to_file(&scheme)
takes the scheme and generates the
variables defined in the 0.11.0
builder specification.
Contributing
Contributions are welcome! Have a look at CONTRIBUTING.md for more information.
License
This project uses Ramhorns, which is under the GPL-3 license. While most Tinted Theming projects are under the MIT license, this project is under the GPL-3 license since it consumes Ramhorns. See the LICENSE file for more details and the license.html for containing the licenses of the used crates within the project.
Dependencies
~6–17MB
~173K SLoC