taml

Crates.iotaml
lib.rstaml
version0.0.11
sourcesrc
created_at2020-08-26 18:14:52.710002
updated_at2021-08-01 09:39:08.519541
descriptionA kind-to-humans configuration language.
homepagehttps://github.com/Tamschi/taml/tree/v0.0.11
repositoryhttps://github.com/Tamschi/taml
max_upload_size
id281058
size95,993
Tamme Schichler (Tamschi)

documentation

https://docs.rs/taml/0.0.11

README

TAML

Lib.rs Crates.io Docs.rs

Rust 1.53 CI Crates.io - License

GitHub open issues open pull requests crev reviews

TAML is a configuration file format combining some aspects of Markdown, CSV, TOML, YAML and Rust.

As configuration language, TAML's main design goals are to be:

  • Human-writeable
  • Human-readable
  • Unambiguous and Debuggable
  • Computer-readable

Since it is mainly human-oriented and the same data can be represented in multiple ways, there is in fact no serializer in this library. If you need a data transfer format, pretty much anything else will give you better performance.

That said, I believe that for human-written files, TAML offers a great balance between brevity and simplicity, with more than sufficient performance.

A command line validator and formatter is available in the taml-cli crate.
Serde-intergration can be found in serde_taml.

See https://taml.schichler.dev for documentation on the format itself.

Installation

Please use cargo-edit to always add the latest version of this library:

cargo add taml

Example

TODO: Add a good example file here.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Code of Conduct

Changelog

Versioning

taml strictly follows Semantic Versioning 2.0.0 with the following exceptions:

  • Invalid TAML becoming valid is considered a feature addition.
  • The minor version will not reset to 0 on major version changes (except for v1).
    Consider it the global feature level.
  • The patch version will not reset to 0 on major or minor version changes (except for v0.1 and v1).
    Consider it the global patch level.

This includes the Rust version requirement specified above.
Earlier Rust versions may be compatible, but this can change with minor or patch releases.

Which versions are affected by features and patches can be determined from the respective headings in CHANGELOG.md.

Commit count: 244

cargo fmt