LibMake

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

Welcome to libmake 👋

Table of Contents 📖

• Overview 📖
• Features ✨
• Getting Started 🚀
  • Installation
  • Requirements
  • Platform support
  • FreeBSD targets 🐬
  • Linux targets 🐧
  • Illumos targets 🌞
  • macOS targets 🍎
  • Documentation
• Usage 📖
  • Command-line interface
  • Generate a new library using a CSV file
  • Generate a new library using a JSON file
  • Generate a new library using a TOML file
  • Generate a new library using a YAML file
  • Generate a new library using the command-line interface (CLI) directly
  • Examples
• Semantic Versioning Policy 🚥
• License 📝
• Contribution 🤝
• Acknowledgements 💙

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, TOML, or YAML format.
• Rapidly generate new library projects with a pre-defined structure and boilerplate code that you can customize with your own template.
• Generate a library pre-defined GitHub Actions workflow to help you automate your library development and testing.
• 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 seconds 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:

shell cargo install libmake

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

shell libmake --help

Requirements

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

Platform support

LibMake is supported and has been tested on the following platforms:

FreeBSD targets 🐬

| Target | Description | Status | |--------|-------------|--------| | x86_64-unknown-freebsd | 64-bit FreeBSD on x86-64 | ✅ Tested |

Linux targets 🐧

| Target | Description | Status | |--------|-------------|--------| | aarch64-unknown-linux-gnu | 64-bit Linux systems on ARM architecture | ✅ Tested | | aarch64-unknown-linux-musl | 64-bit Linux systems on ARM architecture | ✅ Tested | | arm-unknown-linux-gnueabi | ARMv6 Linux (kernel 3.2, glibc 2.17) | ✅ Tested | | armv7-unknown-linux-gnueabihf | ARMv7 Linux, hardfloat (kernel 3.2, glibc 2.17) | ✅ Tested | | i686-unknown-linux-gnu | 32-bit Linux (kernel 3.2+, glibc 2.17+) | ✅ Tested | | i686-unknown-linux-musl | 32-bit Linux (kernel 3.2+, musl libc) | ✅ Tested | | x8664-unknown-linux-gnu | 64-bit Linux (kernel 2.6.32+, glibc 2.11+) | ✅ Tested | | x8664-unknown-linux-musl | 64-bit Linux (kernel 2.6.32+, musl libc) | ✅ Tested |

Illumos targets 🌞

| Target | Description | Status | |--------|-------------|--------| | x86_64-unknown-illumos | 64-bit Illumos on x86-64 | ✅ Tested |

macOS targets 🍎

| Target | Description | Status | |--------|-------------|--------| | aarch64-apple-darwin | 64-bit macOS on Apple Silicon | ✅ Tested | | x86_64-apple-darwin | 64-bit macOS (10.7 Lion or later) | ✅ Tested |

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

Should you encounter any issues with the library on any of the above platforms, please report a bug. We will do our best to resolve the issue as soon as possible. If you would like to contribute to help us to support additional platforms, please submit a pull request.

Documentation

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

Usage 📖

Command-line interface

LibMake provides a command-line interface to generate a new library project. There are a few options available to help you get started.

Generate a new library using a CSV file

The following command generates 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.

shell libmake --csv tests/data/mylibrary.csv

or locally if you have cloned the repository:

shell cargo run -- --csv tests/data/mylibrary.csv

Generate a new library using a JSON file

The following command generates a library template from a JSON file.

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

shell libmake --json tests/data/mylibrary.json

or locally if you have cloned the repository:

shell cargo run -- --json tests/data/mylibrary.json

Generate a new library using a TOML file

The following command generates a library template from a TOML file.

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

shell libmake --toml tests/data/mylibrary.toml

or locally if you have cloned the repository:

shell cargo run -- --toml tests/data/mylibrary.toml

Generate a new library using a YAML file

The following command generates a library template from a YAML file.

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

shell libmake --yml tests/data/mylibrary.yaml

or locally if you have cloned the repository:

shell cargo run -- --yml tests/data/mylibrary.yaml

Generate a new library using the command-line interface (CLI) directly

The following command generates a library template using the command-line interface.

shell libmake \ --author "John Smith" \ --build "build.rs" \ --categories "['category 1', 'category 2', 'category 3']" \ --description "A Rust library for doing cool things" \ --documentation "https://docs.rs/my_library" \ --edition "2021" \ --email "john.smith@example.com" \ --homepage "https://my_library.rs" \ --keywords "['rust', 'library', 'cool']" \ --license "MIT" \ --name "my_library" \ --output "my_library" \ --readme "README.md" \ --repository "https://github.com/example/my_library" \ --rustversion "1.67.1" \ --version "0.1.0" \ --website "https://example.com/john-smith"

or locally if you have cloned the repository:

shell cargo run -- --author "John Smith" \ --build "build.rs" \ --categories "['category 1', 'category 2', 'category 3']" \ --description "A Rust library for doing cool things" \ --documentation "https://docs.rs/my_library" \ --edition "2021" \ --email "john.smith@example.com" \ --homepage "https://my_library.rs" \ --keywords "['rust', 'library', 'cool']" \ --license "MIT" \ --name "my_library" \ --output "my_library" \ --readme "README.md" \ --repository "https://github.com/example/my_library" \ --rustversion "1.67.1" \ --version "0.1.0" \ --website "https://example.com/john-smith"

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.

| Example | Description | Command | |---------|-------------|---------| | generate_from_args | Generates a library template using the command-line interface. | cargo run --example generate_from_args | | generate_from_config | Generates a library template from a configuration file. | cargo run --example generate_from_config | | generate_from_csv | Generates a library template from a CSV file. | cargo run --example generate_from_csv | | generate_from_json | Generates a library template from a JSON file. | cargo run --example generate_from_json | | generate_from_toml | Generates a library template from a TOML file. | cargo run --example generate_from_toml | | generate_from_yaml | Generates a library template from a YAML file. | cargo run --example generate_from_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.