feat(#319): add optional change_type_order

commitizen/changelog.py

@@ -130,14 +130,21 @@ def generate_tree_from_commits(
 
 
 def order_changelog_tree(tree: Iterable, change_type_order: List[str]) -> Iterable:
+    if len(set(change_type_order)) != len(change_type_order):
+        raise RuntimeError(
+            f"Change types contain duplicates types ({change_type_order})"
+        )
+
     sorted_tree = []
     for entry in tree:
-        entry_change_types = sorted(entry["changes"].keys())
-        ordered_change_types = []
-        for ct in change_type_order + entry_change_types:
-            if ct in entry_change_types and ct not in ordered_change_types:
-                ordered_change_types.append(ct)
-        changes = [(ct, entry["changes"][ct]) for ct in ordered_change_types]
+        ordered_change_types = change_type_order + sorted(
+            set(entry["changes"].keys()) - set(change_type_order)
+        )
+        changes = [
+            (ct, entry["changes"][ct])
+            for ct in ordered_change_types
+            if ct in entry["changes"]
+        ]
         sorted_tree.append({**entry, **{"changes": OrderedDict(changes)}})
     return sorted_tree
 

docs/customization.md

@@ -52,7 +52,7 @@ The equivalent example for a json config file:
 ```json
 {
     "commitizen": {
-    "name": "cz_customize",
+	"name": "cz_customize",
         "customize": {
             "message_template": "{{change_type}}:{% if show_message %} {{message}}{% endif %}",
             "example": "feature: this feature enable customize through config file",
@@ -66,7 +66,7 @@ The equivalent example for a json config file:
                 "hotfix": "PATCH"
             },
             "change_type_order": ["BREAKING CHANGE", "feat", "fix", "refactor", "perf"],
-            "info_path": "cz_customize_info.txt",
+    "info_path": "cz_customize_info.txt",
             "info": "This is customized info",
             "questions": [
                 {

pyproject.toml

@@ -71,9 +71,6 @@ freezegun = "^0.3.15"
 pydocstyle = "^5.0.2"
 pre-commit = "^2.6.0"
 
-# FIXME: Remove for submission (testing issues/319-only)
-pytest-watch = "*"
-
 [tool.poetry.scripts]
 cz = "commitizen.cli:main"
 git-cz = "commitizen.cli:main"

tests/test_changelog.py

@@ -803,26 +803,42 @@ def test_generate_tree_from_commits(gitcommits, tags):
         (
             ["BREAKING CHANGE", "refactor"],
             {
-                2: (["refactor", "feat", "fix"], ["feat", "fix", "refactor"]),
-                3: (["BREAKING CHANGE", "refactor"], ["refactor", "BREAKING CHANGE"]),
+                "1.1.0": {
+                    "original": ["feat", "fix", "refactor"],
+                    "sorted": ["refactor", "feat", "fix"],
+                },
+                "1.0.0": {
+                    "original": ["refactor", "BREAKING CHANGE"],
+                    "sorted": ["BREAKING CHANGE", "refactor"],
+                },
             },
         ),
     ),
 )
 def test_order_changelog_tree(change_type_order, expected_reordering):
-    tree = tuple(changelog.order_changelog_tree(COMMITS_TREE, change_type_order))
+    tree = changelog.order_changelog_tree(COMMITS_TREE, change_type_order)
 
-    index_of_reordered_entry = [*expected_reordering.keys()]
     for index, entry in enumerate(tuple(tree)):
-        if index in index_of_reordered_entry:
-            sorted_order, original_order = expected_reordering[index]
+        version = tree[index]["version"]
+        if version in expected_reordering:
+            # Verify that all keys are present
             assert [*tree[index].keys()] == [*COMMITS_TREE[index].keys()]
-            assert [*tree[index]["changes"].keys()] == sorted_order
-            assert [*COMMITS_TREE[index]["changes"].keys()] == original_order
+            # Verify that the reorder only impacted the returned dict and not the original
+            expected = expected_reordering[version]
+            assert [*tree[index]["changes"].keys()] == expected["sorted"]
+            assert [*COMMITS_TREE[index]["changes"].keys()] == expected["original"]
         else:
             assert [*entry["changes"].keys()] == [*tree[index]["changes"].keys()]
 
 
+def test_order_changelog_tree_raises():
+    change_type_order = ["BREAKING CHANGE", "feat", "refactor", "feat"]
+    with pytest.raises(RuntimeError) as excinfo:
+        changelog.order_changelog_tree(COMMITS_TREE, change_type_order)
+
+    assert " duplicate" in str(excinfo)
+
+
 def test_render_changelog(gitcommits, tags, changelog_content):
     parser = defaults.commit_parser
     changelog_pattern = defaults.bump_pattern