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 2d70c25

Browse files
committed
chore(utils): rework 'multiple_line_breaker' into 'break_multiple_line'
Signed-off-by: Adrian DC <radian.dc@gmail.com>
1 parent 2759cab commit 2d70c25

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

‎commitizen/commands/commit.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
from commitizen.config import BaseConfig
1313
from commitizen.cz.exceptions import CzException
1414
from commitizen.cz.utils import (
15+
break_multiple_line,
1516
get_backup_file_path,
16-
multiple_line_breaker,
1717
required_validator,
1818
required_validator_scope,
1919
required_validator_subject_strip,
@@ -66,8 +66,8 @@ def prompt_commit_questions(self) -> str:
6666
for question in filter(
6767
lambda q: isinstance(q.get("filter", None), str), questions
6868
):
69-
if question["filter"] == "multiple_line_breaker":
70-
question["filter"] = multiple_line_breaker
69+
if question["filter"] == "break_multiple_line":
70+
question["filter"] = break_multiple_line
7171
elif question["filter"] == "required_validator":
7272
question["filter"] = required_validator
7373
elif question["filter"] == "required_validator_scope":

‎commitizen/cz/conventional_commits/conventional_commits.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
from commitizen import defaults
55
from commitizen.cz.base import BaseCommitizen
6-
from commitizen.cz.utils import multiple_line_breaker, required_validator
6+
from commitizen.cz.utils import break_multiple_line, required_validator
77
from commitizen.defaults import Questions
88

99
__all__ = ["ConventionalCommitsCz"]
@@ -129,7 +129,7 @@ def questions(self) -> Questions:
129129
"message": (
130130
"Provide additional contextual information about the code changes: (press [enter] to skip)\n"
131131
),
132-
"filter": multiple_line_breaker,
132+
"filter": break_multiple_line,
133133
},
134134
{
135135
"type": "confirm",

‎commitizen/cz/utils.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def required_validator_title_strip(
3333
return required_validator(answer.strip(".").strip(), msg)
3434

3535

36-
def multiple_line_breaker(answer: str, sep: str = "|") -> str:
36+
def break_multiple_line(answer: str, sep: str = "|") -> str:
3737
return "\n".join(line.strip() for line in answer.split(sep) if line)
3838

3939

‎docs/customization.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ commitizen:
175175
| `message` | `str` | `None` | Detail description for the question. |
176176
| `choices` | `list` | `None` | (OPTIONAL) The choices when `type = list` or `type = select`. Either use a list of values or a list of dictionaries with `name` and `value` keys. Keyboard shortcuts can be defined via `key`. See examples above. |
177177
| `default` | `Any` | `None` | (OPTIONAL) The default value for this question. |
178-
| `filter` | `str` | `None` | (OPTIONAL) Validator for user's answer. The string is the name of a `commitizen.cz.utils.NAME(answer...)` function like `multiple_line_breaker` |
178+
| `filter` | `str` | `None` | (OPTIONAL) Validator for user's answer. The string is the name of a `commitizen.cz.utils.NAME(answer...)` function like `break_multiple_line` |
179179
| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. |
180180
| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. |
181181
| `use_search_filter` | `bool` | `False` | (OPTIONAL) Enable search/filter functionality for list/select type questions. This allows users to type and filter through the choices. |

‎tests/test_cz_customize.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from commitizen.config import BaseConfig, JsonConfig, TomlConfig, YAMLConfig
66
from commitizen.cz.customize import CustomizeCommitsCz
77
from commitizen.cz.utils import (
8-
multiple_line_breaker,
8+
break_multiple_line,
99
required_validator,
1010
required_validator_scope,
1111
required_validator_subject_strip,
@@ -55,7 +55,7 @@
5555
type = "input"
5656
name = "message"
5757
message = "Body."
58-
filter = "multiple_line_breaker"
58+
filter = "break_multiple_line"
5959
6060
[[tool.commitizen.customize.questions]]
6161
type = "confirm"
@@ -115,7 +115,7 @@
115115
"type": "input",
116116
"name": "message",
117117
"message": "Body.",
118-
"filter": "multiple_line_breaker"
118+
"filter": "break_multiple_line"
119119
},
120120
{
121121
"type": "confirm",
@@ -169,7 +169,7 @@
169169
- type: input
170170
name: message
171171
message: Body.
172-
filter: multiple_line_breaker
172+
filter: break_multiple_line
173173
- type: confirm
174174
name: show_message
175175
message: Do you want to add body message in commit?
@@ -504,7 +504,7 @@ def test_questions_default(config):
504504
"type": "input",
505505
"name": "message",
506506
"message": "Body.",
507-
"filter": "multiple_line_breaker",
507+
"filter": "break_multiple_line",
508508
},
509509
{
510510
"type": "confirm",
@@ -542,7 +542,7 @@ def test_questions_filter_default(config, mocker: MockFixture):
542542
assert prompts_questions[1]["filter"] == required_validator_subject_strip
543543
assert prompts_questions[2]["type"] == "input"
544544
assert prompts_questions[2]["name"] == "message"
545-
assert prompts_questions[2]["filter"] == multiple_line_breaker
545+
assert prompts_questions[2]["filter"] == break_multiple_line
546546
assert prompts_questions[3]["type"] == "confirm"
547547
assert prompts_questions[3]["name"] == "show_message"
548548

@@ -568,7 +568,7 @@ def test_questions_filter_values(config_filters, mocker: MockFixture):
568568
assert isinstance(commit_cmd.cz, CustomizeCommitsCz)
569569

570570
for filter_desc in [
571-
("multiple_line_breaker", multiple_line_breaker),
571+
("break_multiple_line", break_multiple_line),
572572
("required_validator", required_validator),
573573
("required_validator_scope", required_validator_scope),
574574
("required_validator_subject_strip", required_validator_subject_strip),

‎tests/test_cz_utils.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ def test_required_validator():
1111
utils.required_validator("")
1212

1313

14-
def test_multiple_line_breaker():
14+
def test_break_multiple_line():
1515
message = "this is the first line | and this is the second line "
16-
result = utils.multiple_line_breaker(message)
16+
result = utils.break_multiple_line(message)
1717
assert result == "this is the first line\nand this is the second line"
1818

19-
result = utils.multiple_line_breaker(message, "is")
19+
result = utils.break_multiple_line(message, "is")
2020
assert result == "th\n\nthe first line | and th\n\nthe second line"
2121

2222

0 commit comments

Comments
(0)

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