ZK-Kit 开源项目使用教程

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

ZK-Kit 是一个为零知识技术提供可重用库的单仓库（monorepo）项目。以下是其主要目录结构及介绍：

zk-kit/
├── .github/              # GitHub 工作流和其他 GitHub 配置文件
├── .husky/               # Husky 配置文件，用于 Git 钩子
├── .yarn/                # Yarn 配置文件
├── benchmarks/           # 性能测试相关代码和结果
├── packages/             # 包含所有库的目录
│   ├── eddsa-poseidon/
│   ├── poseidon-cipher/
│   ├── baby-jubjub/
│   ├── utils/
│   ├── imt/
│   ├── lean-imt/
│   ├── smt/
│   ├── poseidon-proof/
│   └── logical-expressions/
├── papers/               # 相关论文和文档
├── scripts/              # 脚本目录，包含构建和部署脚本
├── types/                # TypeScript 类型定义
├── .commitlintrc.js      # Conventional Commits 配置文件
├── .editorconfig         # 编辑器配置文件
├── .eslintrc.json        # ESLint 配置文件
├── .gitignore            # Git 忽略文件
├── .lintstagedrc.json    # Lint-staged 配置文件
├── .prettierrc.json      # Prettier 配置文件
├── CODE_OF_CONDUCT.md    # 行为准则
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE               # 许可证文件
├── README.md             # 项目说明文件
├── changelogithub.config.json # GitHub Changelog 配置文件
├── jest.config.ts        # Jest 测试配置文件
├── package.json          # 项目包配置文件
├── tsconfig.json         # TypeScript 配置文件
├── turbo.json            # Turborepo 配置文件
└── typedoc.js            # TypeDoc 文档生成配置文件

2. 项目的启动文件介绍

项目的启动主要是通过 Yarn 来管理。以下是一些主要的启动命令：

• yarn：安装项目依赖。
• yarn build：构建所有包。
• yarn test：测试所有包。
• yarn docs：生成文档。

每个包的 package.json 文件中都定义了特定的启动脚本，例如：

"scripts": {
  "build": "tsc && rollup -c",
  "test": "jest",
  "docs": "typedoc"
}

3. 项目的配置文件介绍

以下是项目中的主要配置文件及其作用：

• .commitlintrc.js：配置 Conventional Commits，用于规范提交信息。
• .editorconfig：配置编辑器，确保不同开发者的代码风格一致。
• .eslintrc.json：配置 ESLint，用于代码质量检查。
• .gitignore：配置 Git 忽略文件，避免将不必要的文件提交到仓库。
• .lintstagedrc.json：配置 Lint-staged，用于在提交代码前进行代码检查。
• .prettierrc.json：配置 Prettier，用于代码格式化。
• jest.config.ts：配置 Jest，用于单元测试。
• tsconfig.json：配置 TypeScript，用于编译 TypeScript 代码。
• typedoc.js：配置 TypeDoc，用于生成文档。