Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 440a7fa

Browse files
author
amitlevy21
committed
feat(ConventionalCommitsCz): allow to override defaults from config
As addressed on #535, when using customize commitizen, if we want to customize a small attribute, we need to redefine all commitizens options to make our custom class work. For example: ```diff diff --git a/cz.yaml b/cz.yaml index f2e19a9..302e961 100644 --- a/cz.yaml +++ b/cz.yaml @@ -1,6 +1,18 @@ commitizen: annotated_tag: true bump_message: 'bump: $current_version -> $new_version [skip ci]' - name: cz_conventional_commits + name: cz_customize update_changelog_on_bump: true version: 0.11.0 + + customize: + bump_pattern: '^(fix|feat|docs|style|refactor|test|build|ci)' + bump_map: + fix: PATCH + feat: PATCH + docs: PATCH + style: PATCH + refactor: PATCH + test: PATCH + build: PATCH + ci: PATCH diff --git a/t b/t new file mode 100644 index 0000000..e69de29 diff --git a/t2 b/t2 new file mode 100644 index 0000000..e69de29 ``` making the following change on a repo would cause an unexpected behavior: ```python + bash -c cz commit Traceback (most recent call last): File "/home/amit/.local/bin/cz", line 8, in <module> sys.exit(main()) File "/home/amit/.local/lib/python3.10/site-packages/commitizen/cli.py", line 382, in main args.func(conf, vars(args))() File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 74, in __call__ m = self.prompt_commit_questions() File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 49, in prompt_commit_questions for question in filter(lambda q: q["type"] == "list", questions): File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 49, in <lambda> for question in filter(lambda q: q["type"] == "list", questions): KeyError: 'type' ``` From my best understanding, this error happens because I didn't defined question section in config, though I'm ok with using ConventionalCommitsCz default ones. This commit extends ConventionalCommitsCz to read from config and fallbacks to defaults if some are not provided. By adding this change, potentially customize commitizen can be deprecated. Closes #535.
1 parent 2ff9f15 commit 440a7fa

File tree

6 files changed

+117
-75
lines changed

6 files changed

+117
-75
lines changed

‎commitizen/cz/base.py

Lines changed: 25 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,14 @@
11
from abc import ABCMeta, abstractmethod
2-
from typing import Callable, Dict, List, Optional, Tuple
2+
from typing import Callable, Dict, List, Optional
33

4-
from prompt_toolkit.styles import Style, merge_styles
4+
from prompt_toolkit.styles import Style
55

6-
from commitizen import git
6+
from commitizen import defaults, git
77
from commitizen.config.base_config import BaseConfig
88
from commitizen.defaults import Questions
99

1010

1111
class BaseCommitizen(metaclass=ABCMeta):
12-
bump_pattern: Optional[str] = None
13-
bump_map: Optional[Dict[str, str]] = None
14-
default_style_config: List[Tuple[str, str]] = [
15-
("qmark", "fg:#ff9d00 bold"),
16-
("question", "bold"),
17-
("answer", "fg:#ff9d00 bold"),
18-
("pointer", "fg:#ff9d00 bold"),
19-
("highlighted", "fg:#ff9d00 bold"),
20-
("selected", "fg:#cc5454"),
21-
("separator", "fg:#cc5454"),
22-
("instruction", ""),
23-
("text", ""),
24-
("disabled", "fg:#858585 italic"),
25-
]
26-
27-
# The whole subject will be parsed as message by default
28-
# This allows supporting changelog for any rule system.
29-
# It can be modified per rule
30-
commit_parser: Optional[str] = r"(?P<message>.*)"
31-
changelog_pattern: Optional[str] = r".*"
32-
change_type_map: Optional[Dict[str, str]] = None
33-
change_type_order: Optional[List[str]] = None
34-
3512
# Executed per message parsed by the commitizen
3613
changelog_message_builder_hook: Optional[
3714
Callable[[Dict, git.GitCommit], Dict]
@@ -42,8 +19,28 @@ class BaseCommitizen(metaclass=ABCMeta):
4219

4320
def __init__(self, config: BaseConfig):
4421
self.config = config
45-
if not self.config.settings.get("style"):
46-
self.config.settings.update({"style": BaseCommitizen.default_style_config})
22+
self.style = Style(self.config.settings.get("style", defaults.style))
23+
self.bump_pattern: Optional[str] = self.config.settings.get(
24+
"bump_pattern", defaults.bump_pattern
25+
)
26+
self.bump_map: Optional[Dict[str, str]] = self.config.settings.get(
27+
"bump_map", defaults.bump_map
28+
)
29+
self.change_type_order: Optional[List[str]] = self.config.settings.get(
30+
"change_type_order", defaults.change_type_order
31+
)
32+
self.change_type_map: Optional[Dict[str, str]] = self.config.settings.get(
33+
"change_type_map", defaults.change_type_map
34+
)
35+
self.commit_parser: Optional[str] = self.config.settings.get(
36+
"commit_parser", defaults.commit_parser
37+
)
38+
self.changelog_pattern: Optional[str] = self.config.settings.get(
39+
"changelog_pattern", defaults.changelog_pattern
40+
)
41+
self.version_parser = self.config.settings.get(
42+
"version_parser", defaults.version_parser
43+
)
4744

4845
@abstractmethod
4946
def questions(self) -> Questions:
@@ -53,15 +50,6 @@ def questions(self) -> Questions:
5350
def message(self, answers: dict) -> str:
5451
"""Format your git message."""
5552

56-
@property
57-
def style(self):
58-
return merge_styles(
59-
[
60-
Style(BaseCommitizen.default_style_config),
61-
Style(self.config.settings["style"]),
62-
]
63-
)
64-
6553
def example(self) -> Optional[str]:
6654
"""Example of the commit message."""
6755
raise NotImplementedError("Not Implemented yet")

‎commitizen/cz/conventional_commits/conventional_commits.py

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
import os
22
import re
33

4-
from commitizen import defaults
4+
try:
5+
from jinja2 import Template
6+
except ImportError:
7+
from string import Template # type: ignore
8+
59
from commitizen.cz.base import BaseCommitizen
610
from commitizen.cz.utils import multiple_line_breaker, required_validator
711
from commitizen.defaults import Questions
@@ -28,18 +32,6 @@ def parse_subject(text):
2832

2933

3034
class ConventionalCommitsCz(BaseCommitizen):
31-
bump_pattern = defaults.bump_pattern
32-
bump_map = defaults.bump_map
33-
commit_parser = defaults.commit_parser
34-
version_parser = defaults.version_parser
35-
change_type_map = {
36-
"feat": "Feat",
37-
"fix": "Fix",
38-
"refactor": "Refactor",
39-
"perf": "Perf",
40-
}
41-
changelog_pattern = defaults.bump_pattern
42-
4335
def questions(self) -> Questions:
4436
questions: Questions = [
4537
{
@@ -148,9 +140,20 @@ def questions(self) -> Questions:
148140
),
149141
},
150142
]
151-
return questions
143+
144+
return self.config.settings.get("questions", questions)
152145

153146
def message(self, answers: dict) -> str:
147+
custom_message = self.config.settings.get("message_template")
148+
if custom_message:
149+
message_template = Template(
150+
str(self.config.settings.get("message_template", ""))
151+
)
152+
if getattr(Template, "substitute", None):
153+
return message_template.substitute(**answers) # type: ignore
154+
else:
155+
return message_template.render(**answers)
156+
154157
prefix = answers["prefix"]
155158
scope = answers["scope"]
156159
subject = answers["subject"]
@@ -172,32 +175,36 @@ def message(self, answers: dict) -> str:
172175
return message
173176

174177
def example(self) -> str:
175-
return (
176-
"fix: correct minor typos in code\n"
177-
"\n"
178-
"see the issue for details on the typos fixed\n"
179-
"\n"
180-
"closes issue #12"
178+
return str(
179+
self.config.settings.get(
180+
"example",
181+
"fix: correct minor typos in code\n"
182+
"\n"
183+
"see the issue for details on the typos fixed\n"
184+
"\n"
185+
"closes issue #12",
186+
)
181187
)
182188

183189
def schema(self) -> str:
184-
return (
190+
return self.config.settings.get(
191+
"schema",
185192
"<type>(<scope>): <subject>\n"
186193
"<BLANK LINE>\n"
187194
"<body>\n"
188195
"<BLANK LINE>\n"
189-
"(BREAKING CHANGE: )<footer>"
196+
"(BREAKING CHANGE: )<footer>",
190197
)
191198

192199
def schema_pattern(self) -> str:
193200
PATTERN = (
194-
r"(?s)" # To explictly make . match new line
201+
r"(?s)" # To explicitly make . match new line
195202
r"(build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)" # type
196203
r"(\(\S+\))?!?:" # scope
197204
r"( [^\n\r]+)" # subject
198205
r"((\n\n.*)|(\s*))?$"
199206
)
200-
return PATTERN
207+
return self.config.settings.get("schema_pattern", PATTERN)
201208

202209
def info(self) -> str:
203210
dir_path = os.path.dirname(os.path.realpath(__file__))

‎commitizen/cz/jira/jira.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
import os
22

3+
from commitizen.config.base_config import BaseConfig
34
from commitizen.cz.base import BaseCommitizen
45
from commitizen.defaults import Questions
56

67
__all__ = ["JiraSmartCz"]
78

89

910
class JiraSmartCz(BaseCommitizen):
11+
def __init__(self, config: BaseConfig):
12+
super().__init__(config)
13+
self.bump_map = None
14+
self.bump_pattern = None
15+
self.commit_parser = r"(?P<message>.*)"
16+
self.changelog_pattern = r".*"
17+
1018
def questions(self) -> Questions:
1119
questions = [
1220
{

‎commitizen/defaults.py

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,23 @@ class Settings(TypedDict, total=False):
3131
version_files: List[str]
3232
tag_format: Optional[str]
3333
bump_message: Optional[str]
34+
bump_pattern: Optional[str]
35+
bump_map: Optional[Dict[str, str]]
3436
allow_abort: bool
3537
changelog_file: str
3638
changelog_incremental: bool
3739
changelog_start_rev: Optional[str]
40+
changelog_pattern: Optional[str]
3841
update_changelog_on_bump: bool
3942
use_shortcuts: bool
40-
style: Optional[List[Tuple[str, str]]]
43+
style: List[Tuple[str, str]]
4144
customize: CzSettings
45+
change_type_order: Optional[List[str]]
46+
change_type_map: Optional[Dict[str, str]]
47+
commit_parser: Optional[str]
48+
schema: str
49+
schema_pattern: str
50+
questions: Questions
4251

4352

4453
name: str = "cz_conventional_commits"
@@ -80,10 +89,32 @@ class Settings(TypedDict, total=False):
8089
(r"^perf", PATCH),
8190
)
8291
)
83-
change_type_order= ["BREAKING CHANGE", "feat", "fix", "refactor", "perf"]
92+
change_type_order: Optional[List[str]] =None
8493

8594
bump_message = "bump: version $current_version → $new_version"
8695

8796

8897
commit_parser = r"^(?P<change_type>feat|fix|refactor|perf|BREAKING CHANGE)(?:\((?P<scope>[^()\r\n]*)\)|\()?(?P<breaking>!)?:\s(?P<message>.*)?" # noqa
8998
version_parser = r"(?P<version>([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?(\w+)?)"
99+
100+
change_type_map = {
101+
"feat": "Feat",
102+
"fix": "Fix",
103+
"refactor": "Refactor",
104+
"perf": "Perf",
105+
}
106+
107+
changelog_pattern = bump_pattern
108+
109+
style: List[Tuple[str, str]] = [
110+
("qmark", "fg:#ff9d00 bold"),
111+
("question", "bold"),
112+
("answer", "fg:#ff9d00 bold"),
113+
("pointer", "fg:#ff9d00 bold"),
114+
("highlighted", "fg:#ff9d00 bold"),
115+
("selected", "fg:#cc5454"),
116+
("separator", "fg:#cc5454"),
117+
("instruction", ""),
118+
("text", ""),
119+
("disabled", "fg:#858585 italic"),
120+
]

‎tests/test_bump_find_increment.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import pytest
66

77
from commitizen import bump
8+
from commitizen.config.base_config import BaseConfig
89
from commitizen.cz import ConventionalCommitsCz
910
from commitizen.git import GitCommit
1011

@@ -72,11 +73,12 @@
7273
),
7374
)
7475
def test_find_increment(messages, expected_type):
76+
cz = ConventionalCommitsCz(BaseConfig())
7577
commits = [GitCommit(rev="test", title=message) for message in messages]
7678
increment_type = bump.find_increment(
7779
commits,
78-
regex=ConventionalCommitsCz.bump_pattern,
79-
increments_map=ConventionalCommitsCz.bump_map,
80+
regex=cz.bump_pattern,
81+
increments_map=cz.bump_map,
8082
)
8183
assert increment_type == expected_type
8284

‎tests/test_changelog.py

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import pytest
22

33
from commitizen import changelog, defaults, git
4+
from commitizen.config.base_config import BaseConfig
45
from commitizen.cz.conventional_commits.conventional_commits import (
56
ConventionalCommitsCz,
67
)
@@ -844,8 +845,9 @@ def test_order_changelog_tree_raises():
844845

845846

846847
def test_render_changelog(gitcommits, tags, changelog_content):
847-
parser = ConventionalCommitsCz.commit_parser
848-
changelog_pattern = ConventionalCommitsCz.bump_pattern
848+
cz = ConventionalCommitsCz(BaseConfig())
849+
parser = cz.commit_parser
850+
changelog_pattern = cz.bump_pattern
849851
tree = changelog.generate_tree_from_commits(
850852
gitcommits, tags, parser, changelog_pattern
851853
)
@@ -854,9 +856,10 @@ def test_render_changelog(gitcommits, tags, changelog_content):
854856

855857

856858
def test_render_changelog_unreleased(gitcommits):
859+
cz = ConventionalCommitsCz(BaseConfig())
857860
some_commits = gitcommits[:7]
858-
parser = ConventionalCommitsCz.commit_parser
859-
changelog_pattern = ConventionalCommitsCz.bump_pattern
861+
parser = cz.commit_parser
862+
changelog_pattern = cz.bump_pattern
860863
tree = changelog.generate_tree_from_commits(
861864
some_commits, [], parser, changelog_pattern
862865
)
@@ -869,9 +872,10 @@ def test_render_changelog_tag_and_unreleased(gitcommits, tags):
869872
single_tag = [
870873
tag for tag in tags if tag.rev == "56c8a8da84e42b526bcbe130bd194306f7c7e813"
871874
]
875+
cz = ConventionalCommitsCz(BaseConfig())
872876

873-
parser = ConventionalCommitsCz.commit_parser
874-
changelog_pattern = ConventionalCommitsCz.bump_pattern
877+
parser = cz.commit_parser
878+
changelog_pattern = cz.bump_pattern
875879
tree = changelog.generate_tree_from_commits(
876880
some_commits, single_tag, parser, changelog_pattern
877881
)
@@ -882,10 +886,11 @@ def test_render_changelog_tag_and_unreleased(gitcommits, tags):
882886

883887

884888
def test_render_changelog_with_change_type(gitcommits, tags):
889+
cz = ConventionalCommitsCz(BaseConfig())
885890
new_title = ":some-emoji: feature"
886891
change_type_map = {"feat": new_title}
887-
parser = ConventionalCommitsCz.commit_parser
888-
changelog_pattern = ConventionalCommitsCz.bump_pattern
892+
parser = cz.commit_parser
893+
changelog_pattern = cz.bump_pattern
889894
tree = changelog.generate_tree_from_commits(
890895
gitcommits, tags, parser, changelog_pattern, change_type_map=change_type_map
891896
)
@@ -900,8 +905,9 @@ def changelog_message_builder_hook(message: dict, commit: git.GitCommit) -> dict
900905
] = f"{message['message']} [link](github.com/232323232) {commit.author} {commit.author_email}"
901906
return message
902907

903-
parser = ConventionalCommitsCz.commit_parser
904-
changelog_pattern = ConventionalCommitsCz.bump_pattern
908+
cz = ConventionalCommitsCz(BaseConfig())
909+
parser = cz.commit_parser
910+
changelog_pattern = cz.bump_pattern
905911
tree = changelog.generate_tree_from_commits(
906912
gitcommits,
907913
tags,

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /