commit-wizard 0.0.2

A lightweight CLI assistant for Conventional Commits, semantic versioning, and changelog automation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

//
// ──────────────────────────────────────────────────────────────────────────────
// General
// ──────────────────────────────────────────────────────────────────────────────
//

use crate::engine::models::policy::enforcement::{
    AiProvider, BumpLevel, ChangelogFormat, CommitEnforcementScope, ScopeMode, TicketSource,
};

pub const CONFIG_VERSION: u32 = 1;

pub const DEFAULT_COMMIT_BUMP: BumpLevel = BumpLevel::Patch;
//
// ──────────────────────────────────────────────────────────────────────────────
// Commit
// ──────────────────────────────────────────────────────────────────────────────
//

pub const COMMIT_SUBJECT_MAX_LENGTH: u32 = 72;
pub const COMMIT_USE_EMOJIS: bool = false;

pub const COMMIT_SCOPE_MODE: ScopeMode = ScopeMode::Optional;
pub const COMMIT_SCOPE_RESTRICT_TO_DEFINED: bool = false;

pub const COMMIT_BREAKING_REQUIRE_HEADER: bool = false;
pub const COMMIT_BREAKING_REQUIRE_FOOTER: bool = false;
pub const COMMIT_BREAKING_FOOTER_KEY: &str = "BREAKING CHANGE";

pub const COMMIT_TICKET_ENABLED: bool = false;
pub const COMMIT_TICKET_REQUIRED: bool = false;
pub const COMMIT_TICKET_SOURCE: TicketSource = TicketSource::Disabled;

pub const COMMIT_PROTECTED_ALLOW: bool = true;
pub const COMMIT_PROTECTED_FORCE: bool = false;
pub const COMMIT_PROTECTED_WARN: bool = true;

//
// ──────────────────────────────────────────────────────────────────────────────
// Branch
// ──────────────────────────────────────────────────────────────────────────────
//

pub const BRANCH_REMOTE: &str = "origin";
pub const BRANCH_NAMING_PATTERN: &str = "feature/{issue}";
pub const BRANCH_NAMING_ENFORCE: bool = false;

//
// ──────────────────────────────────────────────────────────────────────────────
// PR
// ──────────────────────────────────────────────────────────────────────────────
//

pub const PR_ENABLED: bool = true;

//
// ──────────────────────────────────────────────────────────────────────────────
// Check
// ──────────────────────────────────────────────────────────────────────────────
//

pub const CHECK_REQUIRE_CONVENTIONAL: bool = true;
pub const CHECK_COMMITS_ENABLED: bool = true;
pub const CHECK_COMMITS_ENFORCE_ON: CommitEnforcementScope =
    CommitEnforcementScope::ProtectedBranches;

//
// ──────────────────────────────────────────────────────────────────────────────
// Push
// ──────────────────────────────────────────────────────────────────────────────
//

pub const PUSH_ALLOW_PROTECTED: bool = false;
pub const PUSH_ALLOW_FORCE: bool = false;

pub const PUSH_CHECK_COMMITS: bool = true;
pub const PUSH_CHECK_BRANCH_POLICY: bool = true;

//
// ──────────────────────────────────────────────────────────────────────────────
// Versioning
// ──────────────────────────────────────────────────────────────────────────────
//

pub const VERSIONING_TAG_PREFIX: &str = "v";

//
// ──────────────────────────────────────────────────────────────────────────────
// Changelog
// ──────────────────────────────────────────────────────────────────────────────
//

pub const CHANGELOG_OUTPUT: &str = "CHANGELOG.md";
pub const CHANGELOG_FORMAT: ChangelogFormat = ChangelogFormat::Markdown;
pub const CHANGELOG_SHOW_SCOPE: bool = true;
pub const CHANGELOG_SHOW_EMPTY_SECTIONS: bool = false;
pub const CHANGELOG_SHOW_EMPTY_SCOPES: bool = false;
pub const CHANGELOG_MISC_SECTION: &str = "Miscellaneous";

//
// ──────────────────────────────────────────────────────────────────────────────
// Release
// ──────────────────────────────────────────────────────────────────────────────
//

pub const RELEASE_ENABLED: bool = false;
pub const RELEASE_SOURCE_BRANCH: &str = "main";
pub const RELEASE_TARGET_BRANCH: &str = "main";
pub const RELEASE_BRANCH_FORMAT: &str = "release/{version}";
pub const RELEASE_HOTFIX_PATTERN: &str = "hotfix/*";

pub const RELEASE_REQUIRE_CLEAN_WORKTREE: bool = true;
pub const RELEASE_FAIL_IF_TAG_EXISTS: bool = true;
pub const RELEASE_FAIL_IF_RELEASE_BRANCH_EXISTS: bool = true;

pub const RELEASE_FINISH_TAG: bool = true;
pub const RELEASE_FINISH_PUSH: bool = true;
pub const RELEASE_FINISH_BACKMERGE_BRANCH: &str = "main";

//
// ──────────────────────────────────────────────────────────────────────────────
// Hooks
// ──────────────────────────────────────────────────────────────────────────────
//

pub const HOOKS_PRE_COMMIT: bool = false;
pub const HOOKS_COMMIT_MSG: bool = false;
pub const HOOKS_PRE_PUSH: bool = false;

//
// ──────────────────────────────────────────────────────────────────────────────
// AI
// ──────────────────────────────────────────────────────────────────────────────
//

pub const AI_ENABLED: bool = false;
pub const AI_PROVIDER: AiProvider = AiProvider::Copilot;

pub const AI_COMMAND_COMMIT: bool = false;
pub const AI_COMMAND_CHANGELOG: bool = false;
pub const AI_COMMAND_RELEASE_PREPARE: bool = false;

//
// ──────────────────────────────────────────────────────────────────────────────
// Registry
// ──────────────────────────────────────────────────────────────────────────────
//

pub const REGISTRY_DEFAULT_REF: &str = "main";