coupler
组件项目基于typescript
的模板
##目录结构
├── .test #测试目录
├── lib # 编译输出目录
├── src # 源码根目录
├── test # 测试根目录
├── types # 类型定义目录
├── .couplerc # coupler资源文件
├── .couplererrors # coupler错误资源文件
├── .gitignore
├── .npmignore
├── README.md # 默认文档
├── package.json
├── tsconfig.json # 默认tsc配置文件
├── tsconfig.test.json # 测试tsc配置文件
└── tslint.json # tslint配置文件
##依赖包
###运行依赖
默认添加lodash
及debug
支持。
###peer依赖
默认添加@coupler/core
,开发时可手动安装。
###开发依赖
默认添加@coupler/helper
为开发依赖包,用于帮助构建coupler
运行时,和生成类型文件(如:CPError
的错误类声明)。
###类型解析
默认添加lodash
及node
类型支持。
##准备
@coupler/helper
提供了生成动态代码类型声明的功能,在可被ts
解析到之前,需要生成这些声明文件,运行:
npm run prepare
##编译
采用@coupler/typescript
为默认typescript编译器。
配置文件:
- 默认配置:
tsconfig.json
- 测试配置:
tsconfig.test.json
执行编译
npm run build
随变更编译
npm run build:watch
##代码检查
采用tslint
做代码检查,配置文件为tslint.json
。
npm run lint
##单元测试
采用ava
为test runner,nyc
为覆盖检查工具。
执行测试:
npm test
随变更测试
npm run test:watch
测试覆盖率
npm run test:coverage