Standardize EOF newlines (cookiecutter#1876)

* Add a pre-commit hook to standardize EOF newlines * Run `pre-commit run --all-files end-of-file-fixer` This is an automated change. Nothing was manually modified. * Resolve test failures caused by standardized EOF newlines
pkrueger-cariad · Jun 30, 2023 · e02de10 · e02de10
1 parent 2125335
commit e02de10
Show file tree

Hide file tree

Showing 33 changed files with 34 additions and 36 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -12,4 +12,3 @@
 ```
 // REPLACE ME: Paste a log of command(s) you ran and cookiecutter's output, tracebacks, etc, here
 ```
-
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -31,6 +31,7 @@ repos:
         args:
           - "--fix=crlf"
         files: "crlf"
+      - id: end-of-file-fixer
       - id: fix-byte-order-marker
       - id: check-executables-have-shebangs
       - id: check-shebang-scripts-are-executable
@@ -65,4 +66,4 @@ repos:
   - repo: https://github.com/mgedmin/check-manifest
     rev: "0.49"
     hooks:
-    -   id: check-manifest
+    -   id: check-manifest
diff --git a/docs/advanced/boolean_variables.rst b/docs/advanced/boolean_variables.rst
@@ -50,4 +50,3 @@ If a non valid value is inserted to a boolean field, the following error will be
 
    run_as_docker [True]: docker
    Error: docker is not a valid boolean
-
diff --git a/docs/advanced/local_extensions.rst b/docs/advanced/local_extensions.rst
@@ -56,4 +56,3 @@ This snippet will achieve the exact same result as the previous one.
 
 For complex use cases, a python module ``local_extensions`` (a folder with an ``__init__.py``) can also be created in the template root.
 Here, for example, a module ``main.py`` would have to export all extensions with ``from .main import FoobarExtension, simplefilterextension`` or ``from .main import *`` in the ``__init__.py``.
-
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,4 +4,4 @@ myst-parser>=0.17.2
 sphinx-autobuild>=2021.3.14
 Sphinx>=4.5.0
 sphinxcontrib-apidoc>=0.3.0
-sphinx-autodoc-typehints>=1.18.2
+sphinx-autodoc-typehints>=1.18.2
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -128,4 +128,3 @@ Pre-0.7.0, this is how it worked:
   is output to your current directory.
 
 * Cloned cookiecutters were not saved locally.
-
diff --git a/tests/fake-repo-bad/no-project-in-here.txt b/tests/fake-repo-bad/no-project-in-here.txt
@@ -1 +1 @@
-Ha ha ha!
+Ha ha ha!
diff --git a/tests/files/syntax_error.txt b/tests/files/syntax_error.txt
@@ -1 +1 @@
-I eat {{ syntax_error }} {# this comment is not closed}
+I eat {{ syntax_error }} {# this comment is not closed}
diff --git a/tests/files/unicode.txt b/tests/files/unicode.txt
@@ -1,3 +1,3 @@
 Polish: Ą Ł Ż
 Chinese: 倀 倁 倂 倃 倄 倅 倆 倇 倈
-Musical Notes: ♬ ♫ ♯
+Musical Notes: ♬ ♫ ♯
diff --git a/tests/files/{% if cookiecutter.generate_file == 'y' %}cheese.txt{% endif %} b/tests/files/{% if cookiecutter.generate_file == 'y' %}cheese.txt{% endif %}
@@ -1 +1 @@
-Testing that generate_file was {{ cookiecutter.generate_file }}
+Testing that generate_file was {{ cookiecutter.generate_file }}
diff --git a/tests/files/{{cookiecutter.generate_file}}.txt b/tests/files/{{cookiecutter.generate_file}}.txt
@@ -1 +1 @@
-Testing {{ cookiecutter.generate_file }}
+Testing {{ cookiecutter.generate_file }}
diff --git a/tests/test-extensions/default/{{cookiecutter.project_slug}}/id b/tests/test-extensions/default/{{cookiecutter.project_slug}}/id
@@ -1 +1 @@
-{{ uuid4() }}
+{{ uuid4() }}
diff --git a/tests/test-generate-files-nontemplated/input/simple.txt b/tests/test-generate-files-nontemplated/input/simple.txt
@@ -1 +1 @@
-I eat {{ food }}
+I eat {{ food }}
diff --git a/tests/test-generate-files-permissions/input{{cookiecutter.permissions}}/simple.txt b/tests/test-generate-files-permissions/input{{cookiecutter.permissions}}/simple.txt
@@ -1 +1 @@
-Some static text
+Some static text
diff --git a/tests/test-generate-files/input{{cookiecutter.food}}/simple.txt b/tests/test-generate-files/input{{cookiecutter.food}}/simple.txt
@@ -1 +1 @@
-I eat {{ cookiecutter.food }}
+I eat {{ cookiecutter.food }}
diff --git a/tests/test-output-folder/{{cookiecutter.test_name}}/folder/in_folder.txt b/tests/test-output-folder/{{cookiecutter.test_name}}/folder/in_folder.txt
@@ -1 +1 @@
-The color is {{ cookiecutter.color }} and the letter is {{ cookiecutter.letter }}.
+The color is {{ cookiecutter.color }} and the letter is {{ cookiecutter.letter }}.
diff --git a/tests/test-output-folder/{{cookiecutter.test_name}}/something.txt b/tests/test-output-folder/{{cookiecutter.test_name}}/something.txt
@@ -1,3 +1,3 @@
 Hi!
 My name is {{ cookiecutter.full_name }}.
-It is {{ cookiecutter.year }}.
+It is {{ cookiecutter.year }}.
diff --git a/tests/test-templates/extends/templates/base-requirements.jinja b/tests/test-templates/extends/templates/base-requirements.jinja
@@ -3,4 +3,4 @@ pip
 {% include 'click-requirements.jinja' %}{% endif %}
 {% if cookiecutter.use_pytest == 'y' -%}
 {% include 'pytest-requirements.jinja' %}{% endif %}
-{% block dependencies %}{% endblock %}
+{% block dependencies %}{% endblock %}
diff --git a/tests/test-templates/extends/templates/click-requirements.jinja b/tests/test-templates/extends/templates/click-requirements.jinja
@@ -1 +1 @@
-Click
+Click
diff --git a/tests/test-templates/extends/templates/pytest-requirements.jinja b/tests/test-templates/extends/templates/pytest-requirements.jinja
@@ -1 +1 @@
-pytest
+pytest
diff --git a/tests/test-templates/extends/{{cookiecutter.project_slug}}/requirements.txt b/tests/test-templates/extends/{{cookiecutter.project_slug}}/requirements.txt
@@ -1 +1 @@
-{% extends "base-requirements.jinja" %}
+{% extends "base-requirements.jinja" %}
diff --git a/tests/test-templates/include/templates/click-requirements.jinja b/tests/test-templates/include/templates/click-requirements.jinja
@@ -1 +1 @@
-Click
+Click
diff --git a/tests/test-templates/include/templates/pytest-requirements.jinja b/tests/test-templates/include/templates/pytest-requirements.jinja
@@ -1 +1 @@
-pytest
+pytest
diff --git a/tests/test-templates/include/{{cookiecutter.project_slug}}/requirements.txt b/tests/test-templates/include/{{cookiecutter.project_slug}}/requirements.txt
@@ -2,4 +2,4 @@ pip
 {% if cookiecutter.command_line_interface|lower == 'click' -%}
 {% include 'click-requirements.jinja' %}{% endif %}
 {% if cookiecutter.use_pytest == 'y' -%}
-{% include 'pytest-requirements.jinja' %}{% endif %}
+{% include 'pytest-requirements.jinja' %}{% endif %}
diff --git a/tests/test-templates/no-templates/{{cookiecutter.project_slug}}/requirements.txt b/tests/test-templates/no-templates/{{cookiecutter.project_slug}}/requirements.txt
@@ -2,4 +2,4 @@ pip
 {% if cookiecutter.command_line_interface|lower == 'click' -%}
 Click{% endif %}
 {% if cookiecutter.use_pytest == 'y' -%}
-pytest{% endif %}
+pytest{% endif %}
diff --git a/tests/test-templates/super/templates/base-requirements.jinja b/tests/test-templates/super/templates/base-requirements.jinja
@@ -4,4 +4,4 @@ pip
 {%- block dev_dependencies %}
 {% if cookiecutter.use_pytest == 'y' -%}{% include 'pytest-requirements.jinja' %}{% endif %}
 {%- endblock %}
-{% block dependencies %}{% endblock %}
+{% block dependencies %}{% endblock %}
diff --git a/tests/test-templates/super/templates/click-requirements.jinja b/tests/test-templates/super/templates/click-requirements.jinja
@@ -1 +1 @@
-Click
+Click
diff --git a/tests/test-templates/super/templates/pytest-requirements.jinja b/tests/test-templates/super/templates/pytest-requirements.jinja
@@ -1 +1 @@
-pytest
+pytest
diff --git a/tests/test-templates/super/{{cookiecutter.project_slug}}/requirements.txt b/tests/test-templates/super/{{cookiecutter.project_slug}}/requirements.txt
@@ -1,2 +1,2 @@
 {% extends "base-requirements.jinja" %}
-{% block dev_dependencies %}{{ super() }}{% endblock %}
+{% block dev_dependencies %}{{ super() }}{% endblock %}
diff --git a/tests/test_default_extensions.py b/tests/test_default_extensions.py
@@ -59,6 +59,6 @@ def test_jinja2_uuid_extension(tmp_path):
     assert os.path.isfile(changelog_file)
 
     with Path(changelog_file).open(encoding='utf-8') as f:
-        changelog_lines = f.readlines()
+        changelog_lines = f.read().strip()
 
-    uuid.UUID(changelog_lines[0], version=4)
+    uuid.UUID(changelog_lines, version=4)
diff --git a/tests/test_generate_files.py b/tests/test_generate_files.py
@@ -45,7 +45,7 @@ def test_generate_files(tmp_path):
     assert simple_file.is_file()
 
     simple_text = Path(simple_file).read_text(encoding='utf-8')
-    assert simple_text == 'I eat pizzä'
+    assert simple_text == 'I eat pizzä\n'
 
 
 def test_generate_files_with_linux_newline(tmp_path):
@@ -305,7 +305,7 @@ def test_generate_files_with_overwrite_if_exists(tmp_path):
     assert Path(simple_with_new_line_file).exists()
 
     simple_text = Path(simple_file).read_text(encoding='utf-8')
-    assert simple_text == 'I eat pizzä'
+    assert simple_text == 'I eat pizzä\n'
 
 
 @pytest.fixture

diff --git a/tests/test_output_folder.py b/tests/test_output_folder.py
@@ -32,11 +32,12 @@ def test_output_folder():
 
     something = """Hi!
 My name is Audrey Greenfeld.
-It is 2014."""
+It is 2014.
+"""
     something2 = Path('output_folder/something.txt').read_text()
     assert something == something2
 
-    in_folder = "The color is green and the letter is D."
+    in_folder = "The color is green and the letter is D.\n"
     in_folder2 = Path('output_folder/folder/in_folder.txt').read_text()
     assert in_folder == in_folder2
 

diff --git a/tests/test_templates.py b/tests/test_templates.py
@@ -32,7 +32,7 @@ def test_build_templates(template, output_dir):
 
     readme = Path(project_dir, 'requirements.txt').read_text()
 
-    assert readme.splitlines() == [
+    assert readme.split() == [
         "pip",
         "Click",
         "pytest",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,4 +12,3 @@
		```
		// REPLACE ME: Paste a log of command(s) you ran and cookiecutter's output, tracebacks, etc, here
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,4 +50,3 @@ If a non valid value is inserted to a boolean field, the following error will be

		run_as_docker [True]: docker
		Error: docker is not a valid boolean
Original file line number	Diff line number	Diff line change
Expand Up		@@ -56,4 +56,3 @@ This snippet will achieve the exact same result as the previous one.

		For complex use cases, a python module ``local_extensions`` (a folder with an ``__init__.py``) can also be created in the template root.
		Here, for example, a module ``main.py`` would have to export all extensions with ``from .main import FoobarExtension, simplefilterextension`` or ``from .main import *`` in the ``__init__.py``.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -128,4 +128,3 @@ Pre-0.7.0, this is how it worked:
		is output to your current directory.

		* Cloned cookiecutters were not saved locally.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		I eat {{ syntax_error }} {# this comment is not closed}
		I eat {{ syntax_error }} {# this comment is not closed}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Testing that generate_file was {{ cookiecutter.generate_file }}
		Testing that generate_file was {{ cookiecutter.generate_file }}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Testing {{ cookiecutter.generate_file }}
		Testing {{ cookiecutter.generate_file }}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		I eat {{ cookiecutter.food }}
		I eat {{ cookiecutter.food }}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		The color is {{ cookiecutter.color }} and the letter is {{ cookiecutter.letter }}.
		The color is {{ cookiecutter.color }} and the letter is {{ cookiecutter.letter }}.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{% extends "base-requirements.jinja" %}
		{% extends "base-requirements.jinja" %}