Struct Commit

pub struct Commit {
    pub title: String,
    pub description: String,
}

Fields

title: String

The title of the commit.

description: String

An exhaustive description of the changes.

Implementations

impl Commit

pub fn new(title: String, description: String) -> Self

Examples found in repository

examples/basic_usage.rs (lines 12-15)

fn main() {
    // Example of creating a commit struct
    let commit = Commit::new(
        "feat: add basic usage example".to_string(),
        "This example demonstrates how to use noob-commit programmatically and shows the basic structure of commit messages.".to_string(),
    );

    println!("Example commit title: {}", commit.title);
    println!("Example commit description: {}", commit.description);
    println!("\nFull commit message:\n{}", commit.to_string());

    // Example of checking for API key
    match env::var("OPENAI_API_KEY") {
        Ok(_) => println!("✅ OpenAI API key is set"),
        Err(_) => println!("❌ OpenAI API key is not set. Set OPENAI_API_KEY environment variable"),
    }

    println!("\nTo use noob-commit:");
    println!("1. Stage your changes: git add .");
    println!("2. Run: noob-commit");
    println!("3. Or for dry run: noob-commit --dry-run");
    println!("4. To review before commit: noob-commit --review");
}

examples/mock_commit.rs (lines 13-16)

fn main() {
    // Example commit messages for different scenarios
    let commit_examples = vec![
        Commit::new(
            "feat: add user authentication system".to_string(),
            "Implemented OAuth2 authentication with support for Google and GitHub providers. Added JWT token generation and validation for secure session management.".to_string(),
        ),
        Commit::new(
            "fix: resolve memory leak in cache handler".to_string(),
            "Fixed memory leak caused by unreleased references in the LRU cache implementation. Added proper cleanup in the destructor and improved memory management.".to_string(),
        ),
        Commit::new(
            "docs: update API documentation with new endpoints".to_string(),
            "Added comprehensive documentation for the new REST API endpoints including request/response examples, authentication requirements, and error codes.".to_string(),
        ),
        Commit::new(
            "refactor: improve error handling in database module".to_string(),
            "Refactored database error handling to use Result types consistently. Added custom error types for better error propagation and debugging.".to_string(),
        ),
        Commit::new(
            "test: add unit tests for payment processing".to_string(),
            "Added comprehensive unit tests for payment processing module covering edge cases, error scenarios, and successful payment flows.".to_string(),
        ),
    ];

    println!("Example commit messages:");
    println!("========================");
    
    for (i, commit) in commit_examples.iter().enumerate() {
        println!("\n{}. Title: {}", i + 1, commit.title);
        println!("   Description: {}", commit.description);
    }
    
    println!("\nThese are examples of well-formatted commit messages that follow conventional commit standards.");
    println!("When using noob-commit, the AI will generate similar messages based on your staged changes.");
}

Trait Implementations

impl Debug for Commit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Commit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Commit

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn always_inline_schema() -> bool

👎Deprecated: Use inline_schema() instead

Only included for backward-compatibility - use inline_schema() instead“.

impl Serialize for Commit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToString for Commit

fn to_string(&self) -> String

Converts the given value to a String.