ts-enum-util 项目教程
1. 项目的目录结构及介绍
ts-enum-util/
├── docs/
│ └── EnumWrapper.md
├── src/
│ ├── EnumWrapper.ts
│ └── index.ts
├── test/
│ └── EnumWrapper.test.ts
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json
docs/
: 包含项目的文档文件,如EnumWrapper.md
。src/
: 包含项目的源代码文件,如EnumWrapper.ts
和index.ts
。test/
: 包含项目的测试文件,如EnumWrapper.test.ts
。.gitignore
: 指定 Git 版本控制系统忽略的文件和目录。package.json
: 项目的配置文件,包含依赖、脚本等信息。README.md
: 项目的介绍和使用说明。tsconfig.json
: TypeScript 项目的配置文件。
2. 项目的启动文件介绍
项目的入口文件是 src/index.ts
,它导入了 EnumWrapper
类并提供了对外的接口。
// src/index.ts
export { EnumWrapper } from './EnumWrapper';
3. 项目的配置文件介绍
package.json
package.json
文件包含了项目的基本信息、依赖和脚本命令。
{
"name": "ts-enum-util",
"version": "1.0.0",
"description": "Utilities for TypeScript enums",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"scripts": {
"build": "tsc",
"test": "jest"
},
"dependencies": {
"typescript": "^4.0.0"
},
"devDependencies": {
"@types/jest": "^26.0.0",
"jest": "^26.0.0",
"ts-jest": "^26.0.0"
}
}
tsconfig.json
tsconfig.json
文件是 TypeScript 项目的配置文件,定义了编译选项。
{
"compilerOptions": {
"target": "ES6",
"module": "commonjs",
"outDir": "./dist",
"strict": true,
"esModuleInterop": true
},
"include": ["src/**/*"],
"exclude": ["node_modules"]
}
以上是 ts-enum-util
项目的基本教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助!