Skip to content
On this page

合理的项目目录结构

开发一个npm包的常见目录如下:

md
coverage // 覆盖率测试报告

src
├── index.ts // 工程入口文件,其他代码文件在这里汇总导出
|
└── other.ts

test
├── index.test.ts // 对应src工程下的测试用例文件
|
└── other.test.ts

.cz-config.cjs // 自定义git提交时交互界面提示流程和内容

.eslintrc.cjs // `eslint`语法校验配置

.npmrc // npm运行时配置文件

.prettierrc.cjs // 代码格式化配置

LICENSE // 协议许可文件

package.json // 项目配置文件(包含项目信息、运行命令、依赖文件等)

README.md // 项目的入门手册,介绍了整个项目的使用、功能等等

tsconfig.json // `typescript`编译器的配置文件

vitest.config.ts // 测试框架配置文件