makde code easy read

Author: Frand

README.md

@@ -59,7 +59,7 @@ an simple nodeclub example project realize by koa
 - koa-less使用less编译样式文件
 - koa-etag/koa-conditional-get添加缓存功能
 
-## TODO
+## TEST
 
-- `编写项目测试代码`
-- `移动端适应`
+进入项目根目录输入以下命令即可:
+`$ mocha`

app.js

@@ -1,24 +1,24 @@
 'use strict';
 
-let koa = require('koa'),
-	path = require('path'),
-	send = require('koa-send'),
-	less = require('koa-less'),
-	mount = require('koa-mount'),
-	koabody = require('koa-body'),
-	session = require('koa-session'),
-	router = require('koa-router')(),
-	log = require('koa-request-log'),
-	render = require('koa-ejs'),
-	compress = require('koa-compress'),
-	conditional = require('koa-conditional-get'),
-	etag = require('koa-etag'),
-	errors = require('./middleware/error'),
-	userSess = require('./middleware/user_sess'),
-	app = koa();
-	
+let koa 	 	= require('koa');
+let path 	 	= require('path');
+let send 	 	= require('koa-send');
+let less 	 	= require('koa-less');
+let mount 	 	= require('koa-mount');
+let koabody  	= require('koa-body');
+let session  	= require('koa-session');
+let router 	 	= require('koa-router')();
+let log 	 	= require('koa-request-log');
+let render 	 	= require('koa-ejs');
+let compress 	= require('koa-compress');
+let etag 	 	= require('koa-etag');
+let errors 	 	= require('./middleware/error');
+let userSess 	= require('./middleware/user_sess');
+let conditional = require('koa-conditional-get');
+let routes 		= require('./routers');
+
+let app = koa();
 let publicPath = path.join(__dirname, 'public');
-let routes = require('./routers');
 
 // add view render
 render(app, {

config.js

@@ -10,7 +10,7 @@ let config = {
     description: 'just a koa nodeclub example',
     keywords: 'koa, es6, nodeclub',
 
-    // use dialect
+    // use dialect, primiary for multi db
     useDialect: 'mongodb',
 
     // mongodb 配置

controller/index.js

@@ -1,11 +1,11 @@
 'use strict';
 
-let config = require('../config'),
-	co = require('co'),
-	_ = require('underscore'),
-	moment = require('moment'),
-	User = require('../models').User,
-	Topic = require('../models').Topic;
+let config 	= require('../config');
+let co 		= require('co');
+let _ 		= require('underscore');
+let moment 	= require('moment');
+let User 	= require('../models').User;
+let Topic 	= require('../models').Topic;
 
 // 显示首页
 exports.showIndex = function* (){

controller/reply.js

@@ -5,8 +5,8 @@ let Reply = require('../models').Reply;
 // 显示首页
 exports.create = function* (){
 	let req = this.request.body;
-
 	let reply = new Reply();
+	
 	reply.topicId = req.topicId;
 	reply.content = req.content;
 	reply.replyer = this.session.user.loginname;

controller/topic.js

@@ -1,15 +1,15 @@
 'use strict';
 
-let config = require('../config'),
-	co = require('co'),
-	md5 = require('md5'),
-	MarkdownIt = require('markdown-it'),
-    md = new MarkdownIt(),
-    moment = require('moment'),
-    _ = require('underscore'),
-	User = require('../models').User,
-	Topic = require('../models').Topic,
-	Reply = require('../models').Reply;
+let config 		= require('../config');
+let co 			= require('co');
+let md5 		= require('md5');
+let MarkdownIt 	= require('markdown-it');
+let md 			= new MarkdownIt();
+let moment 		= require('moment');
+let _ 			= require('underscore');
+let User 		= require('../models').User;
+let Topic 		= require('../models').Topic;
+let Reply 		= require('../models').Reply;
 
 // 显示创建主题页
 exports.show = function* (){
@@ -26,15 +26,15 @@ exports.create = function* (){
 	let data = {
 			config,
 			user: this.session.user
-		},
-		req = this.request.body,
-		title = req.title,
-		content = req.content;
-
+		};
+	let req = this.request.body;
+	let title 	= req.title;
+	let content = req.content;
 	let topic = new Topic();
-	topic.title = title;
-	topic.content = content;
-	topic.author = data.user.loginname;
+
+	topic.title 	= title;
+	topic.content 	= content;
+	topic.author 	= data.user.loginname;
 
 	yield Promise.resolve()
 	.then(() => topic.save())
@@ -43,8 +43,8 @@ exports.create = function* (){
 
 // 话题详情
 exports.detail = function* (){
-	let topicId = this.params.id,
-		data = {
+	let topicId = this.params.id;
+	let data = {
 			config,
 			user: this.session.user
 		};
@@ -53,17 +53,19 @@ exports.detail = function* (){
 	.then(() => Topic.findOne({_id: topicId}))
 	.then((topic) => {
 		data.topic = {
-			_id: topic._id,
-			title: topic.title,
+			_id: 	topic._id,
+			title: 	topic.title,
 			author: topic.author,
-			content: md.render(topic.content),
+			content:  md.render(topic.content),
 			createAt: moment(topic.createAt).fromNow(),
 		};
+		
 		return Promise.resolve();
 	})
 	.then(() => Reply.find({topicId: topicId}).sort({'createAt':-1}))
 	.then((replys) => {
 		data.topic.replys = [];
+
 		_.each(replys, (v) => {
 			data.topic.replys.push({
 				replyer: v.replyer,

controller/user.js

@@ -1,9 +1,9 @@
 'use strict';
 
-let config = require('../config'),
-	co = require('co'),
-	md5 = require('md5'),
-	User = require('../models').User;
+let config 	= require('../config');
+let co 		= require('co');
+let md5 	= require('md5');
+let User 	= require('../models').User;
 
 // nodeclub is extract to proxy
 
@@ -24,10 +24,10 @@ exports.showLogin = function* (){
 
 // 登录提交
 exports.login = function* (){
-	let data = {config},
-		req = this.request.body,
-		loginname = req.loginname,
-		password = md5(req.password);
+	let data = {config};
+	let req = this.request.body;
+	let loginname = req.loginname;
+	let password = md5(req.password);
 
 	yield Promise.resolve()
 	.then(() => User.findOne({loginname: loginname}))
@@ -53,15 +53,16 @@ exports.showRegistry = function* (){
 
 // 用户注册
 exports.registry = function* (){
-	let data = {config},
-		req = this.request.body,
-		uname = req.username,
-		loginname = req.loginname,
-		email = req.email,
-		pass = md5(req.password),
-		signature = req.signature;
+	let data = {config};
+	let req = this.request.body;
+	let uname 		= req.username;
+	let loginname 	= req.loginname;
+	let email 		= req.email;
+	let signature 	= req.signature;
+	let pass 	= md5(req.password);
 
 	let user = new User();
+
 	user.name = uname;
 	user.loginname = loginname;
 	user.password = pass;
@@ -86,8 +87,8 @@ exports.logout = function* (){
 
 // 查看用户个人信息
 exports.userInfo = function* (){
-	let loginname = this.params.loginname,
-		data = {
+	let loginname = this.params.loginname;
+	let data = {
 			config,
 			user: this.session.user
 		};

middleware/error.js

@@ -2,10 +2,10 @@
 let config = require('../config');
 
 module.exports = function* (next){
-	let code, errMsg,
-		errCodes = {
-			404: `404, Not Found Information you desired!`,
-			11000: `11000, should not create the same record!`,
+	let code, errMsg;
+	let errCodes = {
+			404: 	 `404, Not Found Information you desired!`,
+			11000: 	 `11000, should not create the same record!`,
 			default: `Errors Happen!`
 		};
 

middleware/user_sess.js

@@ -1,11 +1,11 @@
 'use strict';
 
-let path = require('path'),
-	User = require('../models').User;
+let path = require('path');
+let User = require('../models').User;
 
 // 需要过滤的文件后缀
 let filterSuffix = [
-	'.ico', '.js', '.css', 
+	'.ico', '.js', 	 '.css', 
 	'.jpg', '.jpeg', '.png', 
 	'.gif'
 ];
@@ -15,9 +15,9 @@ module.exports = function* (next){
 	if(filterSuffix.indexOf(path.extname(this.request.url)) !== -1){
 		yield next;
 	}else{
-		let loginname = this.session.loginname,
-			url = this.request.url,
-			userPromise = Promise.resolve();
+		let loginname 	= this.session.loginname;
+		let url 		= this.request.url;
+		let userPromise = Promise.resolve();
 
 		// 静态文件过滤
 		if(loginname){

public/scripts/registry.js

@@ -1,11 +1,11 @@
 define(['jquery'], function($){
 	// list all registry forms
-	var $username = $('input[name=username]'),
-		$loginname = $('input[name=loginname]'),
-		$email = $('input[name=email]'),
-		$password = $('input[name=password]'),
-		$confirmpass = $('input[name=confirmpass]'),
-		$signature = $('input[name=signature]');
+	var $username 	 = $('input[name=username]');
+	var $loginname 	 = $('input[name=loginname]');
+	var $email 		 = $('input[name=email]');
+	var $password 	 = $('input[name=password]');
+	var $confirmpass = $('input[name=confirmpass]');
+	var $signature 	 = $('input[name=signature]');
 
 	var validateEmpty = function(val, ctx){
 		if(!$.trim(val)){
@@ -15,8 +15,8 @@ define(['jquery'], function($){
 		}
 	};
 
-	var blurs = [$username, $loginname, $email, $password, $confirmpass],
-		len = blurs.length;
+	var blurs = [$username, $loginname, $email, $password, $confirmpass];
+	var len   = blurs.length;
 
 	for(var i = 0; i < len; i++){
 		blurs[i].blur(function(){
@@ -26,8 +26,8 @@ define(['jquery'], function($){
 
 	// 验证确认密码
 	$confirmpass.blur(function(){
-		var val = $(this).val(),
-			confirmpass = $password.val();
+		var val = $(this).val();
+		var confirmpass = $password.val();
 
 		if($.trim(val) !== $.trim(confirmpass)){
 			alert('两次输入密码不一致');
@@ -38,6 +38,7 @@ define(['jquery'], function($){
 	// submit form
 	$('.registryUser').click(function(){
 		var hasError = $('.notEmpty').length;
+		
 		if(!hasError){
 			$(this).parent().submit();
 		}

routers.js

@@ -1,12 +1,12 @@
 'use strict';
 
 // controllers
-let router = require('koa-router')(),
-	config = require('./config'),
-	index = require('./controller/'),
-	user = require('./controller/user'),
-	topic = require('./controller/topic'),
-	reply = require('./controller/reply');
+let router = require('koa-router')();
+let config = require('./config');
+let index  = require('./controller/');
+let user   = require('./controller/user');
+let topic  = require('./controller/topic');
+let reply  = require('./controller/reply');
 
 module.exports = router.routes();