Merge pull request #19 from devscafecommunity/2-m112-set-up-rust-project-scaffold

M1.1.2: Set up Rust project scaffold

Author: LyeZinho

.github/workflows/ci.yml

@@ -1,10 +1,7 @@
 name: CI/CD Pipeline
 
 on:
-  push:
-    branches: [main, develop]
-  pull_request:
-    branches: [main, develop]
+  workflow_dispatch:
 
 jobs:
   build:

.gitignore

@@ -63,6 +63,34 @@ Cargo.lock
 *.rlib
 *.rmeta
 
+# Rust documentation
+/target/doc/
+doc/
+
+# RustRover IDE
+.idea/
+*.iml
+
+# Procedural macro generated files
+#[derive()]
+**/*.expanded.rs
+
+# MSVC Windows builds of rustc generate these
+*.pdb
+
+# Clippy suggestions
+.clippy-warnings/
+
+# Test artifacts
+*.profraw
+*.profdata
+/tmp/
+
+# Cargo vendor directory
+vendor/
+.cargo/registry/
+.cargo/git/
+
 #=====================
 # Python Generated Files
 #=====================

.rustfmt.toml

@@ -0,0 +1,36 @@
+# Rustfmt Configuration for MiMi Project
+
+# Maximum line length
+max_width = 100
+
+# Edition
+edition = "2021"
+
+# Formatting style
+hard_tabs = false
+tab_spaces = 4
+
+# Imports
+reorder_imports = true
+reorder_modules = true
+
+# Comments
+comment_width = 80
+wrap_comments = true
+
+# Functions
+fn_args_layout = "Tall"
+fn_single_line = false
+
+# Structures
+struct_literal_style = "Block"
+struct_literal_width = 18
+struct_trailing_comma = "Vertical"
+
+# Match expressions
+match_block_trailing_comma = true
+
+# Spaces
+space_after_colon = true
+space_before_colon = false
+spaces_around_ranges = false

Cargo.toml

@@ -0,0 +1,57 @@
+[workspace]
+members = ["crates/mimi-core", "crates/mimi-cli"]
+resolver = "2"
+
+[workspace.package]
+version = "0.1.0"
+edition = "2021"
+authors = ["DevScafe Community <contact@devscafe.com>"]
+license = "MIT"
+repository = "https://github.com/devscafecommunity/mimi"
+
+[workspace.dependencies]
+tokio = { version = "1.40", features = ["full"] }
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+tracing = "0.1"
+tracing-subscriber = { version = "0.3", features = ["env-filter", "json"] }
+prost = "0.12"
+prost-build = "0.12"
+thiserror = "1.0"
+anyhow = "1.0"
+uuid = { version = "1.0", features = ["v4", "serde"] }
+chrono = { version = "0.4", features = ["serde"] }
+clap = { version = "4.5", features = ["derive"] }
+log = "0.4"
+env_logger = "0.11"
+num_cpus = "1.16"
+tokio-test = "0.4"
+
+[profile.dev]
+opt-level = 0
+debug = true
+debug-assertions = true
+overflow-checks = true
+lto = false
+panic = "unwind"
+
+[profile.release]
+opt-level = 3
+debug = false
+debug-assertions = false
+overflow-checks = false
+lto = true
+panic = "abort"
+codegen-units = 1
+
+[profile.test]
+opt-level = 1
+debug = true
+debug-assertions = true
+overflow-checks = true
+
+[profile.bench]
+opt-level = 3
+debug = false
+lto = true
+codegen-units = 1

crates/mimi-cli/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "mimi-cli"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+license.workspace = true
+repository.workspace = true
+
+[[bin]]
+name = "mimi"
+path = "src/main.rs"
+
+[dependencies]
+mimi-core = { path = "../mimi-core" }
+tokio = { workspace = true }
+clap.workspace = true
+tracing.workspace = true
+tracing-subscriber.workspace = true
+anyhow.workspace = true
+serde.workspace = true
+serde_json.workspace = true
+log.workspace = true
+env_logger.workspace = true

crates/mimi-cli/src/main.rs

@@ -0,0 +1,56 @@
+use clap::{Parser, Subcommand};
+use tracing::info;
+
+#[derive(Parser)]
+#[command(name = "mimi")]
+#[command(about = "MiMi - Multimodal Instruction Master Interface", long_about = None)]
+#[command(version)]
+struct Cli {
+    #[command(subcommand)]
+    command: Option<Commands>,
+
+    #[arg(short, long)]
+    verbose: bool,
+}
+
+#[derive(Subcommand)]
+enum Commands {
+    #[command(about = "Run the MiMi system")]
+    Run {
+        #[arg(short, long)]
+        config: Option<String>,
+    },
+    #[command(about = "Show version information")]
+    Version,
+}
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    env_logger::Builder::from_default_env()
+        .filter_level(log::LevelFilter::Info)
+        .init();
+
+    let cli = Cli::parse();
+
+    if cli.verbose {
+        info!("Verbose mode enabled");
+    }
+
+    match cli.command {
+        Some(Commands::Run { config }) => {
+            info!("Starting MiMi system");
+            if let Some(config_path) = config {
+                info!("Using config: {}", config_path);
+            }
+        }
+        Some(Commands::Version) => {
+            println!("mimi {}", env!("CARGO_PKG_VERSION"));
+        }
+        None => {
+            println!("MiMi v{}", env!("CARGO_PKG_VERSION"));
+            println!("Use --help for usage information");
+        }
+    }
+
+    Ok(())
+}

crates/mimi-core/Cargo.toml

@@ -0,0 +1,28 @@
+[package]
+name = "mimi-core"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+license.workspace = true
+repository.workspace = true
+
+[dependencies]
+tokio = { workspace = true }
+serde = { workspace = true }
+serde_json.workspace = true
+tracing.workspace = true
+tracing-subscriber.workspace = true
+prost.workspace = true
+thiserror.workspace = true
+anyhow.workspace = true
+uuid.workspace = true
+chrono.workspace = true
+log.workspace = true
+num_cpus = "1.16"
+
+[dev-dependencies]
+tokio-test = "0.4"
+
+[[test]]
+name = "integration"
+path = "tests/integration.rs"

crates/mimi-core/src/config.rs

@@ -0,0 +1,29 @@
+use serde::{Deserialize, Serialize};
+
+/// System configuration
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct Config {
+    pub log_level: String,
+    pub workers: usize,
+}
+
+impl Default for Config {
+    fn default() -> Self {
+        Self {
+            log_level: "info".to_string(),
+            workers: num_cpus::get(),
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_default_config() {
+        let cfg = Config::default();
+        assert_eq!(cfg.log_level, "info");
+        assert!(cfg.workers > 0);
+    }
+}

crates/mimi-core/src/error.rs

@@ -0,0 +1,21 @@
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum Error {
+    #[error("Configuration error: {0}")]
+    Config(String),
+
+    #[error("Message error: {0}")]
+    Message(String),
+
+    #[error("IO error: {0}")]
+    Io(#[from] std::io::Error),
+
+    #[error("Serialization error: {0}")]
+    Serialization(#[from] serde_json::Error),
+
+    #[error("Unknown error: {0}")]
+    Unknown(String),
+}
+
+pub type Result<T> = std::result::Result<T, Error>;

crates/mimi-core/src/lib.rs

@@ -0,0 +1,23 @@
+//! MiMi Core - Core system module for cognitive architecture
+//!
+//! This module contains the fundamental components and trait definitions
+//! for the MiMi cognitive operating system.
+
+pub mod error;
+pub mod message;
+pub mod config;
+
+pub use error::{Error, Result};
+
+/// Core version
+pub const VERSION: &str = env!("CARGO_PKG_VERSION");
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_version() {
+        assert!(!VERSION.is_empty());
+    }
+}