feat: check template var to raw string

Author: colyerdeng

.yamlfmt.yaml

@@ -4,6 +4,9 @@ yaml_files:
   - ".yamlfmt"
   - "!**/vendor/**"
   - "!**/node_modules/**"
+regex_exclude:
+  - ".*\\Taskfile\\.yml$"
+  - ".*\\mkdocs\\.yml$"
 yaml_options:
   # 文档末尾是否需要一个空行
   end_of_document: true

mkdocs.yml

@@ -6,11 +6,9 @@ site_author: ShawnDen-coder
 edit_uri: edit/main/docs/
 repo_name: ShawnDen-coder/repo-scaffold
 copyright: Maintained by <a href="https://github.com/ShawnDen-coder">ShawnDen-coder</a>.
-
 nav:
   - Home: index.md
   - API Reference: reference/
-
 plugins:
   - search
   - gen-files:
@@ -33,7 +31,6 @@ plugins:
             merge_init_into_class: true
             docstring_section_style: "spacy"
             show_if_no_docstring: false
-
 theme:
   name: material
   palette:
@@ -60,7 +57,6 @@ theme:
     - search.share
     - search.suggest
     - content.code.copy
-
 markdown_extensions:
   - admonition
   - pymdownx.details
@@ -76,7 +72,6 @@ markdown_extensions:
   - tables
   - toc:
       permalink: true
-
 extra:
   social:
     - icon: fontawesome/brands/github

pyproject.toml

@@ -17,7 +17,6 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
     "ruff>=0.9.7",
-    "nox>=2024.10.9",
     "pytest>=8.3.4",
     "pytest-mock>=3.14.0",
     "pytest-cov>=6.0.0",
@@ -43,45 +42,3 @@ repo_scaffold = ["templates/**/*", "cookiecutter.json"]
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
-
-[tool.ruff]
-line-length = 120
-include = ["pyproject.toml", "repo_scaffold/*.py"]
-exclude = ["repo_scaffold/templates/**/*"]
-
-[tool.ruff.lint]
-select = [
-    "E",  # pycodestyle errors
-    "W",  # pycodestyle warnings
-    "F",  # pyflakes
-    "I",  # isort
-    "B",  # flake8-bugbear
-    "C4", # flake8-comprehensions
-    "D"   # pydocstyle
-]
-
-ignore = [
-    "W191", # indentation contains tabs
-    "D401"  # imperative mood
-]
-
-extend-ignore = [
-    "D100",  # Missing docstring in public module
-    "D104",  # Missing docstring in public package
-]
-
-[tool.ruff.lint.isort]
-force-single-line = true
-lines-after-imports = 2
-
-[tool.ruff.lint.pydocstyle]
-convention = "google"
-
-
-[tool.commitizen]
-name = "cz_conventional_commits"
-tag_format = "$version"
-version_scheme = "semver2"
-version_provider = "pep621"
-update_changelog_on_bump = true
-major_version_zero = true

repo_scaffold/cli.py

@@ -29,7 +29,6 @@
 import os
 from pathlib import Path
 from typing import Any
-from typing import Dict
 
 import click
 from cookiecutter.main import cookiecutter
@@ -43,7 +42,7 @@ def get_package_path(relative_path: str) -> str:
 
     Returns:
         str: Absolute path to the resource
-    """  # noqa: W293
+    """
     # 使用 files() 获取包资源
     package_files = importlib.resources.files("repo_scaffold")
     resource_path = package_files.joinpath(relative_path)
@@ -52,7 +51,7 @@ def get_package_path(relative_path: str) -> str:
     return str(resource_path)
 
 
-def load_templates() -> Dict[str, Any]:
+def load_templates() -> dict[str, Any]:
     """Load available project templates configuration.
 
     Reads template configurations from the cookiecutter.json file in the templates directory.
@@ -74,7 +73,7 @@ def load_templates() -> Dict[str, Any]:
         json.JSONDecodeError: If the configuration file is not valid JSON
     """
     config_path = get_package_path("templates/cookiecutter.json")
-    with open(config_path, "r", encoding="utf-8") as f:
+    with open(config_path, encoding="utf-8") as f:
         config = json.load(f)
     return config["templates"]
 
@@ -104,7 +103,7 @@ def list():
         python - template-python
           Description: template for python project
         ```
-    """  # noqa: W293
+    """
     templates = load_templates()
     click.echo("\nAvailable templates:")
     for name, info in templates.items():
@@ -147,10 +146,10 @@ def create(template: str, output_dir: Path):
             ```bash
             $ repo-scaffold list
             ```
-    """  # noqa: W293
+    """
     templates = load_templates()
 
-    # 如果没有指定模板，让 cookiecutter 处理模板选择
+    # 如果没有指定模板,让 cookiecutter 处理模板选择
     if not template:
         click.echo("Please select a template to use:")
         for name, info in templates.items():
@@ -177,7 +176,7 @@ def create(template: str, output_dir: Path):
     cookiecutter(
         template=template_path,
         output_dir=str(output_dir),
-        no_input=False,  # 启用交互式输入，让 cookiecutter 处理所有选项
+        no_input=False,  # 启用交互式输入,让 cookiecutter 处理所有选项
     )
 
 

repo_scaffold/templates/template-python/{{cookiecutter.project_slug}}/.github/workflows/bump_version.yaml

@@ -9,17 +9,17 @@ permissions:
   pull-requests: write # 用于创建 PR
 jobs:
   bump-version:
-    if: ${{ !startsWith(github.event.head_commit.message, 'bump:') }}
+    if: {% raw %}${{ !startsWith(github.event.head_commit.message, 'bump:') }}{% endraw %}
     runs-on: ubuntu-latest
     name: Bump version and create changelog with commitizen
     steps:
       - name: Check out
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          token: {% raw %}${{ secrets.PERSONAL_ACCESS_TOKEN }}{% endraw %}
       - name: Create bump and changelog
         uses: commitizen-tools/commitizen-action@master
         with:
-          github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          github_token: {% raw %}${{ secrets.PERSONAL_ACCESS_TOKEN }}{% endraw %}
           branch: master

repo_scaffold/templates/template-python/{{cookiecutter.project_slug}}/.github/workflows/deploy_docs.yaml

@@ -19,4 +19,4 @@ jobs:
       - name: Build and deploy documentation
         run: task deploy:gh-pages
         env:
-          GITHUB_TOKEN: ${{ github.token }}
+          GITHUB_TOKEN: {% raw %}${{ github.token }}{% endraw %}

repo_scaffold/templates/template-python/{{cookiecutter.project_slug}}/.github/workflows/docker_release.yaml

@@ -16,14 +16,14 @@ jobs:
       - name: Login to Docker Hub
         uses: docker/login-action@v3
         with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          username: {% raw %}${{ secrets.DOCKERHUB_USERNAME }}{% endraw %}
+          password: {% raw %}${{ secrets.DOCKERHUB_TOKEN }}{% endraw %}
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v3
         with:
           registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          username: {% raw %}${{ github.actor }}{% endraw %}
+          password: {% raw %}${{ secrets.PERSONAL_ACCESS_TOKEN }}{% endraw %}
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
@@ -33,10 +33,10 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            ${{ env.DOCKERHUB_IMAGE_NAME }}
-            ${{ env.GITHUB_IMAGE_NAME }}
+            {% raw %}${{ env.DOCKERHUB_IMAGE_NAME }}{% endraw %}
+            {% raw %}${{ env.GITHUB_IMAGE_NAME }}{% endraw %}
           tags: |
-            type=raw,value=latest,enable={{is_default_branch}}
+            {% raw %}type=raw,value=latest,enable={{is_default_branch}}{% endraw %}
             type=ref,event=tag
             type=ref,event=pr
             type=sha,format=short
@@ -47,5 +47,5 @@ jobs:
           file: ./docker/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          tags: {% raw %}${{ steps.meta.outputs.tags }}{% endraw %}
+          labels: {% raw %}${{ steps.meta.outputs.labels }}{% endraw %}

repo_scaffold/templates/template-python/{{cookiecutter.project_slug}}/.github/workflows/release_build.yaml

@@ -24,7 +24,7 @@ jobs:
           task test:all # 运行所有测试
       - name: Publish to PyPI
         env:
-          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+          UV_PUBLISH_TOKEN: {% raw %}${{ secrets.PYPI_TOKEN }}{% endraw %}
         run: task deploy:pypi
       - name: Release
         uses: softprops/action-gh-release@v2
@@ -34,4 +34,4 @@ jobs:
             dist/*.whl
           generate_release_notes: true
         env:
-          GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          GITHUB_TOKEN: {% raw %}${{ secrets.PERSONAL_ACCESS_TOKEN }}{% endraw %}

repo_scaffold/templates/template-python/{{cookiecutter.project_slug}}/mkdocs.yml

@@ -1,4 +1,4 @@
-site_name: {{cookiecutter.project_slug}}
+site_name: '{{cookiecutter.project_slug}}'
 repo_url: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}
 site_url: https://{{cookiecutter.github_username}}.github.io/{{cookiecutter.project_slug}}
 site_description: {{cookiecutter.description}}

tests/test_import.py

@@ -5,13 +5,14 @@
 
 import repo_scaffold
 
+
 def test_imports():
     """Test import modules."""
-    prefix = "{}.".format(repo_scaffold.__name__) # noqa
+    prefix = "{}.".format(repo_scaffold.__name__)  # noqa
     iter_packages = pkgutil.walk_packages(
-        repo_scaffold.__path__,  # noqa
+        repo_scaffold.__path__,
         prefix,
     )
     for _, name, _ in iter_packages:
         module_name = name if name.startswith(prefix) else prefix + name
-        importlib.import_module(module_name)
+        importlib.import_module(module_name)