chore(libmake): 📝 date updates and optimised examples

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 authors = ["LibMake Contributors"]
-categories = ['development-tools', 'command-line-utilities', 'template-engine']
+categories = ["development-tools", "command-line-utilities", "template-engine"]
 description = """
 A code generator to reduce repetitive tasks and build high-quality Rust
 libraries and applications, by providing a simple interface to create
@@ -19,6 +19,7 @@ keywords = [
 ]
 license = "MIT OR Apache-2.0"
 name = "libmake"
+readme = "README.md"
 repository = "https://github.com/sebastienrousseau/libmake.git"
 rust-version = "1.75.0"
 version = "0.2.1"

build.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 //! This is the main function for the build script.

examples/example.rs

@@ -0,0 +1,43 @@
+// Copyright © 2024 LibMake. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+/// This is a module for the example `generate_from_args`.
+mod generate_from_args;
+
+/// This is a module for the example `generate_from_config`.
+mod generate_from_config;
+
+/// This is a module for the example `generate_from_csv`.
+mod generate_from_csv;
+
+/// This is a module for the example `generate_from_json`.
+mod generate_from_json;
+
+/// This is a module for the example `generate_from_toml`.
+mod generate_from_toml;
+
+/// This is a module for the example `generate_from_yaml`.
+mod generate_from_yaml;
+
+/// This is a module for the example `get_csv_field`.
+mod get_csv_field;
+
+/// This is a module for the example `get_json_field`.
+mod get_json_field;
+
+/// This is a module for the example `get_yaml_field`.
+mod get_yaml_field;
+
+/// The main function that runs all the example modules.
+fn main() {
+    // Run the `main()` function from each module to execute the examples.
+    generate_from_args::main();
+    generate_from_config::main();
+    generate_from_csv::main();
+    generate_from_json::main();
+    generate_from_toml::main();
+    generate_from_yaml::main();
+    get_csv_field::main();
+    get_json_field::main();
+    get_yaml_field::main();
+}

examples/generate_from_args.rs

@@ -25,7 +25,7 @@
 // Import the necessary function for generating files from arguments
 use libmake::generator::generate_from_args;
 
-fn main() {
+pub fn main() {
     // Simulate command line arguments
     let args = "--author=Me --output=my_library"
         .split(' ')

examples/generate_from_config.rs

@@ -33,7 +33,7 @@
 
 use libmake::generator::generate_from_config;
 
-fn main() {
+pub fn main() {
     // Define the file path for the configuration file.
     let file_path = "./tests/data/mylibrary.yaml";
 

examples/generate_from_csv.rs

@@ -30,7 +30,7 @@ use libmake::generator::generate_from_csv;
 
 /// This is a simple test for generating files from a CSV file using the `generate_from_csv` function.
 /// It attempts to generate template files from a CSV file and expects the operation to be successful.
-fn main() {
+pub fn main() {
     // Define the path to the CSV file to be used for testing.
     let csv_file_path = "./tests/data/mylibrary.csv";
 

examples/generate_from_json.rs

@@ -33,7 +33,7 @@ use libmake::generator::generate_from_json;
 
 /// This test demonstrates how to use the `generate_from_json` function from the `libmake` crate
 /// to generate template files from a JSON file.
-fn main() {
+pub fn main() {
     // Define the path to the JSON file that contains configuration data.
     let json_file_path = "./tests/data/mylibrary.json";
 

examples/generate_from_toml.rs

@@ -16,7 +16,7 @@
 //! use libmake::generator::generate_from_toml;
 //!
 //!     // Define the path to the TOML file containing configuration.
-//!     let toml_file_path = "./tests/data/mylibrary.toml"      
+//!     let toml_file_path = "./tests/data/mylibrary.toml"
 //!     // Generate template files based on the configuration in the TOML file.
 //!     // If generation fails, it will print an error message.
 //!     generate_from_toml(toml_file_path)
@@ -26,7 +26,7 @@
 // Import the necessary function for generating templates from a TOML file.
 use libmake::generator::generate_from_toml;
 
-fn main() {
+pub fn main() {
     // Define the path to the TOML file containing configuration.
     let toml_file_path = "./tests/data/mylibrary.toml";
 

examples/generate_from_yaml.rs

@@ -27,7 +27,7 @@
 // Import the necessary function for generating templates from a YAML file.
 use libmake::generator::generate_from_yaml;
 
-fn main() {
+pub fn main() {
     // Specify the path to the YAML file to be used for generating templates.
     let yaml_file_path = "./tests/data/mylibrary.yaml";
 

examples/get_csv_field.rs

@@ -31,7 +31,7 @@
 // Title: Test: Retrieving a CSV Field
 use libmake::utils::get_csv_field;
 
-fn main() {
+pub fn main() {
     // Retrieve CSV field
     let file_path = "../tests/data/mylibrary.csv";
     println!(

examples/get_json_field.rs

@@ -43,7 +43,7 @@
 use libmake::utils::get_json_field;
 use std::path::Path;
 
-fn main() {
+pub fn main() {
     // Retrieve JSON field
     let file_path = "../tests/data/mylibrary.json";
     let field_author = "author";

examples/get_yaml_field.rs

@@ -53,7 +53,7 @@
 use libmake::utils::get_yaml_field;
 use std::path::Path;
 
-fn main() {
+pub fn main() {
     let file_path = "../tests/data/mylibrary.yaml";
     let field_keywords = "keywords";
 

src/args.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use super::generator::{

src/ascii.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use figlet_rs::FIGfont;

src/cli.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use clap::{Arg, ArgMatches, Command, Error};

src/generator.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use super::interface::replace_placeholders;

src/interface.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use std::{

src/loggers.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 // Standard library imports for formatting and I/O operations.

src/macros.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 //! Macros for the `libmake` crate.

src/main.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 //! # Libmake Application

src/parser.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 /// A macro for getting a configuration field from a configuration file.

src/utils.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use std::env;

template/loggers.tpl

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 // Standard library imports for formatting and I/O operations.

tests/test_loggers.rs

@@ -1,4 +1,4 @@
-// Copyright © 2023 LibMake. All rights reserved.
+// Copyright © 2024 LibMake. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 #[cfg(test)]