TypeScript-Go 项目教程

TypeScript-Go 项目教程

typescript-go Staging repo for development of native port of TypeScript 项目地址: https://gitcode.com/gh_mirrors/ty/typescript-go

1. 项目的目录结构及介绍

TypeScript-Go 是一个将 TypeScript 编译器移植到 Go 语言的项目的 staging仓库。以下是项目的目录结构及各个部分的简要介绍：

• cmd/tsgo: 包含 TypeScript-Go 的主命令行工具。
• internal: 内部模块和工具，包括 TypeScript 的核心逻辑。
• testdata: 测试数据，用于验证 TypeScript-Go 的功能。
• .devcontainer: 用于开发容器配置的文件。
• .github: 包含 GitHub 工作流程的文件。
• .vscode: 包含 Visual Studio Code 项目配置的文件。
• CHANGES.md: 记录了项目中的重要变更和更新。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• LICENSE: Apache-2.0 许可证文件。
• README.md: 项目说明文件。
• SECURITY.md: 安全策略文件。
• SUPPORT.md: 支持信息文件。
• go.mod 和 go.sum: Go 依赖管理文件。
• package.json 和 package-lock.json: Node.js 项目的配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 cmd/tsgo 目录下的主文件进行。以下是启动项目的步骤：

1. 确保安装了 Go 1.24 或更高版本以及 Node.js 和 npm。

2. 克隆项目并初始化子模块：

   git clone --recurse-submodules https://github.com/microsoft/typescript-go.git
   

   如果已经克隆了项目，可以使用以下命令初始化子模块：

   git submodule update --init --recursive
   

3. 运行 npm ci 安装项目依赖。

4. 使用 hereby 工具执行构建、测试等任务。例如：

   hereby build
   

   来验证项目是否成功构建。

5. 构建完成后，可以运行 built/local/tsgo 来执行 TypeScript-Go。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几部分：

• tsconfig.json: TypeScript 配置文件，用于指定编译器选项、文件包含和排除规则等。
• .gitignore: 指定 Git 忽略的文件和目录。
• go.mod 和 go.sum: 管理项目的 Go 依赖。
• package.json 和 package-lock.json: 管理项目的 Node.js 依赖。

这些配置文件帮助维护项目结构和依赖，确保项目可以正确构建和运行。对于 TypeScript-Go 的具体配置，可能需要根据项目的具体需求进行调整。

typescript-go Staging repo for development of native port of TypeScript 项目地址: https://gitcode.com/gh_mirrors/ty/typescript-go