add cov & lint & update README & some fix

Author: IndexXuan

.eslintrc

@@ -1,5 +1,15 @@
 {
  "extends": "eslint-config-egg",
+ "parseOptions": {
+ ecmaVersion: 2017
+ },
  "rules": {
+ },
+ "globals": {
+ "app": true,
+ "request": true,
+ "mm": true,
+ "mock": true,
+ "assert": true,
  }
 }

README.md

@@ -16,6 +16,8 @@ $ npm run dev
 
 Node.js >= 7.6.0 required(support native async & await).
 
+* 可以在 `app/router.js` 中查看完整路由配置和demo示例
+
 ## Features
 
 - ✔︎ Full APIs Wrapped
@@ -32,14 +34,13 @@ Node.js >= 7.6.0 required(support native async & await).
 
 - Use `npm start` to run server
 - Use `npm run dev` to dev
-- Use `npm test` to run unit test.
+- Use `npm run lint` to run eslint(eslint not native support es@next now)
+- Use `npm test` to run unit test
+- Use `npm run cov` to run cov
 
 ### Todo
 
-- use `router prefix`
-- use `middleware in router`
-- more & more
-- develop `webapp` using this apis
+- make `pwa` using the APIs
 
 ### Links
 

app/router.js

@@ -6,12 +6,13 @@
  * Date : Fri 03 Mar 2017 03:22:10 PM CST
  */
 
+'use strict'
 
 module.exports = app => {
 
  const prefix = '/api/v2'
 
- // @auth, all require auth
+ // @auth 
  app.post('v2ex', `${prefix}/auth/login`, 'auth.login')
  app.get('v2ex', `${prefix}/auth/login`, 'auth.login') // for test
  app.post('v2ex', `${prefix}/auth/login`, 'auth.login')
@@ -35,13 +36,13 @@ module.exports = app => {
  app.get('v2ex', `${prefix}/topics/hot`, 'topics.hot')
  app.get('v2ex', `${prefix}/topics/:id`, 'topics.show')
  app.get('v2ex', `${prefix}/topics/all/:type/:value`, 'topics.getAllByType')
- // require auth
+ // auth required
  app.post('v2ex', `${prefix}/topics/new`, 'topics.create')
  // app.get('v2ex', `${prefix}/topics/new`, 'topics.create') // for test
 
  // @repies
  app.get('v2ex', `${prefix}/replies/:topic_id`, 'replies.show')
- // require auth
+ // auth required
  app.post('v2ex', `${prefix}/replies/:topic_id`, 'replies.create')
  // app.get('v2ex', `${prefix}/replies/:topic_id/new`, 'replies.create') // for test
 
@@ -79,5 +80,5 @@ module.exports = app => {
  // @replies
  // http://localhost:7001/replies/344499?page=1&page_size=20 // page_size貌似没用...
 
-} // /.router
+} // /.router map
 

package.json

@@ -6,15 +6,19 @@
  "scripts": {
  "start": "node index.js",
  "dev": "egg-bin dev",
+ "lint": "eslint .",
+ "cov": "egg-bin cov",
  "test": "egg-bin test"
  },
  "dependencies": {
  "egg": "^1.0.0-rc.2",
+ "eslint": "^3.18.0",
  "set-cookie-parser": "^2.0.0"
  },
  "devDependencies": {
- "egg-bin": "^2.2.3",
+ "egg-bin": "^3.1.0",
  "egg-mock": "^3.0.1",
+ "eslint-config-egg": "^3.2.0",
  "supertest": "^3.0.0"
  },
  "engines": {
@@ -26,8 +30,10 @@
  },
  "keywords": [
  "v2ex",
+ "RESTful API",
  "egg",
- "async-await"
+ "async-await",
+ "unittest"
  ],
  "author": "indexxuan",
  "license": "MIT"