open-source-stack 的安装和配置教程

项目基础介绍

open-source-stack 是一个为了帮助开发者轻松构建和发布遵循 CommonJS (CJS) 和 ES Module (ESM) 标准的 npm 包的模板项目。它使用 TypeScript 作为主要的编程语言，并提供了一套完整的工具链，包括测试、格式化、打包和持续集成等功能。

项目使用的关键技术和框架

• TypeScript：TypeScript 是 JavaScript 的一个超集，添加了静态类型选项。它可以帮助开发者在代码编写阶段发现错误。
• Vitest：一个基于 Vite 的现代测试运行器，用于执行单元测试。
• Biome：一个静态代码分析工具，用于发现代码中的问题，并以一致的样式格式化代码。
• GitHub Actions：用于自动化工作流程，例如自动执行测试和部署。
• tsdown：一个简单的配置型打包工具，基于 rolldown。
• Changeset：用于管理版本和更新日志的工具，尤其适用于多仓库。
• pnpm workspaces：用于管理单个仓库中多个包的工具。

准备工作和安装步骤

准备工作

在开始安装之前，请确保您已经安装了以下工具：

• Git：用于克隆和操作项目仓库。
• Node.js 和 npm：项目的运行环境，Node.js 通常会包含 npm。
• GitHub 帐户：用于托管项目和自动化工作流程。

安装步骤

1. 克隆项目仓库到本地：

   git clone https://github.com/forge42dev/open-source-stack.git
   

2. 进入项目目录：

   cd open-source-stack
   

3. 更改项目中的包名称。在 package.json 文件中，修改 name 字段的值。

4. 更改测试应用中引用的项目名称。在 test-apps 目录下，将所有的 open-source-stack 替换为你自己的包名称。

5. 安装项目依赖：

   npm install
   

6. 修改 package.json 中的 repository、bugs 和 homepage 字段，以匹配你的 GitHub 仓库信息。

7. 如果需要，更改许可证类型。

8. 在你的 GitHub 仓库中添加 NPM_TOKEN 秘钥，以便自动化部署到 npm。

9. 允许 GitHub Actions 自动创建和批准 pull requests。这可以在仓库的设置中的 Actions 选项中完成。

10. 开始编码你的开源项目，并使用以下脚本进行构建、测试和开发：

• 构建：pnpm run build
• 运行测试：pnpm run test
• 开发模式：pnpm run dev

按照这些步骤操作后，你的开源项目就应该已经安装并配置好了，可以开始开发工作了。