WIP: Configuration from environnement variables & build time Rules struct generation

cli/Cargo.toml

@@ -21,14 +21,26 @@ clap = { version = "4.5.4", features = ["derive", "env", "string"] }
 futures = "0.3.30"
 regex = "1.10.5"
 schemars = { version = "1.0.0-alpha.16", optional = true }
+config = { version = "0.14.1", optional = true }
 serde = { version = "1.0.201", features = ["derive"] }
 serde_json = "1.0.121"
 serde_yaml = "0.9.34"
+serde_with = { version = "3.11.0", features = ["macros"] }
 tokio = { version = "1.37.0", features = ["full"] }
+rsmack-wrap = { path = "../../rsmack/packages/rsmack-wrap" }
+[build-dependencies]
+serde_with = { version = "3.11.0", features = ["macros"] }
+rsmack-fs = { path = "../../rsmack/packages/rsmack-fs" }
+rsmack-utils = { path = "../../rsmack/packages/rsmack-utils" }
+rsmack-wrap = { path = "../../rsmack/packages/rsmack-wrap" }
+schemars = { version = "1.0.0-alpha.16", optional = true }
+quote = "1.0.37"
+serde = { version = "1.0.201", features = ["derive"] }
 
 [features]
 schemars = ["dep:schemars"]
-default = []
+config = ["dep:config"]
+default = ["config"]
 
 [package.metadata.binstall]
 pkg-url = "{ repo }/releases/download/v{ version }/commitlint-v{ version }-{ target }{ archive-suffix }"

cli/build.rs

@@ -0,0 +1,12 @@
+#[rsmack_fs::folder_iso_struct(from_crate = cli, folder = rule)]
+#[rsmack_wrap::wrap(with = Option)]
+#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+#[serde(rename_all = "kebab-case")]
+#[serde_with::apply(Option => #[serde(skip_serializing_if = "Option::is_none")])]
+/// Rules represents the rules of commitlint.
+/// See: [rules documentation](https://commitlint.js.org/reference/rules.html)
+pub struct Rules {}
+fn main() {
+    Rules::generate();
+}

cli/json-schema/config.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Config",
+  "title": "Settings",
   "description": "Config represents the configuration of commitlint.",
   "type": "object",
   "properties": {

cli/src/args.rs

@@ -87,8 +87,12 @@ impl Args {
         }
 
         let default_path = std::path::PathBuf::from(".git").join("COMMIT_EDITMSG");
-        let msg = std::fs::read_to_string(&default_path).unwrap_or_else(|_| panic!("Failed to read commit message from {}",
-                default_path.display()));
+        let msg = std::fs::read_to_string(&default_path).unwrap_or_else(|_| {
+            panic!(
+                "Failed to read commit message from {}",
+                default_path.display()
+            )
+        });
         Ok(vec![Message::new(msg)])
     }
 }

cli/src/lib.rs

@@ -1,5 +1,6 @@
-pub mod config;
 pub mod git;
 pub mod message;
 pub mod result;
 pub mod rule;
+pub mod rules;
+pub mod settings;

cli/src/main.rs

@@ -1,10 +1,10 @@
 mod args;
-mod config;
 mod git;
 mod message;
 mod result;
 mod rule;
-
+mod rules;
+mod settings;
 use args::Args;
 use clap::Parser;
 use message::validate;
@@ -15,7 +15,7 @@ use std::process::exit;
 async fn main() {
     let args = Args::parse();
 
-    let config = match config::load(args.config.clone()).await {
+    let settings = match settings::load(args.config.clone()).await {
         Ok(c) => c,
         Err(err) => {
             eprintln!("Failed to load config: {}", err);
@@ -24,7 +24,7 @@ async fn main() {
     };
 
     if args.print_config {
-        println!("{}", config);
+        println!("{}", settings);
     }
 
     let messages = match args.read() {
@@ -38,7 +38,7 @@ async fn main() {
     let threads = messages
         .into_iter()
         .map(|message| {
-            let config = config.clone();
+            let config = settings.clone();
             tokio::spawn(async move { validate(&message, &config).await })
         })
         .collect::<Vec<_>>();
@@ -55,11 +55,11 @@ async fn main() {
             if !h.violations.is_empty() {
                 for violation in &h.violations {
                     match violation.level {
-                        rule::Level::Error => {
+                        rules::Level::Error => {
                             eprintln!("{}", violation.message);
                             has_error = true
                         }
-                        rule::Level::Warning => {
+                        rules::Level::Warning => {
                             println!("{}", violation.message);
                         }
                         _ => {}

cli/src/message.rs

@@ -1,7 +1,7 @@
 use crate::{
-    config::Config,
     git::{parse_commit_message, parse_subject},
     result::Result as LintResult,
+    settings::Settings,
 };
 use std::{collections::HashMap, fmt::Error};
 
@@ -59,7 +59,8 @@ impl Message {
 }
 
 /// validate the raw commit message.
-pub async fn validate(msg: &Message, config: &Config) -> Result<LintResult, Error> {
-    let violations = config.rules.validate(msg);
+pub async fn validate(msg: &Message, settings: &Settings) -> Result<LintResult, Error> {
+    let violations = settings.rules.validate(msg);
+
     Ok(LintResult { violations })
 }

cli/src/result.rs

@@ -1,4 +1,4 @@
-use crate::rule::Level;
+use crate::rules::Level;
 
 /// Result of the check.
 #[derive(Clone, Debug)]

cli/src/rule/body_empty.rs

@@ -1,5 +1,5 @@
-use super::Level;
-use crate::{make_rule, message::Message, result::Violation, rule::Rule};
+use crate::rules::Level;
+use crate::{make_rule, message::Message, result::Violation, rules::Rule};
 
 make_rule! {
     BodyEmpty,

cli/src/rule/body_max_length.rs

@@ -1,6 +1,6 @@
-use crate::{make_length_rule, message::Message, result::Violation, rule::Rule};
+use crate::{make_length_rule, message::Message, result::Violation, rules::Rule};
 
-use super::Level;
+use crate::rules::Level;
 make_length_rule! {
     BodyMaxLength,
     "body"

cli/src/rule/description_empty.rs

@@ -1,6 +1,6 @@
-use crate::{make_rule, message::Message, result::Violation, rule::Rule};
+use crate::{make_rule, message::Message, result::Violation, rules::Rule};
 
-use super::Level;
+use crate::rules::Level;
 make_rule! {
     DescriptionEmpty,
 }

cli/src/rule/description_format.rs

@@ -1,5 +1,5 @@
-use super::Level;
-use crate::{make_format_rule, message::Message, result::Violation, rule::Rule};
+use crate::rules::Level;
+use crate::{make_format_rule, message::Message, result::Violation, rules::Rule};
 
 make_format_rule! {
     DescriptionFormat,

cli/src/rule/description_max_length.rs

@@ -1,6 +1,6 @@
-use crate::{make_length_rule, message::Message, result::Violation, rule::Rule};
+use crate::{make_length_rule, message::Message, result::Violation, rules::Rule};
 
-use super::Level;
+use crate::rules::Level;
 
 make_length_rule! {
     DescriptionMaxLength,

cli/src/rule/footers_empty.rs

@@ -1,6 +1,6 @@
-use crate::{make_rule, message::Message, result::Violation, rule::Rule};
+use crate::{make_rule, message::Message, result::Violation, rules::Rule};
 
-use super::Level;
+use crate::rules::Level;
 make_rule! {
     FootersEmpty,
 }

cli/src/rule/mod.rs

@@ -0,0 +1,15 @@
+pub mod body_empty;
+pub mod body_max_length;
+pub mod description_empty;
+pub mod description_format;
+pub mod description_max_length;
+pub mod footers_empty;
+pub mod scope;
+pub mod scope_empty;
+pub mod scope_format;
+pub mod scope_max_length;
+pub mod subject_empty;
+pub mod r#type;
+pub mod type_empty;
+pub mod type_format;
+pub mod type_max_length;

cli/src/rule/scope.rs

@@ -1,5 +1,5 @@
-use super::Level;
-use crate::{make_options_rule, message::Message, result::Violation, rule::Rule};
+use crate::rules::Level;
+use crate::{make_options_rule, message::Message, result::Violation, rules::Rule};
 
 make_options_rule! {
     Scope,

cli/src/rule/scope_empty.rs

@@ -1,5 +1,5 @@
-use super::Level;
-use crate::{make_rule, message::Message, result::Violation, rule::Rule};
+use crate::rules::Level;
+use crate::{make_rule, message::Message, result::Violation, rules::Rule};
 
 make_rule! {
     ScopeEmpty,

cli/src/rule/scope_format.rs

@@ -1,6 +1,6 @@
-use crate::{make_format_rule, message::Message, result::Violation, rule::Rule};
+use crate::{make_format_rule, message::Message, result::Violation, rules::Rule};
 
-use super::Level;
+use crate::rules::Level;
 make_format_rule! {
     ScopeFormat,
     "scope"

cli/src/rule/scope_max_length.rs

@@ -1,5 +1,5 @@
-use super::Level;
-use crate::{make_length_rule, message::Message, result::Violation, rule::Rule};
+use crate::rules::Level;
+use crate::{make_length_rule, message::Message, result::Violation, rules::Rule};
 
 make_length_rule! {
     ScopeMaxLength,

cli/src/rule/subject_empty.rs

@@ -1,6 +1,6 @@
-use crate::{make_rule, message::Message, result::Violation, rule::Rule};
+use crate::{make_rule, message::Message, result::Violation, rules::Rule};
 
-use super::Level;
+use crate::rules::Level;
 
 make_rule! {
     SubjectEmpty,

cli/src/rule/type.rs

@@ -1,6 +1,6 @@
-use crate::{make_options_rule, message::Message, result::Violation, rule::Rule};
+use crate::{make_options_rule, message::Message, result::Violation, rules::Rule};
 
-use super::Level;
+use crate::rules::Level;
 make_options_rule! {
     Type,
     "type",