Added: Templates inheritance

cookiecutter/generate.py

@@ -324,7 +324,7 @@ def generate_files(
         )
 
     with work_in(template_dir):
-        env.loader = FileSystemLoader('.')
+        env.loader = FileSystemLoader(['.', '../templates'])
 
         for root, dirs, files in os.walk('.'):
             # We must separate the two types of dirs into different lists.

docs/advanced/index.rst

@@ -19,6 +19,7 @@ Various advanced topics regarding cookiecutter usage.
    replay
    choice_variables
    dict_variables
+   templates
    template_extensions
    directories
    new_line_characters

docs/advanced/templates.rst

@@ -0,0 +1,34 @@
+.. _templates:
+
+Templates inheritance (2.2+)
+---------------------------------------------------
+
+*New in Cookiecutter 2.2+*
+
+Sometimes you need to extend a base template with a different
+configuration to avoid nested blocks.
+
+Cookiecutter introduces the ability to use common templates
+using the power of jinja: `extends`, `include` and `super`.
+
+Here's an example repository::
+
+    https://github.com/user/repo-name.git
+    ├── {{cookiecutter.project_slug}}/
+    |   └── file.txt
+    ├── templates/
+    |   └── base.txt
+    └── cookiecutter.json
+
+every file in the `templates` directory will become referable inside the project itself,
+and the path should be relative from the `templates` folder like ::
+
+    # file.txt
+    {% extends "base.txt" %}
+
+    ... or ...
+
+    # file.txt
+    {% include "base.txt" %}
+
+see more on https://jinja.palletsprojects.com/en/2.11.x/templates/

tests/test-templates/extends/cookiecutter.json

@@ -0,0 +1,5 @@
+{
+    "project_slug": "foobar",
+    "command_line_interface": "click",
+    "use_pytest": "y"
+}

tests/test-templates/extends/templates/base-requirements.jinja

@@ -0,0 +1,6 @@
+pip==19.2.3
+{% if cookiecutter.command_line_interface|lower == 'click' -%}
+{% include 'click-requirements.jinja' %}{% endif %}
+{% if cookiecutter.use_pytest == 'y' -%}
+{% include 'pytest-requirements.jinja' %}{% endif %}
+{% block dependencies %}{% endblock %}

tests/test-templates/extends/templates/click-requirements.jinja

@@ -0,0 +1 @@
+Click==7.0

tests/test-templates/extends/templates/pytest-requirements.jinja

@@ -0,0 +1 @@
+pytest==4.6.5

tests/test-templates/extends/{{cookiecutter.project_slug}}/requirements.txt

@@ -0,0 +1 @@
+{% extends "base-requirements.jinja" %}

tests/test-templates/include/cookiecutter.json

@@ -0,0 +1,5 @@
+{
+    "project_slug": "foobar",
+    "command_line_interface": "click",
+    "use_pytest": "y"
+}

tests/test-templates/include/templates/click-requirements.jinja

@@ -0,0 +1 @@
+Click==7.0

tests/test-templates/include/templates/pytest-requirements.jinja

@@ -0,0 +1 @@
+pytest==4.6.5

tests/test-templates/include/{{cookiecutter.project_slug}}/requirements.txt

@@ -0,0 +1,5 @@
+pip==19.2.3
+{% if cookiecutter.command_line_interface|lower == 'click' -%}
+{% include 'click-requirements.jinja' %}{% endif %}
+{% if cookiecutter.use_pytest == 'y' -%}
+{% include 'pytest-requirements.jinja' %}{% endif %}

tests/test-templates/no-templates/cookiecutter.json

@@ -0,0 +1,5 @@
+{
+    "project_slug": "foobar",
+    "command_line_interface": "click",
+    "use_pytest": "y"
+}

tests/test-templates/no-templates/{{cookiecutter.project_slug}}/requirements.txt

@@ -0,0 +1,5 @@
+pip==19.2.3
+{% if cookiecutter.command_line_interface|lower == 'click' -%}
+Click==7.0{% endif %}
+{% if cookiecutter.use_pytest == 'y' -%}
+pytest==4.6.5{% endif %}

tests/test-templates/super/cookiecutter.json

@@ -0,0 +1,5 @@
+{
+    "project_slug": "foobar",
+    "command_line_interface": "click",
+    "use_pytest": "y"
+}

tests/test-templates/super/templates/base-requirements.jinja

@@ -0,0 +1,7 @@
+pip==19.2.3
+{% if cookiecutter.command_line_interface|lower == 'click' -%}
+{% include 'click-requirements.jinja' %}{% endif %}
+{%- block dev_dependencies %}
+{% if cookiecutter.use_pytest == 'y' -%}{% include 'pytest-requirements.jinja' %}{% endif %}
+{%- endblock %}
+{% block dependencies %}{% endblock %}

tests/test-templates/super/templates/click-requirements.jinja

@@ -0,0 +1 @@
+Click==7.0

tests/test-templates/super/templates/pytest-requirements.jinja

@@ -0,0 +1 @@
+pytest==4.6.5

tests/test-templates/super/{{cookiecutter.project_slug}}/requirements.txt

@@ -0,0 +1,2 @@
+{% extends "base-requirements.jinja" %}
+{% block dev_dependencies %}{{ super() }}{% endblock %}

tests/test_templates.py

@@ -0,0 +1,43 @@
+"""
+test_custom_extension_in_hooks.
+
+Tests to ensure custom cookiecutter extensions are properly made available to
+pre- and post-gen hooks.
+"""
+import codecs
+import os
+
+import pytest
+
+from cookiecutter import main
+
+
+@pytest.fixture
+def output_dir(tmpdir):
+    """Fixture. Create and return custom temp directory for test."""
+    return str(tmpdir.mkdir('templates'))
+
+
+@pytest.mark.parametrize("template", ["include", "no-templates", "extends", "super"])
+def test_build_templates(template, output_dir):
+    """
+    Verify Templates Design keywords.
+
+    no-templates is a compatibility tests for repo without `templates` directory
+    """
+    project_dir = main.cookiecutter(
+        f'tests/test-templates/{template}',
+        no_input=True,
+        output_dir=output_dir,
+    )
+
+    readme_file = os.path.join(project_dir, 'requirements.txt')
+
+    with codecs.open(readme_file, encoding='utf8') as f:
+        readme = f.read().splitlines()
+
+    assert readme == [
+        "pip==19.2.3",
+        "Click==7.0",
+        "pytest==4.6.5",
+    ]