LibMake

A code generator to reduce repetitive tasks and build high-quality Rust libraries

Welcome to libmake 👋

Website • Documentation • Report Bug • Request Feature • Contributing Guidelines

Overview 📖

LibMake is a tool designed to quickly help creating high-quality Rust libraries by generating a set of pre-filled and pre-defined templated files. This opinionated boilerplate scaffolding tool aims to greatly reduces development time and minimizes repetitive tasks, allowing you to focus on your business logic while enforcing standards, best practices, consistency, and providing style guides for your library.

With LibMake, you can easily generate a new Rust library code base structure with all the necessary files, layouts, build configurations, code, tests, benchmarks, documentation, and much more in a matter of seconds.

The library is designed to be used as a command-line tool. It is available on Crates.io and Lib.rs.

Features ✨

LibMake offers the following features and benefits:

• Create your Rust library with ease using the command line interface or by providing a configuration file in CSV, JSON, or YAML format.
• Rapidly generate new library projects with a pre-defined structure and boilerplate code that you can customize with your own template.
• Automatically generate basic functions, methods, and macros to get you started with your Rust library.
• Enforce best practices and standards with starter documentation, test suites, and benchmark suites that are designed to help you get up and running quickly.

Getting Started 🚀

It takes just a few minutes to get up and running with LibMake.

Installation

To install LibMake, you need to have the Rust toolchain installed on your machine. You can install the Rust toolchain by following the instructions on the Rust website.

Once you have the Rust toolchain installed, you can install LibMake using the following command:

cargo install libmake

You can then run the help command to see the available options:

libmake --help

Requirements

The minimum supported Rust toolchain version is currently Rust 1.67.1 or later (stable).

Platform support

LibMake is supported and tested on the following platforms:

Linux targets 🐧

macOS targets 🍎

The GitHub Actions shows the platforms in which the LibMake library tests are run.

Documentation

ℹ️ Info: Please check out our website for more information. You can find our documentation on docs.rs, lib.rs and crates.io.

Usage 📖

To use LibMake library in your project, add the following to your Cargo.toml file:

[dependencies]
libmake = "0.0.4"

Add the following to your main.rs file:

extern crate libmake;
use libmake::*;

then you can use the functions in your application code.

Examples

To get started with LibMake, you can use the examples provided in the examples directory of the project.

To run the examples, clone the repository and run the following command in your terminal from the project root directory.

Generate a new library using a CSV file

The following code uses the generate_via_csv function from the libmake crate to generate a library template from a CSV file.

Have a look at the tests/data/mylibrary.csv file for an example and feel free to use it for your own library as a template.

The CSV file contains the following header columns:

• author - The author of the library (e.g. John Doe)
• build - The build configuration file name (e.g. build.rs)
• categories - The categories of the library from Crates.io (e.g. cli,development)
• csv - The CSV file path to use for the library template generation (e.g. /tests/data/mylibrary.csv)
• description - The description of the library (e.g. My library is a great library)
• documentation - The documentation of the library (e.g. https://docs.rs/mylibrary)
• edition - The edition of the library (e.g. 2021)
• email - The email of the author of the library (e.g. john.doe@gmail.com)
• homepage - The homepage of the library (e.g. https://mylibrary.com)
• keywords - The keywords of the library from Crates.io (e.g. cli,development)
• license - The license of the library (e.g. MIT OR Apache-2.0)
• name - The name of the library (e.g. mylibrary)
• output - The output directory path to use for the library template generation (e.g. /tmp/mylibrary)
• readme - The README file name (e.g. README.md)
• repository - The repository of the library (e.g. https://github.com/mylibrary/mylibrary)
• rustversion - The Rust version of the library (e.g. 1.56.0)
• version - The version of the library (e.g. 0.1.0)
• website - The website of the author of the library (e.g. https://johndoe.com)

Then you need to create a row in your CSV file with the values for each

You can now run the following command to generate a new library using

cargo run --example generate_via_csv

Generate a new library using a JSON file

The following code uses the generate_via_json function from the libmake crate to generate a library template from a JSON file.

cargo run --example generate_via_json

Generate a new library using a YAML file

The following code uses the generate_via_yaml function from the libmake crate to generate a library template from a YAML file.

cargo run --example generate_via_yaml

Semantic Versioning Policy 🚥

For transparency into our release cycle and in striving to maintain backward compatibility, libmake follows semantic versioning.

License 📝

The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).

• Apache License, Version 2.0
• MIT license

Contribution 🤝

We welcome all people who want to contribute. Please see the contributing instructions for more information.

Contributions in any form (issues, pull requests, etc.) to this project must adhere to the Rust's Code of Conduct.

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.

Acknowledgements 💙

A big thank you to all the awesome contributors of libmake for their help and support. A special thank you goes to the Rust Reddit community for providing a lot of useful suggestions on how to improve this project.