docs: add core/development.md #214

shaoshuai0102 · 2017-01-09T15:41:34Z

Checklist

npm test passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

Description of change

codecov-io · 2017-01-10T01:24:51Z

Current coverage is 97.48% (diff: 100%)

No coverage report found for master at bf31c6d.

Powered by Codecov. Last update bf31c6d...68d146f

atian25 · 2017-01-10T02:33:10Z

PR title and file name typo: develope -> develop

popomore · 2017-01-10T07:36:28Z

docs/source/zh-cn/core/develop-and-debug.md

+```json
+{
+  "devDependencies": {
+    "egg-bin": "1"


popomore · 2017-01-10T07:48:05Z

docs/source/zh-cn/core/develop-and-debug.md

+}
+```
+
+这样我们就可以通过 `npm run test` 命令运行单元测试。


popomore · 2017-01-10T07:48:52Z

docs/source/zh-cn/core/develop-and-debug.md

+
+### 测试框架
+
+集成了 [mocha](https://mochajs.org/)，无需再手动依赖，直接书写 mocha 用例，并且通过 [thunk-mocha](https://npmjs.com/thunk-mocha) 模块扩展了多种用例书写方式，例如 generator 函数，async await 等。


这个和下面的是不是直接链到 unittest.md 去

我这里写的比较简单，然后上面加个链接到 unittest

单测我觉得全都可以放到 unittest.md

这个文档可以讲讲本地启动的原理，和线上有什么区别，debug 方式等等

下面有的，环境配置

popomore · 2017-01-10T07:49:31Z

docs/source/zh-cn/core/develop-and-debug.md

+我们在编写用例时往往想单独执行正在编写的用例，可以通过以下方式指定特定用例文件：
+
+```bash
+TESTS=test/x.test.js egg-bin test


支持 glob

popomore · 2017-01-10T07:51:38Z

docs/source/zh-cn/core/develop-and-debug.md

+
+为了提升研发体验，我们提供了便捷的方式在本地进行开发、调试、单元测试等。
+
+在这里我们需要使用到 [egg-bin](https://github.com/eggjs/egg-bin) 模块。


强调下只在本地开发和单元测试使用，部署方法链接到 advanced/deployment.md

popomore · 2017-01-10T07:51:45Z

docs/source/zh-cn/core/develop-and-debug.md

+
+在这里我们需要使用到 [egg-bin](https://github.com/eggjs/egg-bin) 模块。
+
+首先，我们需要把 `egg-bin` 模块作为 `devDependency` 引入到 `package.json`：


devDependencies

popomore · 2017-01-10T07:52:29Z

@atian25 之后来补充下 IDE 的 debug？

shaoshuai0102 · 2017-01-10T08:44:07Z

改好了 @popomore

popomore · 2017-01-10T09:21:34Z

再来一个人看

gxcsoccer · 2017-01-10T09:28:13Z

docs/source/zh-cn/core/develop-and-debug.md

+
+## 更多
+
+如果想了解更多本地开发相关的内容，例如为你的团队定制一个本地开发工具，请参考 [egg-bin](https://github.com/eggjs/egg-bin)。


这里也可以发挥一下

这个太深入了，先 ref 插件文档吧，插件文档里有描述。后续有需求再加。

gxcsoccer · 2017-01-10T09:29:09Z

docs/source/zh-cn/core/develop-and-debug.md

+
+![image](https://cloud.githubusercontent.com/assets/456108/21771461/66bb5232-d6c2-11e6-8d2c-9076a5e414b0.png)
+
+### 使用 debug 模块


我们是推荐用 debug 模块，还是直接 this.logger.debug ?

我偏向后者

讨论了一下：

框架和插件用 debug 模块

业务用 logger

shaoshuai0102 · 2017-01-10T10:36:42Z

增加了 logger 的说明

shaoshuai0102 · 2017-01-10T10:36:49Z

@gxcsoccer done

popomore · 2017-01-10T14:41:40Z

@gxcsoccer 再确认下

fengmk2 · 2017-01-10T16:15:45Z

docs/source/zh-cn/core/development.md

+
+### 使用 debug 模块调试
+
+[debug](https://www.npmjs.com/package/npm) 模块是 node 社区广泛使用的 debug 工具，很多模块都使用它模块打印调试信息，egg 社区也广泛采用这一机制打印 debug 信息，__推荐在框架和插件开发中使用它。__


https://www.npmjs.com/package/debug

fengmk2 · 2017-01-10T16:21:09Z

docs/source/zh-cn/core/development.md

+
+### 使用 logger 模块调试
+
+框架内置了[日志](./logger.md)功能，使用 `logger.debug()` 输出调试信息，__推荐在业务代码中使用它。__


应用代码

dead-horse · 2017-01-10T16:22:36Z

docs/source/zh-cn/core/development.md

+本地启动应用默认监听 7001 端口，可指定其他端口，例如：
+
+```bash
+egg-bin dev --port 8888


npm run dev -- --port 8888

dead-horse · 2017-01-10T16:24:31Z

docs/source/zh-cn/core/development.md

+我们在编写用例时往往想单独执行正在编写的用例，可以通过以下方式指定特定用例文件：
+
+```bash
+TESTS=test/x.test.js egg-bin test


TEST=test/x.test.js npm test

dead-horse · 2017-01-10T16:25:00Z

docs/source/zh-cn/core/development.md

+我们也可以手动指定 reporter：
+
+```bash
+TEST_REPORTER=doc egg-bin test


同上，egg-bin 安装在项目里都是找不到的，只能放到 npm scripts 里面才行

shaoshuai0102 · 2017-01-10T16:33:44Z

done

fengmk2

+1

shaoshuai0102 added the type: document label Jan 9, 2017

shaoshuai0102 added this to the v1.x milestone Jan 9, 2017

shaoshuai0102 assigned popomore Jan 9, 2017

shaoshuai0102 requested review from fengmk2, popomore, leoner and dead-horse January 9, 2017 15:41

popomore mentioned this pull request Jan 9, 2017

中文文档 #34

Closed

31 tasks

shaoshuai0102 force-pushed the doc-dev-and-debug branch from d4c5a12 to 68d146f Compare January 10, 2017 02:54

shaoshuai0102 changed the title ~~docs: add core/develope-and-debug.md~~ docs: add core/develop-and-debug.md Jan 10, 2017

popomore reviewed Jan 10, 2017

View reviewed changes

shaoshuai0102 force-pushed the doc-dev-and-debug branch from 68d146f to e760c85 Compare January 10, 2017 08:43

popomore approved these changes Jan 10, 2017

View reviewed changes

gxcsoccer reviewed Jan 10, 2017

View reviewed changes

shaoshuai0102 force-pushed the doc-dev-and-debug branch from e760c85 to 08d422a Compare January 10, 2017 10:35

shaoshuai0102 force-pushed the doc-dev-and-debug branch from 08d422a to b0d49c3 Compare January 10, 2017 16:13

shaoshuai0102 changed the title ~~docs: add core/develop-and-debug.md~~ docs: add core/development.md Jan 10, 2017

fengmk2 reviewed Jan 10, 2017

View reviewed changes

shaoshuai0102 force-pushed the doc-dev-and-debug branch 2 times, most recently from f30804f to 1cd9899 Compare January 10, 2017 16:17

fengmk2 reviewed Jan 10, 2017

View reviewed changes

dead-horse reviewed Jan 10, 2017

View reviewed changes

docs: add core/development.md

09f2ec3

shaoshuai0102 force-pushed the doc-dev-and-debug branch from 1cd9899 to 09f2ec3 Compare January 10, 2017 16:33

fengmk2 approved these changes Jan 10, 2017

View reviewed changes

fengmk2 merged commit 98506f0 into master Jan 10, 2017

fengmk2 deleted the doc-dev-and-debug branch January 10, 2017 16:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add core/development.md #214

docs: add core/development.md #214

shaoshuai0102 commented Jan 9, 2017

codecov-io commented Jan 10, 2017 •

edited

Loading

atian25 commented Jan 10, 2017 •

edited

Loading

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

shaoshuai0102 Jan 10, 2017

gxcsoccer Jan 10, 2017

shaoshuai0102 Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore commented Jan 10, 2017

shaoshuai0102 commented Jan 10, 2017

popomore commented Jan 10, 2017

gxcsoccer Jan 10, 2017

shaoshuai0102 Jan 10, 2017

gxcsoccer Jan 10, 2017

shaoshuai0102 Jan 10, 2017

shaoshuai0102 commented Jan 10, 2017

shaoshuai0102 commented Jan 10, 2017

popomore commented Jan 10, 2017

fengmk2 Jan 10, 2017

fengmk2 Jan 10, 2017

dead-horse Jan 10, 2017

dead-horse Jan 10, 2017

dead-horse Jan 10, 2017

shaoshuai0102 commented Jan 10, 2017

fengmk2 left a comment


		### 测试框架

		集成了 [mocha](https://mochajs.org/)，无需再手动依赖，直接书写 mocha 用例，并且通过 [thunk-mocha](https://npmjs.com/thunk-mocha) 模块扩展了多种用例书写方式，例如 generator 函数，async await 等。


		为了提升研发体验，我们提供了便捷的方式在本地进行开发、调试、单元测试等。

		在这里我们需要使用到 [egg-bin](https://github.com/eggjs/egg-bin) 模块。


		在这里我们需要使用到 [egg-bin](https://github.com/eggjs/egg-bin) 模块。

		首先，我们需要把 `egg-bin` 模块作为 `devDependency` 引入到 `package.json`：


		## 更多

		如果想了解更多本地开发相关的内容，例如为你的团队定制一个本地开发工具，请参考 [egg-bin](https://github.com/eggjs/egg-bin)。


		![image](https://cloud.githubusercontent.com/assets/456108/21771461/66bb5232-d6c2-11e6-8d2c-9076a5e414b0.png)

		### 使用 debug 模块


		### 使用 debug 模块调试

		[debug](https://www.npmjs.com/package/npm) 模块是 node 社区广泛使用的 debug 工具，很多模块都使用它模块打印调试信息，egg 社区也广泛采用这一机制打印 debug 信息，__推荐在框架和插件开发中使用它。__


		### 使用 logger 模块调试

		框架内置了[日志](./logger.md)功能，使用 `logger.debug()` 输出调试信息，__推荐在业务代码中使用它。__

docs: add core/development.md #214

docs: add core/development.md #214

Conversation

shaoshuai0102 commented Jan 9, 2017

Checklist

Affected core subsystem(s)

Description of change

codecov-io commented Jan 10, 2017 • edited Loading

Current coverage is 97.48% (diff: 100%)

atian25 commented Jan 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

popomore commented Jan 10, 2017

shaoshuai0102 commented Jan 10, 2017

popomore commented Jan 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shaoshuai0102 commented Jan 10, 2017

shaoshuai0102 commented Jan 10, 2017

popomore commented Jan 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shaoshuai0102 commented Jan 10, 2017

fengmk2 left a comment

Choose a reason for hiding this comment

codecov-io commented Jan 10, 2017 •

edited

Loading

atian25 commented Jan 10, 2017 •

edited

Loading