CommitMessageGenerator Class Reference

#include <CommitMessageGenerator.h>

Classes
class	Result

Public Member Functions
	CommitMessageGenerator ()=default
Result	generate (std::string const &diff, QString const &hint={})
	Generate a commit message using the given diff. More...

Static Public Member Functions
static std::string	diff_head (GitRunner g)
static Result	Error (std::string const &status, std::string const &message)

Private Member Functions
CommitMessageGenerator::Result	parse_response (const std::string &in, GenerativeAI::AI provider)
	Parse the response from the AI model. More...
std::string	generatePrompt (const std::string &diff, int max)
	Generate a prompt for the given diff. More...
std::string	generate_prompt_json (const GenerativeAI::Model &model, const std::string &prompt)

Constructor & Destructor Documentation

CommitMessageGenerator()

CommitMessageGenerator::CommitMessageGenerator ( )

default

Member Function Documentation

diff_head()

std::string CommitMessageGenerator::diff_head ( GitRunner  g )

static

Here is the call graph for this function:

Error()

static Result CommitMessageGenerator::Error ( std::string const &  status, std::string const &  message  )

inlinestatic

generate()

CommitMessageGenerator::Result CommitMessageGenerator::generate	(	std::string const &	diff,
		QString const &	hint = {}
	)

Generate a commit message using the given diff.

Parameters

g	The Git object.

Returns

The generated commit message.

Here is the call graph for this function:

generate_prompt_json()

std::string CommitMessageGenerator::generate_prompt_json ( const GenerativeAI::Model &  model, const std::string &  prompt  )

private

Here is the call graph for this function:

generatePrompt()

std::string CommitMessageGenerator::generatePrompt ( const std::string &  diff, int  max  )

private

Generate a prompt for the given diff.

Parameters

diff	The diff.
max	The maximum number of messages to generate.

Returns

The prompt.

parse_response()

CommitMessageGenerator::Result CommitMessageGenerator::parse_response ( const std::string &  in, GenerativeAI::AI  provider  )

private

Parse the response from the AI model.

Parameters

in	The response.
ai_type	The AI model type.

Returns

The generated commit message.

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• /Guitar/src/CommitMessageGenerator.h
• /Guitar/src/CommitMessageGenerator.cpp