rocher / mold_lib

Meta-variable Operations for Lean Development

Welcome to Mold

MOLD: Meta-variable Operations for Lean Development

Mold is a Template Processor, or Template Engine, to work with repository templates. The main motivation of Mold is to have repositories in GitHub used as template repositories to create new, customized repositories for other users.

Main features supported in Mold include

• variable replacement in mold files (*.mold)

• for a given directory, variable replacement recursively for all mold files in all subdirectories

• variable replacement in file names

• inclusion of other templates

• definition of variables with a simple TOML file

• predefined and customized text filters to easily apply text transformations

Variable replacement can be specified as normal, optional or mandatory. For example, the variable foo = "bar" can be specified with {{foo}}, {{?foo}} (optional) or {{#foo}} (mandatory). The difference is the handling of errors when an undefined variable is encountered.

All mold files must end with the extension .mold, for example README.md.mold. Destination files (with variables replaced) have the same name without the mold extension: README.md. This simplifies the work done in large subdirectories with few templates.

Text filters can be used to apply text transformations, for example {{foo/W5}} truncates the contents of the variable foo to a maximum width of 5 characters.

This crate contains the Ada library and unit tests. For a CLI tool, please take a look at the crate mold.

Reference Guide

Please visit Mold documentation for more information.

---

License

MIT (c) 2023, 2024 Francesc Rocher

mold_lib's Issues

[Feature request] Supporting substitutions in string parameters

Hi @rocher,

Very interesting project.

After a quick look, I think the library doesn't support substituting inside a passed string. I have a project idea in which the program will programmatically determine the values to make the substitution in a template. The template could be passed to the program by the user, but I'd like also to have a default template valid for most use cases. If the default template could be stored in memory as a string, there wouldn't be any need to add it to the program as a resource (either external or embedded with some library). The program determines the values, it calls mold_lib to do the substitutions passing the default in memory template, and the resulting string is dumped to the final file by the program.