docs: view #228

atian25 · 2017-01-10T13:17:30Z

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

fengmk2 · 2017-01-10T17:44:59Z

docs/source/zh-cn/practice/view.md

+
+绝大多数情况，我们都需要读取数据后渲染模板，然后呈现给用户。故我们需要引入对应的模板引擎。
+
+而 egg 并不强制你使用某种模板引擎，开发者可以依据下文的规范, 来封装对应的模板引擎插件。


egg => 框架

你 => 我们

而 egg 并不强制你使用某种模板引擎，开发者可以依据下文的规范, 来封装对应的模板引擎插件。

而框架并不强制使用某种模板引擎，我们可以依据下文的规范, 来封装对应的模板引擎插件。

dead-horse · 2017-01-11T09:00:09Z

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

+app.locals = { a: 2 };
+console.log(this.locals);
+
+// assign directly is ok, will merge by setter, output: { a: 1, b: 1, c: 1, d: 4 }


atian25 · 2017-01-11T10:09:37Z

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

+
+绝大多数情况，我们都需要读取数据后渲染模板，然后呈现给用户。故我们需要引入对应的模板引擎。
+
+框架并不强制你使用某种模板引擎，并且没有内置的 view 插件，只是约定了 [view 插件开发规范](../practice/view.md)，开发者需根据团队技术选型自行引入。


view 插件开发规范 这个 view 大写首字母还是小写好?

如果分开，开发规范就不适合放到 practice 里了

这个路径错了

放到 advanced ?

dead-horse · 2017-01-11T13:43:02Z

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

+// config/config.default.js
+exports.view = {
+  dir: path.join(appInfo.baseDir, 'app/view'),
+  // should set to `false` at local development mode


插件自己配置了 local 环境下为 false 吧？可以说明一下

这个有约定？

之前的 web.md 没有, 这次写文档的时候, 想加上这些实践规约, 统一命名好一点吧?

dead-horse · 2017-01-11T13:43:27Z

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

+在渲染页面的过程中，我们通常需要一个变量来收集需要传递给模板的变量，在框架里面，我们提供了 `app.locals` 和 `this.locals`。
+
+- `app.locals` 为全局的，一般在 `app.js` 里面配置全局变量。
+- `this.locals` 为单次请求的，会合并 `app.locals`


中间行没有句号

dead-horse · 2017-01-11T13:50:42Z

docs/source/zh-cn/practice/view-plugin.md

+{
+  "name": "egg-view-nunjucks",
+  "eggPlugin": {
+    "name": "view"


name 换成真实的吧

这是真实的，不同 view 插件都要用 view

popomore · 2017-01-11T17:35:10Z

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

+
+绝大多数情况，我们都需要读取数据后渲染模板，然后呈现给用户。故我们需要引入对应的模板引擎。
+
+框架并不强制你使用某种模板引擎，并且没有内置的 view 插件，只是约定了 [view 插件开发规范](../practice/view.md)，开发者需根据团队技术选型自行引入。


如果分开，开发规范就不适合放到 practice 里了

popomore · 2017-01-11T17:35:53Z

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

+
+1. 引入 view 插件
+
+```bash


list 都需要缩进

好像看到其他的都没有缩进, 渲染后会自动缩进的吧.

这里缩进后, 下面的代码块缩进似乎不好看

不会自动的。

popomore · 2017-01-11T17:36:11Z

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

+exports.view = {
+  enable: true,
+  package: 'egg-view-nunjucks',
+}


popomore · 2017-01-11T17:36:34Z

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

+// config/config.default.js
+exports.view = {
+  dir: path.join(appInfo.baseDir, 'app/view'),
+  // should set to `false` at local development mode


这个有约定？

popomore · 2017-01-11T17:39:47Z

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

+```js
+// config/config.default.js
+exports.view = {
+  dir: path.join(appInfo.baseDir, 'app/view'),


这个有约定？

appInfo 在哪

popomore · 2017-01-11T18:10:16Z

docs/source/zh-cn/practice/view-plugin.md

+  // mount `View` class to app
+  // egg will create an instance to `ctx.view` at every request
+  // you can use `this.render` at controller
+  get [Symbol.for('egg#view')]() {


这里也要说明下，英文都改了

popomore · 2017-01-11T18:11:45Z

docs/source/zh-cn/practice/view-plugin.md

+const path = require('path');
+
+module.exports = appInfo => {
+  const config = {};


要不我们改成直接 return 的？

module.exports = appInfo => { return { /** * View options * @member Config#view * @property {String} dir - full path of template dir, support multiple path by using comma, defaults to `{app_root}/app/view`. * @property {Boolean} cache - whether cache template, default to true except false at local env. */ view: { dir: path.join(appInfo.baseDir, 'app/view'), cache: true, } } };

这样? 貌似不是很好看

popomore · 2017-01-11T18:12:20Z

docs/source/zh-cn/practice/view-plugin.md

+
+### filter
+
+模板引擎中最常用的就是 filter，故我们在框架的[扩展](../basics/extend.md)之上增加对 `app/extend/filter.js` 的支持：


filter 可以弱化，我们强调 helper

也要介绍到这个扩展吧? helper 比起 filter 有什么优点?

popomore · 2017-01-11T18:13:43Z

docs/source/zh-cn/practice/view-plugin.md

+// {plugin_root}/app/extend/application.js
+const helper = require('../../lib/helper');
+module.exports = {
+  get ViewHelper() {


这里不用挂 app 了？直接 require？

也行, 之前是从 chair 那里拷贝的, ViewHelper 挂出来也没啥用

Helper 这个类还是需要缓存起来的，不在 app 就得在 View 里面。

eggjs/egg-view-nunjucks#8

popomore · 2017-01-11T18:14:14Z

docs/source/zh-cn/practice/view-plugin.md

@@ -0,0 +1,259 @@
+title: View 插件开发规范


放到 advanced 好了

codecov-io · 2017-01-12T01:42:35Z

Current coverage is 97.89% (diff: 100%)

Merging #228 into master will not change coverage

@@             master       #228   diff @@
==========================================
  Files            34         34          
  Lines           902        902          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits            883        883          
  Misses           19         19          
  Partials          0          0

Powered by Codecov. Last update 6e24326...cc15897

atian25 · 2017-01-12T01:43:47Z

docs/source/zh-cn/advanced/view-plugin.md

+const helper = require('./helper');
+
+module.exports = class MyCustomView {
+  get Helper() {


@popomore 不在 app 定义 ViewHelper, 就得在这里缓存下. 你看哪种方式好点?

eggjs/egg-view-nunjucks#8

atian25 · 2017-01-12T04:00:13Z

可以 review 了.

fengmk2 · 2017-01-12T06:39:35Z

docs/source/zh-cn/advanced/view-plugin.md

+});
+```
+
+挂载到 application ：


扩展到 application

fengmk2 · 2017-01-12T06:41:19Z

docs/source/zh-cn/advanced/view-plugin.md

+  render(name, locals) {
+    // name 为模板文件的相对于 `app/view` 的路径
+    return new Promise((resolve, reject) => {
+      this.app.viewEngine.render(name, locals, function(err, result) {


function(err, result) { => (err, result) => {

fengmk2 · 2017-01-12T06:47:06Z

docs/source/zh-cn/advanced/view-plugin.md

+
+配置的 key 为 `view`，并提供至少两个配置属性:
+
+- {String} dir - 模板文件的根目录，绝对路径。


要说一下通过逗号分隔支持多路径的形式

在下面的代码示例里面增加了

fengmk2 · 2017-01-12T06:56:26Z

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

+$ npm i egg-view-nunjucks --save
+```
+
+2. 启用插件


1, 2, 3 不会生效的

奇怪, 在 vscode 的 markdown preview 里面是正常的

fengmk2 · 2017-01-12T06:59:21Z

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

+module.exports = function* home(){
+  const data = { name: 'egg' };
+
+  // render a template, path releate to `app/view`


fengmk2 · 2017-01-12T07:06:45Z

没啥大问题。

fengmk2

LGTM

atian25 · 2017-01-12T07:25:07Z

OK，都更新了，我这边有 2 个待确定的点， @popomore 看看：

针对应用开发者的那份，要不要干掉 filter？
ViewHelper 的实现，挂到 application 还是 view？

popomore · 2017-01-12T09:52:16Z

@atian25 看了下确实原来的方式好，辛苦了

popomore · 2017-01-12T09:51:01Z

docs/source/zh-cn/advanced/view-plugin.md

+    }
+    // ...
+  }
+  return ViewHelper;


这里直接设 app.ViewHelper

现在那样可以延迟初始化

popomore · 2017-01-12T09:51:37Z

docs/source/zh-cn/advanced/view-plugin.md

+
+  get helper() {
+    if (!this[HELPER]) {
+      this[HELPER] = new this.Helper(this.ctx);


用 this.app.ViewHelper

atian25 · 2017-01-12T09:54:18Z

ok, 我改回来

popomore · 2017-01-12T10:13:20Z

只改了文档，我合并了

* master: (37 commits) docs: fix quickstart typo (#266) docs: add http client debug docs (#265) docs: modify and fix 3 points (#264) docs(intro): improve decription (#263) docs: fix docs site version (#262) docs: Fix typo. (#261) docs: review 1st version docs (#257) fix: typo conext -> context (#259) docs: contributing && readme && deps (#253) docs: fix quickstart link in index.html (#256) docs: set the default locale zh-cn (#255) refactor: ctx.realStatus delegate ctx.response.realStatus (#252) docs: Add intro/index.md (#246) feat: adjust default plugins (#251) docs: add RESTful documents (#247) feat: delegate ctx.jsonp to ctx.response.jsonp (#248) chore: remove examples (#245) docs: improve mysql doc docs: add mysql doc docs: view (#228) ...

atian25 added the type: document label Jan 10, 2017

popomore added the WIP label Jan 10, 2017

fengmk2 reviewed Jan 10, 2017

View reviewed changes

atian25 force-pushed the view branch 2 times, most recently from 858fc9e to 0683835 Compare January 11, 2017 08:26

dead-horse reviewed Jan 11, 2017

View reviewed changes

atian25 force-pushed the view branch 5 times, most recently from c20bb20 to 6390e55 Compare January 11, 2017 10:06

atian25 requested a review from popomore January 11, 2017 10:07

atian25 commented Jan 11, 2017

View reviewed changes

atian25 force-pushed the view branch 2 times, most recently from 69c7167 to 781e210 Compare January 11, 2017 10:11

dead-horse reviewed Jan 11, 2017

View reviewed changes

popomore reviewed Jan 11, 2017

View reviewed changes

atian25 force-pushed the view branch from 781e210 to 97d24ed Compare January 12, 2017 01:42

atian25 commented Jan 12, 2017

View reviewed changes

atian25 force-pushed the view branch from 97d24ed to aa0ef3d Compare January 12, 2017 03:58

atian25 changed the title ~~[WIP] docs: view~~ docs: view Jan 12, 2017

atian25 removed the WIP label Jan 12, 2017

atian25 force-pushed the view branch from aa0ef3d to c745b93 Compare January 12, 2017 03:59

atian25 force-pushed the view branch 2 times, most recently from 9da8f48 to cc15897 Compare January 12, 2017 06:32

fengmk2 reviewed Jan 12, 2017

View reviewed changes

docs/source/zh-cn/advanced/view-plugin.md

});

```

挂载到 application ：

Copy link

Member

fengmk2 Jan 12, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

扩展到 application

fengmk2 reviewed Jan 12, 2017

View reviewed changes

fengmk2 approved these changes Jan 12, 2017

View reviewed changes

popomore mentioned this pull request Jan 12, 2017

中文文档 #34

Closed

31 tasks

atian25 force-pushed the view branch 4 times, most recently from 648ffab to 75b36e8 Compare January 12, 2017 07:21

popomore reviewed Jan 12, 2017

View reviewed changes

docs: view

2028eff

atian25 force-pushed the view branch from 75b36e8 to 2028eff Compare January 12, 2017 10:03

popomore approved these changes Jan 12, 2017

View reviewed changes

popomore merged commit d63752e into master Jan 12, 2017

popomore deleted the view branch January 12, 2017 10:13


		绝大多数情况，我们都需要读取数据后渲染模板，然后呈现给用户。故我们需要引入对应的模板引擎。

		而 egg 并不强制你使用某种模板引擎，开发者可以依据下文的规范, 来封装对应的模板引擎插件。


		绝大多数情况，我们都需要读取数据后渲染模板，然后呈现给用户。故我们需要引入对应的模板引擎。

		框架并不强制你使用某种模板引擎，并且没有内置的 view 插件，只是约定了 [view 插件开发规范](../practice/view.md)，开发者需根据团队技术选型自行引入。


		### filter

		模板引擎中最常用的就是 filter，故我们在框架的[扩展](../basics/extend.md)之上增加对 `app/extend/filter.js` 的支持：


		配置的 key 为 `view`，并提供至少两个配置属性:

		- {String} dir - 模板文件的根目录，绝对路径。

docs: view #228

docs: view #228

Conversation

atian25 commented Jan 10, 2017

Checklist

Affected core subsystem(s)

Description of change

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Jan 12, 2017 • edited Loading

Current coverage is 97.89% (diff: 100%)

Choose a reason for hiding this comment

atian25 commented Jan 12, 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

fengmk2 commented Jan 12, 2017

fengmk2 left a comment

Choose a reason for hiding this comment

atian25 commented Jan 12, 2017

popomore commented Jan 12, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atian25 commented Jan 12, 2017

popomore commented Jan 12, 2017

codecov-io commented Jan 12, 2017 •

edited

Loading

atian25 commented Jan 12, 2017 •

edited

Loading