tmplt

一个用户友好的CLI工具，用于使用模板创建新项目

关于

tmplt 是一款命令行工具，允许用户快速创建基于模板的新项目。使用 tmplt，用户可以创建一个包含所有必要文件和依赖项的新项目，以便他们可以立即开始他们的项目。

使用 tmplt，用户可以创建定义新项目结构和依赖项的模板。这些模板可以根据特定项目需求进行定制并与他人共享。 tmplt 提供了一种简单而灵活的语法来定义模板，可以包括变量、文件和依赖项。

模板 定义在一个 yaml 文件中，列出了要生成的所有文件、要安装的依赖项以及要替换的变量。

模板

模板 是包含有关项目、其依赖项、要生成的文件和变量的信息的文件。用户可以使用这些模板轻松设置项目。

模板文件是以 YAML 格式编写的，并包含以下信息

• 名称：模板的名称。

• 描述：模板的简短描述。

• 依赖项：项目所需的依赖项列表。每个依赖项包含一个名称和一个安装命令。

• 文件：要为项目生成的文件列表。每个文件包含一个名称和要写入文件的内容。

• 变量：可以在模板中使用的变量列表。每个变量包含一个名称、描述和默认值。

用户可以创建自己的 模板 或从互联网下载。要从 模板 创建一个新项目，只需运行 tmplt new 命令并提供模板名称。工具将生成所有必要的文件并安装所需的依赖项。有关如何使用该工具的更多信息，请参阅 usage.md

以下是一个 Pygame 项目的 模板 示例

# Pygame Project Template

# Template information
name: Pygame Project
description: A template for creating a Pygame project

# Dependency information
dependencies:
  - name: Pygame
    install_command: pip install pygame

# Files to generate
files:
  - name: main.py
    content: |
      import pygame

      # Set up pygame
      pygame.init()

      # Set up the display
      screen_width = {screen_width}
      screen_height = {screen_height}
      screen = pygame.display.set_mode((screen_width, screen_height))
      pygame.display.set_caption("{app_name}")

      # Game loop
      running = True
      while running:
          # Event handling
          for event in pygame.event.get():
              if event.type == pygame.QUIT:
                  running = False

          # Game logic

          # Draw to screen
          screen.fill((255, 255, 255))
          pygame.display.flip()

      # Clean up pygame
      pygame.quit()


# Variables
variables:
  - name: app_name
    description: The name of the pygame app
    default: my_pygame_app

  - name: screen_width
    description: The screen width of the pygame app
    default: 800

  - name: screen_height
    description: The screen height of the pygame app
    default: 600

安装

您可以通过几种方法安装 tmplt

发布

您可以访问 发布页面，并从那里下载针对目标操作系统的官方 tmplt 二进制文件。也提供了 Windows MSI 安装程序

Cargo 存储库

您可以使用以下命令通过 Cargo 存储库安装 tmplt

$ cargo install tmplt

源代码

点击 此处 了解如何操作

未来还将添加更多安装方法！

用法

点击 此处 了解如何使用该工具

贡献

对 tmplt 的贡献始终受到欢迎！有关更多信息，请参阅 贡献指南

许可

本项目采用 MIT 许可证和 Apache 许可证