git.h

Go to the documentation of this file.

#pragma once
 
#include <optional>
#include <string>
 
#include "faker-cxx/export.h"
#include "faker-cxx/types/locale.h"
 
namespace faker::git
{
struct FAKER_CXX_EXPORT Author
{
    std::string name;
    std::string email;
};
 
enum class BranchIssueType
{
    WithoutIssueNumber,
    WithIssueNumber,
};

FAKER_CXX_EXPORT std::string branch(std::optional<BranchIssueType> issueType = std::nullopt,
                                    unsigned maxIssueNum = 100);

FAKER_CXX_EXPORT std::string commitDate(unsigned years = 15);

FAKER_CXX_EXPORT std::string commitEntry(std::optional<unsigned> dateYears = std::nullopt,
                                         std::optional<unsigned> shaLength = std::nullopt,
                                         Locale locale = Locale::en_US);

FAKER_CXX_EXPORT std::string commitMessage();

FAKER_CXX_EXPORT std::string commitSha(unsigned length = 40);
}