23 releases (11 breaking)

0.12.1 Oct 6, 2024
0.11.1 Oct 2, 2024
0.9.3 Jul 12, 2024
0.2.2 Mar 27, 2024

#61 in Template engine

Download history 244/week @ 2024-06-24 86/week @ 2024-07-01 194/week @ 2024-07-08 31/week @ 2024-07-15 2/week @ 2024-07-22 44/week @ 2024-07-29 303/week @ 2024-08-19 160/week @ 2024-08-26 330/week @ 2024-09-02 3/week @ 2024-09-09 97/week @ 2024-09-16 128/week @ 2024-09-23 582/week @ 2024-09-30 155/week @ 2024-10-07

962 downloads per month
Used in tinty

MIT/Apache

70KB
1K SLoC

tinted-builder-rust

Matrix Chat Crates.io Tests

A builder for base16 and base24 templates using the 0.11.1 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

Installation

Cargo

cargo install tinted-builder-rust

Homebrew

brew tap tinted-theming/tinted
brew install tinted-builder-rust

Binaries

Download the relevant binary from the repository releases page.

Basic Usage

tinted-builder-rust sync # To sync with latest schemes
tinted-builder-rust build path/to/base16-template

Commands

The following is a table of the available subcommands for the CLI tool (tinted-builder-rust), including the descriptions and any notable arguments.

Subcommand Description Arguments Example Usage Flags
sync Installs and or updates latest schemes. - tinted-builder-rust sync --quiet (silence stderr and stdout)
build Builds the themes of a template. template_path: Path to template directory. tinted-builder-rust build ./path/to/base16-template --quiet (silence stderr and stdout), --sync (equivalent of running tinted-builder-rust sync before tinted-builder-rust build)

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 tinted-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/tinted-builder-rust or ~/.local/share. MacOS: ~/Library/Application\ Support/tinted-theming/tinted-builder-rust tinted-builder-rust sync --data-dir /path/to/custom/data-dir
--help -h Displays help information for the subcommand. All - tinted-builder-rust --help, tinted-builder-rust build --help, etc
--version -V Shows the version of tinted-builder-rust. All - tinted-builder-rust --version

Builder specification

tinted-builder-rust implements the 0.11.1 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.

Contributing

Contributions are welcome! Have a look at CONTRIBUTING.md for more information.

License

Ribboncurls is dual-licensed under the [Apache 2.0] and [MIT] licenses. For more information about the licenses of the projects used by Ribboncurls, have a look at LICENSES-THIRD-PARTY.md.

Dependencies

~7–19MB
~227K SLoC