Add eslint with eslint-config-airbnb. Fix all eslint errors.

Author: kunalkapadia

.eslintrc

@@ -0,0 +1,55 @@
+{
+	"rules": {
+		"indent": [
+			2,
+			"tab",
+			{
+				"SwitchCase": 1
+			}
+		],
+		"quotes": [
+			2,
+			"single"
+		],
+		/*"linebreak-style": [
+			2,
+			"windows"
+		],*/
+		"semi": [
+			2,
+			"always"
+		],
+		"space-before-function-paren": [
+			2,
+			{
+				"anonymous": "always",
+				"named": "never"
+			}
+		],
+		"no-use-before-define": [
+			2,
+			"nofunc"
+		],
+		// TODO: turning off for now
+		"comma-dangle": [
+			0
+		],
+		"one-var": [
+			0
+		],
+		"func-names": [
+			0
+		],
+		"no-else-return": [
+			0
+		]
+	},
+	"env": {
+		"node": true,
+		"mocha": true
+	},
+	"extends": [
+		"eslint:recommended",
+		"airbnb/base"
+	]
+}

README.md

@@ -4,7 +4,7 @@
 
 ## Overview
 
-This is a boilerplate for building REST APIs with ES6 and Express. Helps you stay productive by following best practices. Follows [Airbnb's Javascript style guide](https://github.com/airbnb/javascript).
+This is a starter kit for building REST APIs with ES6 and Express. Helps you stay productive by following best practices. Follows [Airbnb's Javascript style guide](https://github.com/airbnb/javascript).
 
 ### Features
 
@@ -13,7 +13,7 @@ This is a boilerplate for building REST APIs with ES6 and Express. Helps you sta
 | ES2015 via Babel                  | ES2015 support using [Babel](https://babeljs.io/).  |
 | Code Linting               | JavaScript code linting is done using [ESLint](http://eslint.org) - a pluggable linter tool for identifying and reporting on patterns in JavaScript. Uses ESLint with [eslint-config-airbnb](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb), which tries to follow the Airbnb JavaScript style guide.                                                                                                |
 | Auto server restart                  | Restart the server using [nodemon](https://github.com/remy/nodemon) in real-time anytime an edit is made, with babel compilation.                                                                                                                                                                            |
-| Environment variables           | Supports setting env variable using .env file at the root. Uses [dot-env](https://www.npmjs.com/package/dotenv) to enable this feature.)                       |
+| Environment variables           | Supports setting env variable using .env file at the root. Uses [dot-env](https://www.npmjs.com/package/dotenv) to enable this feature.                       |
 
 ## Getting Started
 

config/env.js

@@ -6,5 +6,4 @@ const config = require('dotenv').config() || {};
 // root path of server
 config.rootPath = path.join(__dirname, '../');
 
-console.log('loaded env');
 export default config;

config/express.js

@@ -1,5 +1,4 @@
 import express from 'express';
-import path from 'path';
 import logger from 'morgan';
 import bodyParser from 'body-parser';
 import compress from 'compression';
@@ -26,23 +25,23 @@ app.use(cors());
 app.use('/api', routes);
 
 // catch different types of error
-app.use(function (err, req, res, next) {
+app.use((err, req, res, next) => {
 	const error = utilityService.createError(err.message, err.status, err.isPublic);
 	return next(error);
 });
 
 // catch 404 and forward to error handler
-app.use(function(req, res, next) {
+app.use((req, res, next) => {
 	const err = utilityService.createError('API not found', httpStatus.NOT_FOUND);
 	return next(err);
 });
 
 // error handler
-app.use(function(err, req, res, next) {
-	return res.status(err.status).json({
+app.use((err, req, res, next) =>		// eslint-disable-line no-unused-vars
+	res.status(err.status).json({
 		message: err.isPublic ? err.message : httpStatus[err.status],
 		error: process.env.NODE_ENV === 'development' ? err : {}
-	});
-});
+	})
+);
 
 export default app;

gulpfile.babel.js

@@ -11,13 +11,13 @@ const paths = {
 };
 
 // Clean up dist files
-gulp.task('clean', () => {
-	return del(['dist/**', 'coverage/**', '!dist', '!coverage']);
-});
+gulp.task('clean', () =>
+	del(['dist/**', 'coverage/**', '!dist', '!coverage'])
+);
 
 // Compile ES6 to ES5 and copy to dist
-gulp.task('babel', () => {
-	return gulp.src([...paths.js, '!gulpfile.babel.js'], {base: '.'})
+gulp.task('babel', () =>
+	gulp.src([...paths.js, '!gulpfile.babel.js'], { base: '.' })
 		.pipe(plugins.newer('dist'))
 		.pipe(plugins.sourcemaps.init())
 		.pipe(plugins.babel())
@@ -27,22 +27,36 @@ gulp.task('babel', () => {
 		})
 		.pipe(plugins.sourcemaps.write('.', {
 			includeContent: false,
-			sourceRoot: function (file) {
+			sourceRoot(file) {
 				return path.relative(file.path, __dirname);
 			}
 		}))
-		.pipe(gulp.dest('dist'));
-});
+		.pipe(gulp.dest('dist'))
+);
+
+// Lint Javascript
+gulp.task('eslint', () =>
+	gulp.src(paths.js)
+		// eslint() attaches the lint output to the "eslint" property
+		// of the file object so it can be used by other modules.
+		.pipe(plugins.eslint())
+		// eslint.format() outputs the lint results to the console.
+		// Alternatively use eslint.formatEach() (see Docs).
+		.pipe(plugins.eslint.format())
+		// To have the process exit with an error code (1) on
+		// lint error, return the stream and pipe to failAfterError last.
+		.pipe(plugins.eslint.failAfterError())
+);
 
 // Start server with restart on file changes
-gulp.task('nodemon', ['babel'], () => {
+gulp.task('nodemon', ['babel'], () =>
 	plugins.nodemon({
 		script: path.join('dist', 'index.js'),
 		ext: 'js',
 		ignore: ['node_modules/**/*.js', 'dist/**/*.js'],
 		tasks: ['babel']
-	});
-});
+	})
+);
 
 gulp.task('serve', ['clean'], () => {
 	runSequence('nodemon');
@@ -51,4 +65,4 @@ gulp.task('serve', ['clean'], () => {
 // clean and compile files, the default task
 gulp.task('default', ['clean'], () => {
 	runSequence('babel');
-});
+});

index.js

@@ -6,4 +6,4 @@ const debug = require('debug')('express-es6-rest-api-starter:index');
 // listen on port HTTP_PORT
 app.listen(config.HTTP_PORT, () => {
 	debug(`started server on port ${config.HTTP_PORT} (${config.NODE_ENV})`);
-});
+});

package.json

@@ -27,8 +27,11 @@
   "devDependencies": {
     "babel": "^5.8.23",
     "del": "^2.2.0",
+    "eslint": "^1.10.3",
+    "eslint-config-airbnb": "^4.0.0",
     "gulp": "^3.9.0",
     "gulp-babel": "^5.2.1",
+    "gulp-eslint": "^1.1.1",
     "gulp-load-plugins": "^1.2.0",
     "gulp-newer": "^1.1.0",
     "gulp-nodemon": "^2.0.6",

server/routes/index.js

@@ -1,12 +1,12 @@
 import express from 'express';
 import userRoutes from './users';
 
-const router = express.Router();
+const router = express.Router();	// eslint-disable-line new-cap
 
 /* GET home page. */
-router.get('/health-check', function(req, res, next) {
-	return res.send('OK');
-});
+router.get('/health-check', (req, res) =>
+	res.send('OK')
+);
 
 router.use('/users', userRoutes);
 

server/routes/users.js

@@ -1,10 +1,10 @@
 import express from 'express';
 
-const router = express.Router();
+const router = express.Router();	// eslint-disable-line new-cap
 
 /* GET users listing. */
-router.get('/', function(req, res, next) {
-  res.send('respond with a resource');
-});
+router.get('/', (req, res) =>
+  res.send('respond with a resource')
+);
 
 export default router;

server/services/utility.js

@@ -5,4 +5,4 @@ export function createError(message, status = httpStatus.INTERNAL_SERVER_ERROR,
 	error.status = status;
 	error.isPublic = isPublic;
 	return error;
-}
+}