chicken
使用说明
chicken 所暴露 api 与 eggjs 一致，使用可参考eggjs 文档
开发步骤
-
npm i安装项目依赖 -
npm start开启本地编译服务并监听所有源码文件变化 -
npm run clean清除编译文件（这些文件不应该提交到 git） -
npm run lintlint 检查 -
npm run build编译文件，本步骤会自动运行npm run clean
发布说明
chicken 发布在京东私有 npm 库上，chicken 的 Scope 为@jd，发布前请参考京东私有 npm 库发布说明
发布步骤
-
将本地 ts 文件编译成 js 文件:
npm run build -
修改版本号:
npm version patch/minor/major，请遵循 npm 版本号规则 -
发布:
npm publish
日记级别说明
- app.logger 方法
logger.log() process.stdout 打印日志，namespace默认为chicken
logger.debug() process.stdout 打印日志，namespace默认为项目名
logger.error() process.stderr 打印日志，namespace默认为项目名
logger.ump() process.stdout 打印日志，并且记入ump日志，namespace默认为ump
logger.logbook() process.stdout 打印日志，并且记入logbook日志，namespace默认为logbook
- LOG 可以自定义 debug 命名空间
logger.name('namespace').debug('这是一条日志');
// namespace 这是一条日志 +0ms
logger.name('filename').logbook(这是一条日志，这条日志会记录到文件filename.log内);
// logbook 这是一条日志，这条日志会记录到文件filename.log内 +0ms
-
chicken 默认命名空间为小写 'chicken'，不同功能模块可能加以区分：'chicken:core'、'chicken:service'...
-
如果需要输出日志，需要设置环境变量 DEBUG=命名空间
DEBUG=chicken* npm test
文件目录 (本目录未包含文件都是编译后生成的)
.
├── README.md
├── package-lock.json
├── package.json
├── src ------ 【重要】项目源码目录
│ ├── index.ts ------ 入口js
│ ├── app
│ │ └── middleware ------ 默认中间件目录
│ │ ├── bodyParser.ts
│ │ ├── notfound.ts
│ │ └── siteFile.ts
│ ├── config ------ chicken项目默认配置
│ │ └── config.default.ts
│ └── lib ------ 核心逻辑目录
│ ├── config
│ │ └── default.ts
│ └── core
│ ├── base ------ chicken 基类
│ │ ├── controller.ts
│ │ └── service.ts
│ ├── bootstrap ------ chicken 项目初始化逻辑
│ │ ├── index.ts
│ │ ├── mixin
│ │ │ ├── config.ts
│ │ │ ├── controller.ts
│ │ │ ├── middleware.ts
│ │ │ ├── router.ts
│ │ │ ├── schedule.ts
│ │ │ ├── service.ts
│ │ │ └── view.ts
│ │ └── viewStore.ts
│ ├── core.ts ------ chicken app 基类
│ ├── logger ------ chicken 日志方法，包括ump和logbook
│ │ ├── index.ts
│ │ ├── logbookProfiler.ts
│ │ └── umpProfiler.ts
│ ├── schedule ------ chicken 定时任务，包含timer方法，chicken项目的timer方法需严格使用schedule实例化
│ │ ├── timer.ts
│ │ └── index.ts
│ └── utils
│ ├── index.ts
│ ├── makeDirs.ts
│ ├── readFile.ts
│ └── writeStream.ts
├── test
├── tsconfig.json
├── tslint.json
└── types