TypeScript Macros 使用指南

TypeScript Macros 使用指南

欢迎来到 TypeScript Macros 的快速入门指南。TypeScript Macros 是一个强大的 TypeScript 转换器/插件，它使你能为 TypeScript 编写宏，以在编译阶段执行代码生成和其他元编程任务。

1. 项目目录结构及介绍

TypeScript Macros 的项目结构精心设计，便于维护和贡献：

• src: 核心源代码目录，存放宏实现相关的 TypeScript 文件。
• test: 测试用例目录，确保宏功能正确无误。
• .gitignore: Git 忽略文件，指定不应被版本控制的文件或目录。
• license: 项目使用的 MIT 许可证文件，描述了软件分发和使用的法律条款。
• README.md: 项目的主要说明文件，包含简介、安装步骤、基本使用方法等。
• package.json: 包含项目 metadata，依赖项，以及npm脚本等。
• tsconfig.json: TypeScript 配置文件，指导TypeScript编译器如何处理源代码。
• prettierignore 和 eslintignore: 分别指示Prettier和ESLint忽略特定文件或目录。
• docs 和 playground: 文档和在线交互式演示，帮助开发者学习和实践。
• package-lock.json: 详细记录依赖关系树，确保复现相同的依赖环境。

2. 项目的启动文件介绍

对于此类库项目，通常没有直接的“启动”文件用于运行应用，而是通过npm脚本管理构建、测试等任务。在 package.json 中定义的脚本如 "start" 或 "dev" 通常是开发服务器或构建流程的入口点，但对于 TypeScript Macros，重点在于它的编译过程（由TypeScript编译器触发），以及可能存在的测试脚本（例如 "test"）来验证宏的功能性。

3. 项目的配置文件介绍

tsconfig.json

在 TypeScript 项目中，tsconfig.json 是核心配置文件，对于 TypeScript Macros 来说也不例外。此文件定义了编译选项，包括但不限于：

• compilerOptions: 指定了编译时的行为，比如目标JavaScript版本、是否启用严格类型检查等。
• plugins: 当结合 ts-patch 使用时，需要在此处添加 [ "transform": "ts-macros" ] 来启用宏处理。
• noEmitOnError: 确保在有错误的情况下不生成输出，保持代码质量。
• 其他根据项目需求定制的设置。

为了将 TypeScript Macros 添加到你的项目，你需要修改你的 tsconfig.json，加入相应的转换器配置，确保宏能够正常工作。

示例配置

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es2015",
    "strict": true,
    "plugins": [
      { "transform": "ts-macros", "noComptime": true }
    ]
  },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules"]
}

这份配置示例展示了如何集成 TypeScript Macros，并启用了必要的编译选项以支持其功能。

通过以上三个部分的介绍，你现在应该对 TypeScript Macros 的基础架构有了清晰的理解，可以继续探索宏的编写和应用，提升你的TypeScript开发效率。