refactor: use trim_blocks and lstrip_blocks to avoid unnecessary whitespace control (#814)

Author: huxuan

copier.yaml

@@ -1,6 +1,8 @@
 _envops:
-  block_end_string: '%]'
-  block_start_string: '[%'
+  block_end_string: "%]"
+  block_start_string: "[%"
+  lstrip_blocks: true
+  trim_blocks: true
 _subdirectory: template
 _message_before_copy: |
   Thanks for generating a project using our template.
@@ -20,7 +22,7 @@ _message_after_update: |
   you're done.
 project_name:
   default: My Project
-  help: 'Enter the name of the project in CamelCase format:'
+  help: "Enter the name of the project in CamelCase format:"
   type: str
 project_description:
   default: Project brief description.
@@ -32,7 +34,7 @@ development_status:
     - Alpha
     - Beta
     - Production/Stable
-  help: 'Choose the development status:'
+  help: "Choose the development status:"
   type: str
 copyright_license:
   default: MIT License
@@ -53,65 +55,65 @@ copyright_year:
   type: str
 author_name:
   default: Your Name
-  help: 'Specify the name of the author:'
+  help: "Specify the name of the author:"
   type: str
 organization_name:
   default: Your Organization Name
-  help: 'Provide the name of the organization associated with the project:'
+  help: "Provide the name of the organization associated with the project:"
   type: str
 copyright_holder:
-  default: '{{ organization_name }}'
+  default: "{{ organization_name }}"
   help: Name(s) or organization(s) holding the copyright.
   type: str
 author_email:
   default: '{{ author_name|lower|replace(" ", ".") }}@{{ organization_name|lower|replace(" ", "-") }}.com'
-  help: 'Specify the email address of the author:'
+  help: "Specify the email address of the author:"
   type: str
 repo_platform:
   default: github
   choices:
     GitHub: github
     GitLab: gitlab
     GitLab (self-managed): gitlab-self-managed
-  help: 'Choose the platform for the repository:'
+  help: "Choose the platform for the repository:"
   type: str
 repo_host:
   default: |-
-    [% if repo_platform == 'github' -%]
-      github.com
-    [%- elif repo_platform == 'gitlab' -%]
-      gitlab.com
+    [% if repo_platform == 'github' %]
+    github.com
+    [%- elif repo_platform == 'gitlab' %]
+    gitlab.com
     [%- endif %]
-  help: 'Specify the host of the self-managed GitLab:'
+  help: "Specify the host of the self-managed GitLab:"
   type: str
   when: '{{ repo_platform == "gitlab-self-managed" }}'
 page_host:
   default: |-
-    [% if repo_platform == 'github' -%]
-      github.io
-    [%- elif repo_platform == 'gitlab' -%]
-      gitlab.io
+    [% if repo_platform == 'github' %]
+    github.io
+    [%- elif repo_platform == 'gitlab' %]
+    gitlab.io
     [%- endif %]
-  help: 'Specify the host of the self-managed GitLab Pages:'
+  help: "Specify the host of the self-managed GitLab Pages:"
   type: str
   when: '{{ repo_platform == "gitlab-self-managed" }}'
 container_registry_host:
   default: |-
-    [% if repo_platform == 'github' -%]
-      ghcr.io
-    [%- elif repo_platform == 'gitlab' -%]
-      registry.gitlab.com
+    [% if repo_platform == 'github' %]
+    ghcr.io
+    [%- elif repo_platform == 'gitlab' %]
+    registry.gitlab.com
     [%- endif %]
-  help: 'Specify the host of the self-managed GitLab Container Registry:'
+  help: "Specify the host of the self-managed GitLab Container Registry:"
   type: str
   when: '{{ repo_platform == "gitlab-self-managed" }}'
 repo_namespace:
   default: '{{ organization_name|lower|replace(" ", "-") }}'
-  help: 'Indicate the GitHub Repository Owner or GitLab Namespace. This is typically the account name of the author or the organization:'
+  help: "Indicate the GitHub Repository Owner or GitLab Namespace. This is typically the account name of the author or the organization:"
   type: str
 repo_name:
   default: '{{ project_name|lower|replace(" ", "-") }}'
-  help: 'Provide a name for the repository:'
+  help: "Provide a name for the repository:"
   type: str
 package_name:
   default: '{{ repo_name|regex_replace("-python$", "") }}'
@@ -123,7 +125,7 @@ module_name:
   type: str
 coverage_threshold:
   default: 100
-  help: 'Set the threshold for test coverage, ranging from 0 to 100:'
+  help: "Set the threshold for test coverage, ranging from 0 to 100:"
   type: int
   validator: "[% if not 0 <= coverage_threshold <= 100 %]Test Coverage threshold should be between 0 and 100[% endif %]"
 platforms:
@@ -136,59 +138,59 @@ platforms:
   multiselect: true
   type: str
 min_py:
-  default: '3.12'
+  default: "3.12"
   choices:
-    - '3.9'
-    - '3.10'
-    - '3.11'
-    - '3.12'
-    - '3.13'
-  help: 'Choose the minimal Python version the project should support:'
+    - "3.9"
+    - "3.10"
+    - "3.11"
+    - "3.12"
+    - "3.13"
+  help: "Choose the minimal Python version the project should support:"
   type: str
 max_py:
-  default: '3.12'
+  default: "3.12"
   choices:
-    '3.9':
+    "3.9":
       validator: '[% from pathjoin("includes", "version_compare.jinja") import version_higher_than_validator %]{{ version_higher_than_validator("3.9", min_py) }}'
-      value: '3.9'
-    '3.10':
+      value: "3.9"
+    "3.10":
       validator: '[% from pathjoin("includes", "version_compare.jinja") import version_higher_than_validator %]{{ version_higher_than_validator("3.10", min_py) }}'
-      value: '3.10'
-    '3.11':
+      value: "3.10"
+    "3.11":
       validator: '[% from pathjoin("includes", "version_compare.jinja") import version_higher_than_validator %]{{ version_higher_than_validator("3.11", min_py) }}'
-      value: '3.11'
-    '3.12':
+      value: "3.11"
+    "3.12":
       validator: '[% from pathjoin("includes", "version_compare.jinja") import version_higher_than_validator %]{{ version_higher_than_validator("3.12", min_py) }}'
-      value: '3.12'
-    '3.13':
-      value: '3.13'
-  help: 'Choose the maximal Python version the project should support:'
+      value: "3.12"
+    "3.13":
+      value: "3.13"
+  help: "Choose the maximal Python version the project should support:"
   type: str
 default_py:
-  default: '{{ max_py }}'
+  default: "{{ max_py }}"
   choices:
-    '3.9':
+    "3.9":
       validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.9", min_py, max_py) }}'
-      value: '3.9'
-    '3.10':
+      value: "3.9"
+    "3.10":
       validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.10", min_py, max_py) }}'
-      value: '3.10'
-    '3.11':
+      value: "3.10"
+    "3.11":
       validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.11", min_py, max_py) }}'
-      value: '3.11'
-    '3.12':
+      value: "3.11"
+    "3.12":
       validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.12", min_py, max_py) }}'
-      value: '3.12'
-    '3.13':
+      value: "3.12"
+    "3.13":
       validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.13", min_py, max_py) }}'
-      value: '3.13'
-  help: 'Choose the default Python version for development, documentation generation, and package build:'
+      value: "3.13"
+  help: "Choose the default Python version for development, documentation generation, and package build:"
   type: str
 readme_content:
   default: |-
-    [% if project_name == 'Serious Scaffold Python' -%]
-      [% from pathjoin("includes", "sample.jinja") import readme_content with context %]{{ readme_content() }}
-    [%- else -%]
+    [% if project_name == 'Serious Scaffold Python' %]
+    [% from pathjoin("includes", "sample.jinja") import readme_content with context %]{{ readme_content() }}
+    [%- else %]
     ## A multiline README content here
     [%- endif %]
   help: "Provide a multiline content to be used in the README and documentation's index page:"

includes/sample.jinja

@@ -1,14 +1,13 @@
-[% macro readme_content() -%]
-[% from pathjoin("includes", "variable.jinja") import page_url with context -%]
-[% from pathjoin("includes", "variable.jinja") import repo_url with context -%]
+[% macro readme_content() %]
+[% from pathjoin("includes", "variable.jinja") import page_url with context %]
+[% from pathjoin("includes", "variable.jinja") import repo_url with context %]
 [![{{ project_name }}](https://{{ page_url() }}/_static/images/logo.svg)](https://{{ repo_url() }})
 
 Serious Scaffold Python is crafted for long-term, maintainable Python projects. It includes GitHub Actions and GitLab CI/CD, automated dependency updates via Renovate, and comprehensive linting, testing, and documentation. Key integrations like pdm for environment and dependency management, click for CLI development, and pydantic for configuration enhance project robustness. With copier’s easy project setup and continuous updating, your project stays aligned with best practices for sustainable development. Pre-configured dev containers and cross-platform CI support ensure maintainability from the start.
 
-[% if repo_platform == 'github' -%]
+[% if repo_platform == 'github' %]
 If you find this helpful, please consider [sponsorship](https://github.com/sponsors/{{ author_name }}).
-
-[% endif -%]
+[% endif %]
 
 ## 🛠️ Features
 
@@ -76,5 +75,4 @@ pipx install copier==9.4.1
    ```
 
 1. That's it! Feel free to focus on the coding within `src` folder.
-
-[%- endmacro %]
+[% endmacro %]

includes/variable.jinja

@@ -1,75 +1,75 @@
-[% macro coverage_badge() -%]
-  [% if repo_platform == 'github' -%]
+[% macro coverage_badge() %]
+  [% if repo_platform == 'github' %]
 [![Coverage](https://img.shields.io/endpoint?url=https://{{ page_url() }}/_static/badges/coverage.json)](https://{{ page_url() }}/reports/coverage)
-  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' -%]
+  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' %]
 [![coverage report](https://{{ repo_url() }}/badges/main/coverage.svg)](https://{{ repo_url() }}/-/commits/main)
   [%- endif %]
-[%- endmacro %]
+[% endmacro %]
 
-[% macro license_badge() -%]
-  [% if repo_platform == 'github' -%]
+[% macro license_badge() %]
+  [% if repo_platform == 'github' %]
 [![GitHub](https://img.shields.io/github/license/{{ repo_namespace }}/{{ repo_name }})]({{ license_url() }})
-  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' -%]
+  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' %]
 [![GitLab](https://img.shields.io/gitlab/license/{{ repo_namespace }}/{{ repo_name }}?gitlab_url=https%3A%2F%2F{{ repo_host }})]({{ license_url() }})
-  [%- endif -%]
-[%- endmacro %]
+  [%- endif %]
+[% endmacro %]
 
-[% macro license_url() -%]
-  [% if repo_platform == 'github' -%]
-    https://{{ repo_url() }}/blob/main/LICENSE
-  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' -%]
-    https://{{ repo_url() }}/-/blob/main/LICENSE
-  [%- endif -%]
-[%- endmacro %]
+[% macro license_url() %]
+  [% if repo_platform == 'github' %]
+https://{{ repo_url() }}/blob/main/LICENSE
+  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' %]
+https://{{ repo_url() }}/-/blob/main/LICENSE
+  [%- endif %]
+[% endmacro %]
 
-[% macro logo_badge() -%]
-  [![Serious Scaffold Python]({{ logo_badge_url() }})](https://serious-scaffold.github.io/ss-python)
+[% macro logo_badge() %]
+[![Serious Scaffold Python]({{ logo_badge_url() }})](https://serious-scaffold.github.io/ss-python)
 [%- endmacro %]
 
-[% macro logo_badge_url() -%]
-  https://img.shields.io/endpoint?url=https://serious-scaffold.github.io/ss-python/_static/badges/logo.json
+[% macro logo_badge_url() %]
+https://img.shields.io/endpoint?url=https://serious-scaffold.github.io/ss-python/_static/badges/logo.json
 [%- endmacro %]
 
-[% macro page_url() -%]
-  [% if repo_platform == 'github' -%]
-    {{ repo_namespace }}.github.io/{{ repo_name }}
-  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' -%]
-    [%- set repo_namespace_root = repo_namespace.split("/")[0] -%]
-    {{ repo_namespace_root }}.{{ page_host }}{{ repo_namespace | replace(repo_namespace_root, "", 1) }}/{{ repo_name }}
+[% macro page_url() %]
+  [% if repo_platform == 'github' %]
+{{ repo_namespace }}.github.io/{{ repo_name }}
+  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' %]
+[% set repo_namespace_root = repo_namespace.split("/")[0] %]
+{{ repo_namespace_root }}.{{ page_host }}{{ repo_namespace | replace(repo_namespace_root, "", 1) }}/{{ repo_name }}
   [%- endif %]
-[%- endmacro %]
+[% endmacro %]
 
-[% macro pipeline_badge() -%]
-  [% if repo_platform == 'github' -%]
+[% macro pipeline_badge() %]
+[% if repo_platform == 'github' %]
 [![CI](https://{{ repo_url() }}/actions/workflows/ci.yml/badge.svg)](https://{{ repo_url() }}/actions/workflows/ci.yml)
 [![CommitLint](https://{{ repo_url() }}/actions/workflows/commitlint.yml/badge.svg)](https://{{ repo_url() }}/actions/workflows/commitlint.yml)
 [![DevContainer](https://{{ repo_url() }}/actions/workflows/devcontainer.yml/badge.svg)](https://{{ repo_url() }}/actions/workflows/devcontainer.yml)
 [![Release](https://{{ repo_url() }}/actions/workflows/release.yml/badge.svg)](https://{{ repo_url() }}/actions/workflows/release.yml)
 [![Renovate](https://{{ repo_url() }}/actions/workflows/renovate.yml/badge.svg)](https://{{ repo_url() }}/actions/workflows/renovate.yml)
 [![Semantic Release](https://{{ repo_url() }}/actions/workflows/semantic-release.yml/badge.svg)](https://{{ repo_url() }}/actions/workflows/semantic-release.yml)
-  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' -%]
+  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' %]
 [![pipeline status](https://{{ repo_url() }}/badges/main/pipeline.svg)](https://{{ repo_url() }}/-/commits/main)
   [%- endif %]
-[%- endmacro %]
+[% endmacro %]
 
-[% macro releases_url() -%]
-  [% if repo_platform == 'github' -%]
-    https://{{ repo_url() }}/releases
-  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' -%]
-    https://{{ repo_url() }}/-/releases
-  [%- endif -%]
-[%- endmacro %]
+[% macro releases_url() %]
+  [% if repo_platform == 'github' %]
+https://{{ repo_url() }}/releases
+  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' %]
+https://{{ repo_url() }}/-/releases
+  [%- endif %]
+[% endmacro %]
 
-[% macro release_badge() -%]
-  [% if repo_platform == 'github' -%]
+[% macro release_badge() %]
+  [% if repo_platform == 'github' %]
 [![Release](https://img.shields.io/github/v/release/{{ repo_namespace }}/{{ repo_name }})]
-  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' -%]
+  [%- elif repo_platform == 'gitlab' or repo_platform == 'gitlab-self-managed' %]
 [![Latest Release](https://{{ repo_url() }}/-/badges/release.svg)]
-  [%- endif -%]
+  [%- endif %]
 ({{ releases_url()}})
 [![PyPI](https://img.shields.io/pypi/v/{{ package_name }})](https://pypi.org/project/{{ package_name }}/)
 [%- endmacro %]
 
-[% macro repo_url() -%]
-  {{ repo_host }}/{{ repo_namespace }}/{{ repo_name }}
+[% macro repo_url() %]
+{{ repo_host }}/{{ repo_namespace }}/{{ repo_name }}
 [%- endmacro %]