Lint

Author: typicode

package-lock.json

@@ -15,6 +15,7 @@
     "cors": "^2.3.0",
     "errorhandler": "^1.2.0",
     "express": "^4.9.5",
+    "is-utf8": "^0.2.1",
     "json-parse-helpfulerror": "^1.0.3",
     "lodash": "^4.11.2",
     "lodash-id": "^0.13.0",
@@ -34,20 +35,24 @@
     "babel-preset-env": "^1.3.2",
     "babel-register": "^6.16.3",
     "cross-env": "^2.0.1",
+    "eslint-config-prettier": "^2.2.0",
+    "eslint-plugin-prettier": "^2.1.2",
     "husky": "^0.14.1",
     "markdown-toc": "^0.13.0",
     "mkdirp": "^0.5.1",
     "mocha": "^3.2.0",
     "os-tmpdir": "^1.0.1",
     "pkg-ok": "^1.0.1",
+    "prettier": "^1.5.2",
     "rimraf": "^2.5.2",
     "server-ready": "^0.3.1",
     "standard": "^8.3.0",
     "supertest": "^3.0.0",
-    "temp-write": "^2.1.0"
+    "temp-write": "^2.1.0",
+    "xo": "^0.18.2"
   },
   "scripts": {
-    "test": "npm run test:cli && npm run test:server && standard",
+    "test": "xo && npm run test:cli && npm run test:server && standard",
     "test:cli": "npm run build && cross-env NODE_ENV=test mocha test/cli/*.js",
     "test:server": "cross-env NODE_ENV=test mocha test/server/*.js",
     "start": "babel-node src/cli/bin",
@@ -90,5 +95,15 @@
   },
   "engines": {
     "node": ">= 4"
+  },
+  "xo": {
+    "semicolon": false,
+    "space": true,
+    "extend": "prettier",
+    "plugin": "prettier",
+    "envs": [
+      "node",
+      "mocha"
+    ]
   }
 }

package.json

@@ -17,14 +17,14 @@ function prettyPrint (argv, object, rules) {
 
   console.log()
   console.log(chalk.bold('  Resources'))
-  for (let prop in object) {
+  for (const prop in object) {
     console.log('  ' + root + '/' + prop)
   }
 
   if (rules) {
     console.log()
     console.log(chalk.bold('  Other routes'))
-    for (var rule in rules) {
+    for (const rule in rules) {
       console.log('  ' + rule + ' -> ' + rules[rule])
     }
   }
@@ -96,7 +96,7 @@ module.exports = function (argv) {
     process.exit(1)
   }
 
-  // noop log fn
+  // Noop log fn
   if (argv.quiet) {
     console.log = () => {}
   }
@@ -131,7 +131,7 @@ module.exports = function (argv) {
       // Load middlewares
       let middlewares
       if (argv.middlewares) {
-        middlewares = argv.middlewares.map(function (m) {
+        middlewares = argv.middlewares.map((m) => {
           console.log(chalk.gray('  Loading', m))
           return require(path.resolve(m))
         })

src/cli/run.js

@@ -23,7 +23,7 @@ module.exports = function (source, cb) {
     const dataFn = require(filename)
 
     if (typeof dataFn !== 'function') {
-      throw new Error('The database is a JavaScript file but the export is not a function.')
+      throw new TypeError('The database is a JavaScript file but the export is not a function.')
     }
 
     // Run dataFn to generate data

src/cli/utils/load.js

@@ -41,7 +41,7 @@ module.exports = function (opts) {
   }
 
   if (process.env.NODE_ENV === 'development') {
-    // only use in development
+    // Only use in development
     arr.push(errorhandler())
   }
 

src/server/defaults.js

@@ -42,14 +42,14 @@ function createId (coll) {
   const idProperty = _.__id()
   if (_.isEmpty(coll)) {
     return 1
-  } else {
-    let id = _(coll).maxBy(idProperty)[idProperty]
+  } 
+  let id = _(coll).maxBy(idProperty)[idProperty]
 
     // Increment integer id or generate string id
-    return _.isFinite(id)
+  return _.isFinite(id)
       ? ++id
       : shortid.generate()
-  }
+  
 }
 
 function deepQuery (value, q) {
@@ -62,7 +62,7 @@ function deepQuery (value, q) {
         }
       }
     } else if (_.isObject(value) && !_.isArray(value)) {
-      for (let k in value) {
+      for (const k in value) {
         if (_.deepQuery(value[k], q)) {
           return true
         }

src/server/mixins.js

@@ -1,22 +1,22 @@
 /* global m */
 
 // Resource list
-var db = {}
+let db = {}
 
-m.request('db').then(function (data) {
+m.request('db').then((data) => {
   db = data
 })
 
 m.mount(
   document.getElementById('resources'),
   {
-    view: function () {
-      var keys = Object.keys(db)
-      var resourceList = (
+    view () {
+      const keys = Object.keys(db)
+      const resourceList = (
         m(
           'ul',
           keys
-            .map(function (key) {
+            .map((key) => {
               return m('li', [
                 m('a', { href: key }, '/' + key),
                 m('sup', Array.isArray(db[key])
@@ -43,21 +43,21 @@ m.mount(
 )
 
 // Custom routes
-var customRoutes = {}
+let customRoutes = {}
 
-m.request('__rules').then(function (data) {
+m.request('__rules').then((data) => {
   customRoutes = data
 })
 
 m.mount(
   document.getElementById('custom-routes'),
   {
-    view: function () {
-      var rules = Object.keys(customRoutes)
+    view () {
+      const rules = Object.keys(customRoutes)
       if (rules.length) {
         return [
           m('h4', 'Custom routes'),
-          m('table', rules.map(function (rule) {
+          m('table', rules.map((rule) => {
             return m('tr', [
               m('td', rule),
               m('td', '⇢ ' + customRoutes[rule])

src/server/public/main.js

@@ -1,6 +1,7 @@
 const express = require('express')
 const url = require('url')
 const _ = require('lodash')
+
 function updateQueryString (target, sourceUrl) {
   return ~sourceUrl.indexOf('?') ? _.assign(target, url.parse(sourceUrl, true).query) : {}
 }
@@ -16,7 +17,7 @@ module.exports = (routes) => {
       router.all(route, (req, res, next) => {
         // Rewrite target url using params
         let target = routes[route]
-        for (let param in req.params) {
+        for (const param in req.params) {
           target = target.replace(':' + param, req.params[param])
         }
         req.url = target

src/server/rewriter.js

@@ -50,11 +50,11 @@ module.exports = (db, name, opts) => {
     let _start = req.query._start
     let _end = req.query._end
     let _page = req.query._page
-    let _sort = req.query._sort
-    let _order = req.query._order
+    const _sort = req.query._sort
+    const _order = req.query._order
     let _limit = req.query._limit
-    let _embed = req.query._embed
-    let _expand = req.query._expand
+    const _embed = req.query._embed
+    const _expand = req.query._expand
     delete req.query.q
     delete req.query._start
     delete req.query._end
@@ -68,7 +68,7 @@ module.exports = (db, name, opts) => {
     // in the database
     Object.keys(req.query).forEach((query) => {
       const arr = db.get(name).value()
-      for (let i in arr) {
+      for (const i in arr) {
         if (
           _.has(arr[i], query) ||
           query === 'callback' ||
@@ -91,7 +91,7 @@ module.exports = (db, name, opts) => {
       q = q.toLowerCase()
 
       chain = chain.filter((obj) => {
-        for (let key in obj) {
+        for (const key in obj) {
           const value = obj[key]
           if (db._.deepQuery(value, q)) {
             return true
@@ -109,12 +109,12 @@ module.exports = (db, name, opts) => {
 
         chain = chain.filter((element) => {
           return arr
-            .map(function (value) {
+            .map((value) => {
               const isDifferent = /_ne$/.test(key)
               const isRange = /_lte$/.test(key) || /_gte$/.test(key)
               const isLike = /_like$/.test(key)
               const path = key.replace(/(_lte|_gte|_ne|_like)$/, '')
-              // get item value based on path
+              // Get item value based on path
               // i.e post.title -> 'foo'
               const elementValue = _.get(element, path)
 
@@ -133,9 +133,9 @@ module.exports = (db, name, opts) => {
                 return value !== elementValue.toString()
               } else if (isLike) {
                 return new RegExp(value, 'i').test(elementValue.toString())
-              } else {
-                return value === elementValue.toString()
-              }
+              } 
+              return value === elementValue.toString()
+              
             })
             .reduce((a, b) => a || b)
         })
@@ -191,10 +191,10 @@ module.exports = (db, name, opts) => {
       chain = chain.slice(_start, _start + _limit)
     }
 
-    // embed and expand
+    // Embed and expand
     chain = chain
       .cloneDeep()
-      .forEach(function (element) {
+      .forEach((element) => {
         embed(element, _embed)
         expand(element, _expand)
       })

src/server/router/plural.js

@@ -18,7 +18,7 @@ module.exports = (obj) => {
       .keys(obj)
       .forEach(validateKey)
   } else {
-    throw new Error(
+    throw new TypeError(
       `Data must be an object. Found ${typeof obj}.` +
       'See https://github.com/typicode/json-server for example.'
     )

src/server/router/validate-data.js

@@ -3,9 +3,9 @@ module.exports = {
 }
 
 function getPage (array, page, perPage) {
-  var obj = {}
-  var start = (page - 1) * perPage
-  var end = page * perPage
+  const obj = {}
+  const start = (page - 1) * perPage
+  const end = page * perPage
 
   obj.items = array.slice(start, end)
   if (obj.items.length === 0) {

src/server/utils.js

@@ -164,7 +164,7 @@ describe('cli', () => {
 
     it('should delay response', (done) => {
       const start = new Date()
-      request.get('/posts').expect(200, function (err) {
+      request.get('/posts').expect(200, (err) => {
         const end = new Date()
         done(
           end - start > 1000
@@ -232,7 +232,7 @@ describe('cli', () => {
     it('should not set Content-Encoding to gzip', (done) => {
       request.get('/posts')
         .expect(200)
-        .end(function (err, res) {
+        .end((err, res) => {
           if (err) {
             done(err)
           } else if ('content-encoding' in res.headers) {

test/cli/index.js

@@ -553,7 +553,7 @@ describe('Server', () => {
         .type('form')
         .send({body: 'foo', booleanValue: true, integerValue: 1})
         .expect('Content-Type', /json/)
-        // x-www-form-urlencoded will convert to string
+        // X-www-form-urlencoded will convert to string
         .expect({id: 3, body: 'foo', booleanValue: 'true', integerValue: '1'})
         .expect(201)
       assert.equal(db.posts.length, 3)
@@ -586,15 +586,15 @@ describe('Server', () => {
       const res = await request(server)
         .put('/posts/1')
         .set('Accept', 'application/json')
-        // body property omitted to test that the resource is replaced
+        // Body property omitted to test that the resource is replaced
         .send(post)
         .expect('Content-Type', /json/)
         .expect(post)
         .expect(200)
       // TODO find a "supertest" way to test this
       // https://github.com/typicode/json-server/issues/396
       assert.deepStrictEqual(res.body, post)
-      // assert it was created in database too
+      // Assert it was created in database too
       assert.deepStrictEqual(db.posts[0], post)
     })
 
@@ -619,7 +619,7 @@ describe('Server', () => {
         .expect(post)
         .expect(200)
       assert.deepStrictEqual(res.body, post)
-      // assert it was created in database too
+      // Assert it was created in database too
       assert.deepStrictEqual(db.posts[0], post)
     })