TypeScript 强力支持的 Glimmer 模板工具——glint 指南

TypeScript 强力支持的 Glimmer 模板工具——glint 指南

glint TypeScript powered tooling for Glimmer templates 项目地址: https://gitcode.com/gh_mirrors/gli/glint

一、项目目录结构及介绍

glint 是一个专门为使用 Glimmer VM 渲染技术（如 Ember.js v3.24+）的项目设计的 TypeScript 助力工具套件。以下是该仓库的基础目录结构概述及其简介：

- main/
  - 核心代码库，通常包括主程序逻辑。
- branches/
  - 不属于当前仓库分支的提交可能存储在此，或是合并前暂存区。
- tags/
  - 项目发布的不同版本标记。
- github/workflows/
  - GitHub Actions 的工作流程定义，用于自动化任务如CI/CD。
- vscode/
  - 针对 Visual Studio Code 的定制化设置或扩展相关文件。
- docs/
  - 文档目录，存放用户指南、API参考等。
- packages/
  - 分离的npm包，如核心库(@glint/core)和其他环境特定包。
- test-packages/
  - 测试用的包或示例项目。
- eslintignore, eslintrc, gitattributes, gitbook.yaml, gitignore, prettierignore, prettierrc, release-it.yml
  - 项目维护相关的配置文件，涵盖了代码风格、构建发布和版本管理。
- ARCHITECTURE.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, README.md
  - 项目架构、行为准则、贡献指导、许可证和主要的读我文件。
- package.json, tsconfig.*.json, yarn.lock
  - 包管理配置，TypeScript编译选项和Yarn依赖锁定文件。

二、项目的启动文件介绍

在 glint 中，并没有一个直接的传统意义上的“启动文件”，它更依赖于命令行工具和编辑器插件进行交互。关键的执行入口是通过 bin 目录下的脚本（虽然这里未列出，实际项目中常见），主要是 glint 和 glint-language-server。

• glint: 类似于 tsc, 用于在命令行类型检查项目，理解模板内值的流动。
• glint-language-server: 提供给编辑器集成，以提供实时反馈、类型信息显示、自动重构等功能。

启动场景：

• 在项目本地开发时，可通过 npx glint --watch 来监视并即时反馈类型检查结果。
• 在CI环境中，通过脚本调用 glint 确保模板代码的质量。

三、项目的配置文件介绍

• tsconfig.json: 关键的配置文件，项目不仅需要标准的 TypeScript 设置，还要添加一个 "glint" 键来指定Glint应关注哪些部分，告诉Glint如何与你的项目集成。

  {
    // 基础TypeScript配置
    ...
    "glint": {
      // 具体配置项，指示Glint的工作范围或特定规则
    }
  }
  

• gitbook.yaml: 如果存在，用来配置GitBook的书籍结构和元数据，对于文档站点至关重要，但与运行项目本身不直接相关。

• release-it.yml: 版本发布管理的配置，自动化版本更新、标签创建和发布到npm的过程。

以上概括了glint项目的关键结构、启动概念以及配置要点，为开发者提供了一个快速理解和上手的框架。

glint TypeScript powered tooling for Glimmer templates 项目地址: https://gitcode.com/gh_mirrors/gli/glint