Make directory default to name.lower() for custom newfragment types

Author: matteosantama

docs/configuration.rst

@@ -288,14 +288,16 @@ If you use this way to configure custom fragment types, ensure there is no ``too
 Each table within this array has the following mandatory keys:
 
 
-``directory``
-    The type / category of the fragment.
-
-``name``
+``name`` (required)
     The description of the fragment type, as it must be included
     in the news file.
 
-``showcontent``
+``directory`` (optional)
+    The type / category of the fragment.
+
+    Defaults to ``name.lower()``.
+
+``showcontent`` (optional)
     A boolean value indicating whether the fragment contents should be included in the news file.
 
     ``true`` by default.
@@ -305,7 +307,7 @@ Each table within this array has the following mandatory keys:
         Orphan fragments (those without an issue number) always have their content included.
         If a fragment was created, it means that information is important for end users.
 
-``check``
+``check`` (optional)
     A boolean value indicating whether the fragment should be considered by the ``towncrier check`` command.
 
     ``true`` by default.
@@ -316,9 +318,7 @@ For example:
 
    [tool.towncrier]
    [[tool.towncrier.type]]
-   directory = "deprecation"
    name = "Deprecations"
-   showcontent = true
 
    [[tool.towncrier.type]]
    directory = "chore"

docs/markdown.rst

@@ -25,27 +25,21 @@ Put the following into your ``pyproject.toml`` or ``towncrier.toml``:
    issue_format = "[#{issue}](https://github.com/twisted/my-project/issues/{issue})"
 
    [[tool.towncrier.type]]
-   directory = "security"
    name = "Security"
 
    [[tool.towncrier.type]]
-   directory = "removed"
    name = "Removed"
 
    [[tool.towncrier.type]]
-   directory = "deprecated"
    name = "Deprecated"
 
    [[tool.towncrier.type]]
-   directory = "added"
    name = "Added"
 
    [[tool.towncrier.type]]
-   directory = "changed"
    name = "Changed"
 
    [[tool.towncrier.type]]
-   directory = "fixed"
    name = "Fixed"
 
 

src/towncrier/_settings/fragment_types.py

@@ -76,8 +76,8 @@ def load(self) -> Mapping[str, Mapping[str, Any]]:
         types = {}
         types_config = self.config["type"]
         for type_config in types_config:
-            directory = type_config["directory"]
             fragment_type_name = type_config["name"]
+            directory = type_config.get("directory", fragment_type_name.lower())
             is_content_required = type_config.get("showcontent", True)
             check = type_config.get("check", True)
             types[directory] = {

src/towncrier/newsfragments/691.feature.rst

@@ -0,0 +1 @@
+More simple configuration for Keep a Changelog style changelogs

src/towncrier/test/test_build.py

@@ -1792,3 +1792,31 @@ def test_showcontent_default_toml_array(self, runner):
             _main, ["--draft", "--date", "01-01-2001", "--version", "1.0.0"]
         )
         self.assertEqual(0, result.exit_code, result.output)
+
+    @with_project(
+        config="""
+        [tool.towncrier]
+        title_format = "{version} - {project_date}"
+
+          [[tool.towncrier.type]]
+          name = "Feature"
+
+          [[tool.towncrier.type]]
+          directory = "deps"
+          name = "Dependency"
+        """
+    )
+    def test_directory_default_toml_array(self, runner):
+        """
+        When configuring custom fragment types with a TOML array
+        the `directory` key should be optional.
+        """
+        with open("foo/newsfragments/+new_feature.feature.md", "w") as f:
+            f.write("We added an exciting new feature!")
+        with open("foo/newsfragments/+bump_deps.deps.md", "w") as f:
+            f.write("We bumped our dependencies.")
+
+        result = runner.invoke(
+            _main, ["--draft", "--date", "01-01-2001", "--version", "1.0.0"]
+        )
+        self.assertEqual(0, result.exit_code, result.output)