开源项目最佳实践教程：TypeScript NPM 包开发栈

1. 项目介绍

本项目是一个开源模板，提供了一个完整的开发栈，用于创建与发布兼容 CommonJS (CJS) 和 ES Module (ESM) 的 TypeScript NPM 包。它包含了 TypeScript、Vitest、Biome、Prettier 和 GitHub Actions 等现代化工具，可以帮助开发者专注于编码，而无需担心打包、测试、代码格式化和部署等繁琐配置。

2. 项目快速启动

要快速启动本项目，请按照以下步骤操作：

首先，克隆项目仓库到本地：

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

然后，进入项目目录并安装依赖：

cd open-source-stack
npm install

接下来，修改 package.json 中的项目名称、仓库链接、问题和主页字段以符合你的项目：

{
  "name": "your-package-name",
  "repository": {
    "type": "git",
    "url": "https://github.com/your-username/your-repo.git"
  },
  "bugs": {
    "url": "https://github.com/your-username/your-repo/issues"
  },
  "homepage": "https://github.com/your-username/your-repo#readme"
}

之后，更改 test-apps 中的依赖项为你自己的包名，并修改 packages 目录下的文件夹名称：

{
  "dependencies": {
    "your-package-name": "^1.0.0"
  }
}

最后，添加 GitHub 仓库的 NPM_TOKEN 秘钥，并允许 GitHub Actions 创建和批准拉取请求。之后，你就可以开始编码了！

3. 应用案例和最佳实践

代码风格与格式化

使用 Biome 进行代码分析和格式化，确保代码风格一致：

pnpm run check

单元测试

利用 Vitest 测试框架进行单元测试，Vitest 是基于 Vite 的现代化测试运行器：

pnpm run test

打包发布

使用 tsdown 打包 TypeScript 代码，并自动发布到 NPM：

pnpm run build

自动化工作流

通过 GitHub Actions 实现自动化工作流，从代码提交到生产部署一气呵成。

4. 典型生态项目

本开发栈适用于各种 TypeScript NPM 包的开发，例如：

• 客户端 JavaScript 库
• 服务端 Node.js 库
• 命令行工具
• Web 应用组件

通过上述最佳实践，开发者可以快速搭建一个健壮、可维护的开源项目，并实现高效的开发工作流程。