README
dophin core
Discription
dophin core 是dophin部分核心方法、基类、类型的抽象,对外暴露以下内容:
DophinBaseClass: 基类
Runtime: 记录dophin运行各阶段的数据
getAllProjects: 获取所有项目列表
getRootConfig/getProjectConfig: 获取项目配置
utils: 工具方法
Develop & Deploy
本项目使用typescript开发, mocha测试,发布到https://www.npmjs.com/
开发步骤
npm i typescript -g
全局安装tsc,npm i
安装项目依赖npm start
开启本地编译服务并监听所有源码文件变化npm run clean
清除编译文件(这些文件不应该提交到git)npm run lint
lint检查npm run build
编译文件,本步骤会自动运行npm run clean
发布步骤
将本地ts文件编译成js文件:
npm run build
修改版本号:
npm version patch/minor/major
,请遵循npm版本号规则发布:
npm publish
项目源码目录 (本目录未包含文件都是编译后生成的)
.
├── README.md
├── do.config.js ----- 这个文件其实是给单元测试用的
├── src ----- 【入口】项目源码
│ ├── DophinBaseClass.ts ----- dophin 基类
│ ├── const ----- 一些固定配置或变量
│ │ └── index.ts
│ ├── dependencies ----- 本项目主要的内容,对外暴露的三个方法
│ │ ├── GetAllProjects.ts
│ │ ├── GetProjectConfig.ts
│ │ └── GetRootConfig.ts
│ ├── index.ts ----- 项目入口
│ └── utils ----- 一些工具方法
│ ├── debounce.ts
│ ├── getTime.ts
│ ├── index.ts
│ └── log.ts
├── test ----- 单元测试目录
│ └── index.test.js
├── tsconfig.json ----- tsc编译器配置文件
├── tslint.json ----- tslint配置文件
├── types ----- 编译后生成的类型文件