feat: add framework example

framework/README.md

@@ -0,0 +1,39 @@
+# Framework Example
+
+This example contains [app] and [framework]
+
+## Quick Start
+
+Start an application using custom framework called yadan
+
+```bash
+$ cd app
+$ npm install
+$ npm link ../yadan
+$ npm run dev
+```
+
+Yadan is a framework, it should be published to npm normally. With this example, you just `npm link` it.
+
+## Run Test
+
+Application
+
+```bash
+$ cd app
+$ npm test
+```
+
+Framework
+
+```bash
+$ cd yadan
+$ npm test
+```
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+[app]: https://github.com/eggjs/examples/tree/master/framework/app
+[framework]: https://github.com/eggjs/examples/tree/master/framework/yadan

framework/app/app/controller/home.js

@@ -0,0 +1,7 @@
+'use strict';
+
+module.exports = function* home() {
+  // use service defined in framework
+  const data = yield this.service.test.get(123);
+  yield this.render('home.tpl', data);
+};

framework/app/app/router.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = app => {
+  app.get('/', 'home');
+};

framework/app/app/view/home.tpl

@@ -0,0 +1 @@
+hi, {{ name }}

framework/app/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "framework-example",
+  "version": "1.0.0",
+  "devDependencies": {
+    "egg-bin": "^1.0.0"
+  },
+  "scripts": {
+    "dev": "egg-bin dev"
+  },
+  "egg": {
+    "framework": "yadan"
+  }
+}

framework/yadan/app/extend/application.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+
+};

framework/yadan/app/extend/context.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+
+};

framework/yadan/app/service/test.js

@@ -0,0 +1,17 @@
+'use strict';
+
+module.exports = app => (
+  /**
+   * Test Service
+   */
+  class Test extends app.Service {
+    constructor(ctx) {
+      super(ctx);
+      this.config = this.app.config.test;
+    }
+
+    * get(id) {
+      return { id, name: this.config.key };
+    }
+  }
+);

framework/yadan/config/config.default.js

@@ -0,0 +1,16 @@
+'use strict';
+
+module.exports = appInfo => {
+  const config = {};
+
+  /**
+   * some description
+   * @member Config#test
+   * @property {String} key - some description
+   */
+  config.test = {
+    key: appInfo.name + '_123456',
+  };
+
+  return config;
+};

framework/yadan/config/plugin.js

@@ -0,0 +1,8 @@
+'use strict';
+
+// add you build-in plugin here, example:
+exports.view = {
+  enable: true,
+  package: 'egg-view-nunjucks',
+};
+

framework/yadan/index.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const Application = require('./lib/application');
+const Agent = require('./lib/agent');
+const egg = require('egg');
+
+// clone egg API
+Object.assign(exports, egg);
+
+// override Application and Agent
+exports.Application = Application;
+exports.Agent = Agent;

framework/yadan/lib/agent.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const path = require('path');
+const egg = require('egg');
+const EGG_PATH = Symbol.for('egg#eggPath');
+
+class YadanAgent extends egg.Agent {
+  get [EGG_PATH]() {
+    return path.dirname(__dirname);
+  }
+}
+
+module.exports = YadanAgent;

framework/yadan/lib/application.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const path = require('path');
+const egg = require('egg');
+const EGG_PATH = Symbol.for('egg#eggPath');
+
+class YadanApplication extends egg.Application {
+  get [EGG_PATH]() {
+    return path.dirname(__dirname);
+  }
+}
+
+module.exports = YadanApplication;

framework/yadan/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "yadan",
+  "version": "1.0.0",
+  "dependencies": {
+    "egg": "^0.7.0",
+    "egg-view-nunjucks": "1.0.0"
+  },
+  "devDependencies": {
+    "egg-bin": "^1.10.0",
+    "egg-mock": "^2.0.0",
+    "supertest": "^2.0.1"
+  },
+  "engines": {
+    "node": ">=6.0.0"
+  },
+  "scripts": {
+    "test": "egg-bin test"
+  }
+}

framework/yadan/test/lib/framework.test.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const path = require('path');
+const assert = require('assert');
+const request = require('supertest');
+const mm = require('egg-mock');
+
+describe('test/lib/framework.test.js', () => {
+  let app;
+  before(() => {
+    app = mm.app({
+      baseDir: path.join(__dirname, '../../../app'),
+      customEgg: true,
+    });
+    return app.ready();
+  });
+  after(() => app.close());
+  afterEach(mm.restore);
+
+  it('should GET /', () => {
+    return request(app.callback())
+      .get('/')
+      .expect('hi, framework-example_123456')
+      .expect(200);
+  });
+
+  it('should load config', () => {
+    assert(app.config.test.key === 'framework-example_123456');
+  });
+
+  it('should load service', function* () {
+    const ctx = app.mockContext();
+    const data = yield ctx.service.test.get(123);
+    assert.deepEqual(data, {
+      id: 123,
+      name: 'framework-example_123456',
+    });
+  });
+});

hackernews/package.json

@@ -5,7 +5,7 @@
   "private": true,
   "dependencies": {
     "egg": "^0.7.0",
-    "egg-view-nunjucks": "^0.6.0",
+    "egg-view-nunjucks": "^1.0.0",
     "moment": "^2.17.1"
   },
   "devDependencies": {