libmake 0.2.6

A code generator to reduce repetitive tasks and build high-quality Rust libraries and applications, by providing a simple interface to create projects, generate code, and manage dependencies.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

// Copyright notice and licensing information.
// These lines indicate the copyright of the software and its licensing terms.
// SPDX-License-Identifier: Apache-2.0 OR MIT indicates dual licensing under Apache 2.0 or MIT licenses.
// Copyright © 2023-2024 LibMake. All rights reserved.

//! # Example: Generating Templates from a YAML File
//!
//! This is a simple example that demonstrates how to use the `generate_from_yaml` function
//! from the `libmake` crate to generate template files from a YAML file.
//!
//! ## Usage
//!
//! To run this example, make sure you have a valid YAML file at the specified path.
//! The example specifies the path to the YAML file (`yaml_file_path`) and then calls
//! the `generate_from_yaml` function with this path as a parameter.
//!
//! If the generation process is successful, it does nothing (the template files are created).
//! If there is an error during generation, it prints an error message.
//!
//! ```rust
//! // Import the necessary function for generating templates from a YAML file.
//! use libmake::generator::generate_from_yaml;
//!
//! // Specify the path to the YAML file to be used for generating templates.
//! let yaml_file_path = "./tests/data/mylibrary.yaml";
//!
//! // Generate template files from the specified YAML file.
//! generate_from_yaml(yaml_file_path)
//!     .expect("Failed to generate the template files");
//! ```

// Import the necessary function for generating templates from a YAML file.
use libmake::generators::yaml::generate_from_yaml;

/// Generate template files from the specified YAML file.
///
/// # Arguments
///
/// * `yaml_file_path` - Path to the YAML file to be used for generating templates.
///
/// # Returns
///
/// * `Result<(), String>` - Returns `Ok(())` if the template files are generated successfully, or returns an error message if there is an error during generation.
///
pub(crate) fn main() {
    // Specify the path to the YAML file to be used for generating templates.
    let yaml_file_path = "./tests/data/mylibrary.yaml";

    // Generate template files from the specified YAML file.
    generate_from_yaml(yaml_file_path)
        .expect("Failed to generate the template files");
}