From b31f5f7daafb9a139e6c6cc35f3a6dc5738f19ec Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Tue, 13 Aug 2024 17:35:37 +0200 Subject: [PATCH 1/8] test(cz_customize): add missing YAML configuration file tests Signed-off-by: Adrian DC --- tests/test_cz_customize.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py index 933b1aa065..6001152709 100644 --- a/tests/test_cz_customize.py +++ b/tests/test_cz_customize.py @@ -321,6 +321,7 @@ params=[ TomlConfig(data=TOML_STR, path="not_exist.toml"), JsonConfig(data=JSON_STR, path="not_exist.json"), + YAMLConfig(data=YAML_STR, path="not_exist.yaml"), ] ) def config(request): From 94642be208b259843f55f47f6b47971af6c892a9 Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Tue, 13 Aug 2024 18:53:52 +0200 Subject: [PATCH 2/8] test(cz_customize): fix YAML test and docs configurations quotes > commitizen.exceptions.InvalidConfigurationError: Failed to parse not_exist.yaml: while scanning a double-quoted scalar > found unknown escape character 's' Signed-off-by: Adrian DC --- docs/customization.md | 14 +++++++------- tests/test_cz_customize.py | 10 +++++----- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/customization.md b/docs/customization.md index e97558a308..8c43ef8f76 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -110,13 +110,13 @@ And the correspondent example for a yaml file: commitizen: name: cz_customize customize: - message_template: "{{change_type}}:{% if show_message %} {{message}}{% endif %}" + message_template: '{{change_type}}:{% if show_message %} {{message}}{% endif %}' example: 'feature: this feature enable customize through config file' - schema: ": " - schema_pattern: "(feature|bug fix):(\\s.*)" - bump_pattern: "^(break|new|fix|hotfix)" - commit_parser: "^(?Pfeature|bug fix):\\s(?P.*)?" - changelog_pattern: "^(feature|bug fix)?(!)?" + schema: ': ' + schema_pattern: '(feature|bug fix):(\\s.*)' + bump_pattern: '^(break|new|fix|hotfix)' + commit_parser: '^(?Pfeature|bug fix):\\s(?P.*)?' + changelog_pattern: '^(feature|bug fix)?(!)?' change_type_map: feature: Feat bug fix: Fix @@ -125,7 +125,7 @@ commitizen: new: MINOR fix: PATCH hotfix: PATCH - change_type_order: ["BREAKING CHANGE", "feat", "fix", "refactor", "perf"] + change_type_order: ['BREAKING CHANGE', 'feat', 'fix', 'refactor', 'perf'] info_path: cz_customize_info.txt info: This is customized info questions: diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py index 6001152709..055b2d6277 100644 --- a/tests/test_cz_customize.py +++ b/tests/test_cz_customize.py @@ -105,17 +105,17 @@ - commitizen/__version__.py - pyproject.toml customize: - message_template: "{{change_type}}:{% if show_message %} {{message}}{% endif %}" + message_template: '{{change_type}}:{% if show_message %} {{message}}{% endif %}' example: 'feature: this feature enables customization through a config file' - schema: ": " - schema_pattern: "(feature|bug fix):(\\s.*)" - bump_pattern: "^(break|new|fix|hotfix)" + schema: ': ' + schema_pattern: '(feature|bug fix):(\\s.*)' + bump_pattern: '^(break|new|fix|hotfix)' bump_map: break: MAJOR new: MINOR fix: PATCH hotfix: PATCH - change_type_order: ["perf", "BREAKING CHANGE", "feat", "fix", "refactor"] + change_type_order: ['perf', 'BREAKING CHANGE', 'feat', 'fix', 'refactor'] info: This is a customized cz. questions: - type: list From 5a5ae7409007e41aff9d728ba2cccc274244022d Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Tue, 13 Aug 2024 18:54:21 +0200 Subject: [PATCH 3/8] test(cz_customize): fix missing YAML test keys against JSON/TOML > test_commit_parser[config2] - AssertionError: > assert '(?P.*)' == '^(?P.*)?' > test_changelog_pattern[config2] - AssertionError: > assert '.*' == '^(feature|bug fix)?(!)?' > test_change_type_map[config2] - AssertionError: > assert None == {'bug fix': 'Fix', 'feature': 'Feat'} Signed-off-by: Adrian DC --- tests/test_cz_customize.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py index 055b2d6277..60a56f147f 100644 --- a/tests/test_cz_customize.py +++ b/tests/test_cz_customize.py @@ -110,6 +110,11 @@ schema: ': ' schema_pattern: '(feature|bug fix):(\\s.*)' bump_pattern: '^(break|new|fix|hotfix)' + commit_parser: '^(?Pfeature|bug fix):\\s(?P.*)?' + changelog_pattern: '^(feature|bug fix)?(!)?' + change_type_map: + feature: Feat + bug fix: Fix bump_map: break: MAJOR new: MINOR From daf16805f8fef9c84df075ef93c5d03d586dd156 Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Fri, 16 Aug 2024 23:52:42 +0200 Subject: [PATCH 4/8] test(command): cover 'nothing added' and 'no changes added to commit' Signed-off-by: Adrian DC --- tests/commands/test_commit_command.py | 62 +++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/tests/commands/test_commit_command.py b/tests/commands/test_commit_command.py index 3a92f5af48..1e8d8a6179 100644 --- a/tests/commands/test_commit_command.py +++ b/tests/commands/test_commit_command.py @@ -324,6 +324,68 @@ def test_commit_when_nothing_to_commit(config, mocker: MockFixture): assert "No files added to staging!" in str(excinfo.value) +@pytest.mark.usefixtures("staging_is_clean") +def test_commit_when_nothing_added_to_commit(config, mocker: MockFixture): + prompt_mock = mocker.patch("questionary.prompt") + prompt_mock.return_value = { + "prefix": "feat", + "subject": "user created", + "scope": "", + "is_breaking_change": False, + "body": "", + "footer": "", + } + + commit_mock = mocker.patch("commitizen.git.commit") + commit_mock.return_value = cmd.Command( + 'nothing added to commit but untracked files present (use "git add" to track)', + "", + b"", + b"", + 0, + ) + + error_mock = mocker.patch("commitizen.out.error") + + commands.Commit(config, {"all": False})() + + prompt_mock.assert_called_once() + error_mock.assert_called_once() + + assert "nothing added" in error_mock.call_args[0][0] + + +@pytest.mark.usefixtures("staging_is_clean") +def test_commit_when_no_changes_added_to_commit(config, mocker: MockFixture): + prompt_mock = mocker.patch("questionary.prompt") + prompt_mock.return_value = { + "prefix": "feat", + "subject": "user created", + "scope": "", + "is_breaking_change": False, + "body": "", + "footer": "", + } + + commit_mock = mocker.patch("commitizen.git.commit") + commit_mock.return_value = cmd.Command( + 'no changes added to commit (use "git add" and/or "git commit -a")', + "", + b"", + b"", + 0, + ) + + error_mock = mocker.patch("commitizen.out.error") + + commands.Commit(config, {"all": False})() + + prompt_mock.assert_called_once() + error_mock.assert_called_once() + + assert "no changes added to commit" in error_mock.call_args[0][0] + + @pytest.mark.usefixtures("staging_is_clean") def test_commit_with_allow_empty(config, mocker: MockFixture): prompt_mock = mocker.patch("questionary.prompt") From 188c6337192690121cd9702aa23365c1b64d5ca5 Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Sat, 17 Aug 2024 02:24:22 +0200 Subject: [PATCH 5/8] fix(commit): ensure 'questions' is a Python dictionary and not TOML Details: If using a TOML configuration, the type was 'tomlkit.items.AoT' --- Signed-off-by: Adrian DC --- commitizen/commands/commit.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/commitizen/commands/commit.py b/commitizen/commands/commit.py index cb34c41a50..9e52e82c90 100644 --- a/commitizen/commands/commit.py +++ b/commitizen/commands/commit.py @@ -51,7 +51,8 @@ def read_backup_message(self) -> str | None: def prompt_commit_questions(self) -> str: # Prompt user for the commit message cz = self.cz - questions = cz.questions() + questions = [dict(question) for question in cz.questions()] + for question in filter(lambda q: q["type"] == "list", questions): question["use_shortcuts"] = self.config.settings["use_shortcuts"] try: From 20ca2fba275a4eb1826b0b4dc56b26a2c6864d2c Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Sat, 17 Aug 2024 02:30:44 +0200 Subject: [PATCH 6/8] test(cz_customize): use 'cz_customize' configurations in its tests Signed-off-by: Adrian DC --- tests/test_cz_customize.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py index 60a56f147f..037dc9fb37 100644 --- a/tests/test_cz_customize.py +++ b/tests/test_cz_customize.py @@ -5,6 +5,14 @@ from commitizen.exceptions import MissingCzCustomizeConfigError TOML_STR = r""" + [tool.commitizen] + name = "cz_customize" + version = "1.0.0" + version_files = [ + "commitizen/__version__.py", + "pyproject.toml" + ] + [tool.commitizen.customize] message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}" example = "feature: this feature enables customization through a config file" @@ -42,7 +50,7 @@ JSON_STR = r""" { "commitizen": { - "name": "cz_jira", + "name": "cz_customize", "version": "1.0.0", "version_files": [ "commitizen/__version__.py", @@ -99,7 +107,7 @@ YAML_STR = """ commitizen: - name: cz_jira + name: cz_customize version: 1.0.0 version_files: - commitizen/__version__.py From 2759cab57f4a5eb5b896a6cecaf87c5064e056e8 Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Tue, 13 Aug 2024 16:01:56 +0200 Subject: [PATCH 7/8] feat(commit): implement questions 'filter' support with handlers Supported APIs: - multiple_line_breaker - required_validator - required_validator_scope - required_validator_subject_strip - required_validator_title_strip Example YAML configurations: --- commitizen: name: cz_customize customize: questions: - ... - type: input name: scope message: 'Scope of the change :' filter: 'required_validator_scope' default: '' - type: input name: subject message: 'Title of the commit (starting in lower case and without period) :' filter: 'required_validator_subject_strip' default: '' - type: input name: body message: 'Additional contextual message (Empty to skip) :' default: 'Issue: #...' filter: 'multiple_line_breaker' --- Signed-off-by: Adrian DC --- commitizen/commands/commit.py | 26 ++++++- commitizen/cz/utils.py | 25 +++++- docs/customization.md | 23 +++--- tests/test_cz_customize.py | 140 +++++++++++++++++++++++++++++++++- 4 files changed, 196 insertions(+), 18 deletions(-) diff --git a/commitizen/commands/commit.py b/commitizen/commands/commit.py index 9e52e82c90..ddca864b04 100644 --- a/commitizen/commands/commit.py +++ b/commitizen/commands/commit.py @@ -11,7 +11,14 @@ from commitizen import factory, git, out from commitizen.config import BaseConfig from commitizen.cz.exceptions import CzException -from commitizen.cz.utils import get_backup_file_path +from commitizen.cz.utils import ( + get_backup_file_path, + multiple_line_breaker, + required_validator, + required_validator_scope, + required_validator_subject_strip, + required_validator_title_strip, +) from commitizen.exceptions import ( CommitError, CommitMessageLengthExceededError, @@ -55,6 +62,23 @@ def prompt_commit_questions(self) -> str: for question in filter(lambda q: q["type"] == "list", questions): question["use_shortcuts"] = self.config.settings["use_shortcuts"] + + for question in filter( + lambda q: isinstance(q.get("filter", None), str), questions + ): + if question["filter"] == "multiple_line_breaker": + question["filter"] = multiple_line_breaker + elif question["filter"] == "required_validator": + question["filter"] = required_validator + elif question["filter"] == "required_validator_scope": + question["filter"] = required_validator_scope + elif question["filter"] == "required_validator_subject_strip": + question["filter"] = required_validator_subject_strip + elif question["filter"] == "required_validator_title_strip": + question["filter"] = required_validator_title_strip + else: + raise NotAllowed(f"Unknown value filter: {question['filter']}") + try: answers = questionary.prompt(questions, style=cz.style) except ValueError as err: diff --git a/commitizen/cz/utils.py b/commitizen/cz/utils.py index 7bc89673c6..e0e7bd8ddf 100644 --- a/commitizen/cz/utils.py +++ b/commitizen/cz/utils.py @@ -6,13 +6,34 @@ from commitizen.cz import exceptions -def required_validator(answer, msg=None): +def required_validator(answer: str, msg=None) -> str: if not answer: raise exceptions.AnswerRequiredError(msg) return answer -def multiple_line_breaker(answer, sep="|"): +def required_validator_scope( + answer: str, + msg: str = "! Error: Scope is required", +) -> str: + return required_validator(answer, msg) + + +def required_validator_subject_strip( + answer: str, + msg: str = "! Error: Subject is required", +) -> str: + return required_validator(answer.strip(".").strip(), msg) + + +def required_validator_title_strip( + answer: str, + msg: str = "! Error: Title is required", +) -> str: + return required_validator(answer.strip(".").strip(), msg) + + +def multiple_line_breaker(answer: str, sep: str = "|") -> str: return "\n".join(line.strip() for line in answer.split(sep) if line) diff --git a/docs/customization.md b/docs/customization.md index 8c43ef8f76..aeb8695e67 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -168,17 +168,18 @@ commitizen: #### Detailed `questions` content -| Parameter | Type | Default | Description | -| ----------- | ------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | `str` | `None` | The type of questions. Valid types: `list`, `select`, `input`, etc. The `select` type provides an interactive searchable list interface. [See More][different-question-types] | -| `name` | `str` | `None` | The key for the value answered by user. It's used in `message_template` | -| `message` | `str` | `None` | Detail description for the question. | -| `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. | -| `default` | `Any` | `None` | (OPTIONAL) The default value for this question. | -| `filter` | `str` | `None` | (OPTIONAL) Validator for user's answer. **(Work in Progress)** | -| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. | -| `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. | -| `use_jk_keys` | `bool` | `True` | (OPTIONAL) Enable/disable j/k keys for navigation in list/select type questions. Set to false if you prefer arrow keys only. | +| Parameter | Type | Default | Description | +| ------------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | `str` | `None` | The type of questions. Valid types: `list`, `select`, `input`, etc. The `select` type provides an interactive searchable list interface. [See More][different-question-types] | +| `name` | `str` | `None` | The key for the value answered by user. It's used in `message_template` | +| `message` | `str` | `None` | Detail description for the question. | +| `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. | +| `default` | `Any` | `None` | (OPTIONAL) The default value for this question. | +| `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` | +| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. | +| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. | +| `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. | +| `use_jk_keys` | `bool` | `True` | (OPTIONAL) Enable/disable j/k keys for navigation in list/select type questions. Set to false if you prefer arrow keys only. | [different-question-types]: https://github.com/tmbo/questionary#different-question-types diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py index 037dc9fb37..06baa6f0c3 100644 --- a/tests/test_cz_customize.py +++ b/tests/test_cz_customize.py @@ -1,8 +1,17 @@ import pytest +from pytest_mock import MockFixture +from commitizen import cmd, commands from commitizen.config import BaseConfig, JsonConfig, TomlConfig, YAMLConfig from commitizen.cz.customize import CustomizeCommitsCz -from commitizen.exceptions import MissingCzCustomizeConfigError +from commitizen.cz.utils import ( + multiple_line_breaker, + required_validator, + required_validator_scope, + required_validator_subject_strip, + required_validator_title_strip, +) +from commitizen.exceptions import MissingCzCustomizeConfigError, NotAllowed TOML_STR = r""" [tool.commitizen] @@ -36,10 +45,17 @@ ] message = "Select the type of change you are committing" + [[tool.commitizen.customize.questions]] + type = "input" + name = "subject" + message = "Subject." + filter = "required_validator_subject_strip" + [[tool.commitizen.customize.questions]] type = "input" name = "message" message = "Body." + filter = "multiple_line_breaker" [[tool.commitizen.customize.questions]] type = "confirm" @@ -89,10 +105,17 @@ ], "message": "Select the type of change you are committing" }, + { + "type": "input", + "name": "subject", + "message": "Subject.", + "filter": "required_validator_subject_strip" + }, { "type": "input", "name": "message", - "message": "Body." + "message": "Body.", + "filter": "multiple_line_breaker" }, { "type": "confirm", @@ -139,9 +162,14 @@ - value: bug fix name: 'bug fix: A bug fix.' message: Select the type of change you are committing + - type: input + name: subject + message: Subject. + filter: required_validator_subject_strip - type: input name: message message: Body. + filter: multiple_line_breaker - type: confirm name: show_message message: Do you want to add body message in commit? @@ -330,6 +358,13 @@ """ +@pytest.fixture +def staging_is_clean(mocker: MockFixture, tmp_git_project): + is_staging_clean_mock = mocker.patch("commitizen.git.is_staging_clean") + is_staging_clean_mock.return_value = False + return tmp_git_project + + @pytest.fixture( params=[ TomlConfig(data=TOML_STR, path="not_exist.toml"), @@ -346,6 +381,15 @@ def config(request): return request.param +@pytest.fixture( + params=[ + YAMLConfig(data=YAML_STR, path="not_exist.yaml"), + ] +) +def config_filters(request): + return request.param + + @pytest.fixture( params=[ TomlConfig(data=TOML_STR_INFO_PATH, path="not_exist.toml"), @@ -437,7 +481,7 @@ def test_change_type_order_unicode(config_with_unicode): ] -def test_questions(config): +def test_questions_default(config): cz = CustomizeCommitsCz(config) questions = cz.questions() expected_questions = [ @@ -450,7 +494,18 @@ def test_questions(config): ], "message": "Select the type of change you are committing", }, - {"type": "input", "name": "message", "message": "Body."}, + { + "type": "input", + "name": "subject", + "message": "Subject.", + "filter": "required_validator_subject_strip", + }, + { + "type": "input", + "name": "message", + "message": "Body.", + "filter": "multiple_line_breaker", + }, { "type": "confirm", "name": "show_message", @@ -460,6 +515,83 @@ def test_questions(config): assert list(questions) == expected_questions +@pytest.mark.usefixtures("staging_is_clean") +def test_questions_filter_default(config, mocker: MockFixture): + is_staging_clean_mock = mocker.patch("commitizen.git.is_staging_clean") + is_staging_clean_mock.return_value = False + + prompt_mock = mocker.patch("questionary.prompt") + prompt_mock.return_value = { + "change_type": "feature", + "subject": "user created", + "message": "body of the commit", + "show_message": True, + } + + commit_mock = mocker.patch("commitizen.git.commit") + commit_mock.return_value = cmd.Command("success", "", b"", b"", 0) + + commands.Commit(config, {})() + + prompts_questions = prompt_mock.call_args[0][0] + assert prompts_questions[0]["type"] == "list" + assert prompts_questions[0]["name"] == "change_type" + assert prompts_questions[0]["use_shortcuts"] is False + assert prompts_questions[1]["type"] == "input" + assert prompts_questions[1]["name"] == "subject" + assert prompts_questions[1]["filter"] == required_validator_subject_strip + assert prompts_questions[2]["type"] == "input" + assert prompts_questions[2]["name"] == "message" + assert prompts_questions[2]["filter"] == multiple_line_breaker + assert prompts_questions[3]["type"] == "confirm" + assert prompts_questions[3]["name"] == "show_message" + + +@pytest.mark.usefixtures("staging_is_clean") +def test_questions_filter_values(config_filters, mocker: MockFixture): + is_staging_clean_mock = mocker.patch("commitizen.git.is_staging_clean") + is_staging_clean_mock.return_value = False + + prompt_mock = mocker.patch("questionary.prompt") + prompt_mock.return_value = { + "change_type": "feature", + "subject": "user created", + "message": "body of the commit", + "show_message": True, + } + + commit_mock = mocker.patch("commitizen.git.commit") + commit_mock.return_value = cmd.Command("success", "", b"", b"", 0) + + commit_cmd = commands.Commit(config_filters, {}) + + assert isinstance(commit_cmd.cz, CustomizeCommitsCz) + + for filter_desc in [ + ("multiple_line_breaker", multiple_line_breaker), + ("required_validator", required_validator), + ("required_validator_scope", required_validator_scope), + ("required_validator_subject_strip", required_validator_subject_strip), + ("required_validator_title_strip", required_validator_title_strip), + ]: + commit_cmd.cz.custom_settings["questions"][1]["filter"] = filter_desc[0] # type: ignore[index] + commit_cmd() + + assert filter_desc[1]("input") + + prompts_questions = prompt_mock.call_args[0][0] + assert prompts_questions[1]["filter"] == filter_desc[1] + + for filter_name in [ + "", + "faulty_value", + ]: + commit_cmd.cz.custom_settings["questions"][1]["filter"] = filter_name # type: ignore[index] + + with pytest.raises(NotAllowed): + commit_cmd() + + def test_questions_unicode(config_with_unicode): cz = CustomizeCommitsCz(config_with_unicode) questions = cz.questions() From 2d70c25e6f13cb61ff60a9e7175179d34c9f96c1 Mon Sep 17 00:00:00 2001 From: Adrian DC Date: Sun, 8 Jun 2025 16:42:08 +0200 Subject: [PATCH 8/8] chore(utils): rework 'multiple_line_breaker' into 'break_multiple_line' Signed-off-by: Adrian DC --- commitizen/commands/commit.py | 6 +++--- .../conventional_commits/conventional_commits.py | 4 ++-- commitizen/cz/utils.py | 2 +- docs/customization.md | 2 +- tests/test_cz_customize.py | 14 +++++++------- tests/test_cz_utils.py | 6 +++--- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/commitizen/commands/commit.py b/commitizen/commands/commit.py index ddca864b04..78a48b9a4f 100644 --- a/commitizen/commands/commit.py +++ b/commitizen/commands/commit.py @@ -12,8 +12,8 @@ from commitizen.config import BaseConfig from commitizen.cz.exceptions import CzException from commitizen.cz.utils import ( + break_multiple_line, get_backup_file_path, - multiple_line_breaker, required_validator, required_validator_scope, required_validator_subject_strip, @@ -66,8 +66,8 @@ def prompt_commit_questions(self) -> str: for question in filter( lambda q: isinstance(q.get("filter", None), str), questions ): - if question["filter"] == "multiple_line_breaker": - question["filter"] = multiple_line_breaker + if question["filter"] == "break_multiple_line": + question["filter"] = break_multiple_line elif question["filter"] == "required_validator": question["filter"] = required_validator elif question["filter"] == "required_validator_scope": diff --git a/commitizen/cz/conventional_commits/conventional_commits.py b/commitizen/cz/conventional_commits/conventional_commits.py index af29a209fc..1e72db66ea 100644 --- a/commitizen/cz/conventional_commits/conventional_commits.py +++ b/commitizen/cz/conventional_commits/conventional_commits.py @@ -3,7 +3,7 @@ from commitizen import defaults from commitizen.cz.base import BaseCommitizen -from commitizen.cz.utils import multiple_line_breaker, required_validator +from commitizen.cz.utils import break_multiple_line, required_validator from commitizen.defaults import Questions __all__ = ["ConventionalCommitsCz"] @@ -129,7 +129,7 @@ def questions(self) -> Questions: "message": ( "Provide additional contextual information about the code changes: (press [enter] to skip)\n" ), - "filter": multiple_line_breaker, + "filter": break_multiple_line, }, { "type": "confirm", diff --git a/commitizen/cz/utils.py b/commitizen/cz/utils.py index e0e7bd8ddf..4a304f6c98 100644 --- a/commitizen/cz/utils.py +++ b/commitizen/cz/utils.py @@ -33,7 +33,7 @@ def required_validator_title_strip( return required_validator(answer.strip(".").strip(), msg) -def multiple_line_breaker(answer: str, sep: str = "|") -> str: +def break_multiple_line(answer: str, sep: str = "|") -> str: return "\n".join(line.strip() for line in answer.split(sep) if line) diff --git a/docs/customization.md b/docs/customization.md index aeb8695e67..e17a09a4fe 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -175,7 +175,7 @@ commitizen: | `message` | `str` | `None` | Detail description for the question. | | `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. | | `default` | `Any` | `None` | (OPTIONAL) The default value for this question. | -| `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` | +| `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` | | `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. | | `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. | | `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. | diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py index 06baa6f0c3..7100457bd6 100644 --- a/tests/test_cz_customize.py +++ b/tests/test_cz_customize.py @@ -5,7 +5,7 @@ from commitizen.config import BaseConfig, JsonConfig, TomlConfig, YAMLConfig from commitizen.cz.customize import CustomizeCommitsCz from commitizen.cz.utils import ( - multiple_line_breaker, + break_multiple_line, required_validator, required_validator_scope, required_validator_subject_strip, @@ -55,7 +55,7 @@ type = "input" name = "message" message = "Body." - filter = "multiple_line_breaker" + filter = "break_multiple_line" [[tool.commitizen.customize.questions]] type = "confirm" @@ -115,7 +115,7 @@ "type": "input", "name": "message", "message": "Body.", - "filter": "multiple_line_breaker" + "filter": "break_multiple_line" }, { "type": "confirm", @@ -169,7 +169,7 @@ - type: input name: message message: Body. - filter: multiple_line_breaker + filter: break_multiple_line - type: confirm name: show_message message: Do you want to add body message in commit? @@ -504,7 +504,7 @@ def test_questions_default(config): "type": "input", "name": "message", "message": "Body.", - "filter": "multiple_line_breaker", + "filter": "break_multiple_line", }, { "type": "confirm", @@ -542,7 +542,7 @@ def test_questions_filter_default(config, mocker: MockFixture): assert prompts_questions[1]["filter"] == required_validator_subject_strip assert prompts_questions[2]["type"] == "input" assert prompts_questions[2]["name"] == "message" - assert prompts_questions[2]["filter"] == multiple_line_breaker + assert prompts_questions[2]["filter"] == break_multiple_line assert prompts_questions[3]["type"] == "confirm" assert prompts_questions[3]["name"] == "show_message" @@ -568,7 +568,7 @@ def test_questions_filter_values(config_filters, mocker: MockFixture): assert isinstance(commit_cmd.cz, CustomizeCommitsCz) for filter_desc in [ - ("multiple_line_breaker", multiple_line_breaker), + ("break_multiple_line", break_multiple_line), ("required_validator", required_validator), ("required_validator_scope", required_validator_scope), ("required_validator_subject_strip", required_validator_subject_strip), diff --git a/tests/test_cz_utils.py b/tests/test_cz_utils.py index 25c960c9a7..6f72ef4f55 100644 --- a/tests/test_cz_utils.py +++ b/tests/test_cz_utils.py @@ -11,12 +11,12 @@ def test_required_validator(): utils.required_validator("") -def test_multiple_line_breaker(): +def test_break_multiple_line(): message = "this is the first line | and this is the second line " - result = utils.multiple_line_breaker(message) + result = utils.break_multiple_line(message) assert result == "this is the first line\nand this is the second line" - result = utils.multiple_line_breaker(message, "is") + result = utils.break_multiple_line(message, "is") assert result == "th\n\nthe first line | and th\n\nthe second line"