Merge pull request #1104 from swagger-api/enforce-eslint

Enforce ESLint rules

Author: shockey

package.json

@@ -19,7 +19,8 @@
     "build": "NODE_ENV=production webpack -p --config ./webpack.config.js",
     "build-bundle": "NODE_ENV=production webpack -p --config ./webpack.bundle.config.js",
     "watch": "webpack --config webpack.config.js --watch --progress",
-    "test": "NODE_ENV=test node ./node_modules/.bin/_mocha --recursive --compilers js:babel-core/register",
+    "test": "npm run just-test && npm run lint",
+    "just-test": "NODE_ENV=test node ./node_modules/.bin/_mocha --recursive --compilers js:babel-core/register",
     "test:watch": "npm run test -- -w",
     "lint": "eslint src/ test/",
     "deps-license": "license-checker --production --csv --out $npm_package_config_deps_check_dir/licenses.csv && license-checker --development --csv --out $npm_package_config_deps_check_dir/licenses-dev.csv",

src/execute.js

@@ -12,7 +12,7 @@ const arrayOrEmpty = (ar) => {
   return Array.isArray(ar) ? ar : []
 }
 
-const OperationNotFoundError = createError('OperationNotFoundError', function(message, extra, oriError) {
+const OperationNotFoundError = createError('OperationNotFoundError', function (message, extra, oriError) {
   this.originalError = oriError
   Object.assign(this, extra || {})
 })
@@ -117,7 +117,7 @@ export function buildRequest({
       const builder = parameterBuilders[parameter.in]
       let value
 
-      if(parameter.in === 'body' && parameter.schema && parameter.schema.properties) {
+      if (parameter.in === 'body' && parameter.schema && parameter.schema.properties) {
         value = parameters
       }
 
@@ -142,14 +142,18 @@ export function buildRequest({
   if (req.body || req.form) {
     if (requestContentType) {
       req.headers['content-type'] = requestContentType
-    } else if (Array.isArray(operation.consumes)) {
+    }
+    else if (Array.isArray(operation.consumes)) {
       req.headers['content-type'] = operation.consumes[0]
-    } else if (Array.isArray(spec.consumes)) {
+    }
+    else if (Array.isArray(spec.consumes)) {
       req.headers['content-type'] = spec.consumes[0]
-    } else if (operation.parameters.filter((p)=> p.type === "file").length) {
-      req.headers['content-type'] = "multipart/form-data"
-    } else if (operation.parameters.filter((p)=> p.in === "formData").length) {
-      req.headers['content-type'] = "application/x-www-form-urlencoded"
+    }
+    else if (operation.parameters.filter(p => p.type === 'file').length) {
+      req.headers['content-type'] = 'multipart/form-data'
+    }
+    else if (operation.parameters.filter(p => p.in === 'formData').length) {
+      req.headers['content-type'] = 'application/x-www-form-urlencoded'
     }
   }
 

src/helpers.js

@@ -1,18 +1,17 @@
 import isObject from 'lodash/isObject'
 
 const toLower = str => String.prototype.toLowerCase.call(str)
-const escapeString = str => {
+const escapeString = (str) => {
   return str.replace(/[^\w]/gi, '_')
 }
 
 // Strategy for determining operationId
 export function opId(operation, pathName, method = '') {
   const idWithoutWhitespace = (operation.operationId || '').replace(/\s/g, '')
-  if(idWithoutWhitespace.length) {
+  if (idWithoutWhitespace.length) {
     return escapeString(operation.operationId)
-  } else {
-    return idFromPathMethod(pathName, method)
   }
+  return idFromPathMethod(pathName, method)
 }
 
 
@@ -124,19 +123,18 @@ export function normalizeSwagger(parsedSpec) {
         Object.keys(map).forEach((op) => {
           if (map[op].length > 1) {
             map[op].forEach((o, i) => {
-              o.__originalOperationId = o.__originalOperationId ||  o.operationId
-              o.operationId = `${op}${i+1}`
+              o.__originalOperationId = o.__originalOperationId || o.operationId
+              o.operationId = `${op}${i + 1}`
             })
-          } else {
-            // Ensure we always add the normalized operation ID if one already exists ( potentially different, given that we normalize our IDs)
+          }
+          else if (typeof operation.operationId !== 'undefined') {
+            // Ensure we always add the normalized operation ID if one already exists
+            // ( potentially different, given that we normalize our IDs)
             // ... _back_ to the spec. Otherwise, they might not line up
-            if(typeof operation.operationId !== 'undefined') {
-              let obj = map[op][0]
-              obj.__originalOperationId = obj.__originalOperationId || operation.operationId
-              obj.operationId = op
-            }
+            const obj = map[op][0]
+            obj.__originalOperationId = obj.__originalOperationId || operation.operationId
+            obj.operationId = op
           }
-
         })
       }
 

src/http.js

@@ -37,7 +37,7 @@ export default function http(url, request = {}) {
     delete request.headers['Content-Type']
   }
 
-  return fetch(request.url, request).then((res) => {
+  return fetch(request.url, request).then((res) => { // eslint-disable-line no-undef
     const serialized = self.serializeRes(res, url, request).then((_res) => {
       if (request.responseInterceptor) {
         _res = request.responseInterceptor(_res) || _res
@@ -65,7 +65,7 @@ export default function http(url, request = {}) {
 }
 
 // exported for testing
-export const shouldDownloadAsText = (contentType = "") => /json|xml|yaml|text/.test(contentType)
+export const shouldDownloadAsText = (contentType = '') => /json|xml|yaml|text/.test(contentType)
 
 // Serialize the response, returns a promise with headers and the body part of the hash
 export function serializeRes(oriRes, url, {loadSpec = false} = {}) {
@@ -128,7 +128,7 @@ export function serializeHeaders(headers = {}) {
 
 function isFile(obj) {
   if (typeof File !== 'undefined') {
-    return obj instanceof File
+    return obj instanceof File // eslint-disable-line no-undef
   }
   return obj !== null && typeof obj === 'object' && typeof obj.pipe === 'function'
 }

src/index.js

@@ -1,8 +1,8 @@
 import cloneDeep from 'lodash/cloneDeep'
 import assign from 'lodash/assign'
+import Url from 'url'
 import Http, {makeHttp, serializeRes, serializeHeaders} from './http'
 import Resolver, {clearCache} from './resolver'
-import url from 'url'
 import {makeApisTagOperation} from './interfaces'
 import {execute, buildRequest, PARAMETER_BUILDERS} from './execute'
 import {opId} from './helpers'
@@ -78,18 +78,18 @@ Swagger.prototype = {
   }
 }
 
-Swagger.prototype.applyDefaults = function() {
-  var spec = this.spec
-  var specUrl = this.url
-  if(specUrl && specUrl.startsWith('http')) {
-    var parsed = url.parse(specUrl)
-    if(!spec.host) {
+Swagger.prototype.applyDefaults = function () {
+  const spec = this.spec
+  const specUrl = this.url
+  if (specUrl && specUrl.startsWith('http')) {
+    const parsed = Url.parse(specUrl)
+    if (!spec.host) {
       spec.host = parsed.host
     }
-    if(!spec.schemes) {
-      spec.schemes = [parsed.protocol.replace(':','')]
+    if (!spec.schemes) {
+      spec.schemes = [parsed.protocol.replace(':', '')]
     }
-    if(!spec.basePath) {
+    if (!spec.basePath) {
       spec.basePath = '/'
     }
   }

src/interfaces.js

@@ -81,21 +81,23 @@ export function mapTagOperations({spec, cb = nullFn, defaultTag = 'default'}) {
       const id = opId(operation, pathName, method)
       const cbResult = cb({spec, pathName, method, operation, operationId: id})
 
-      if(operationIdCounter[id]) {
-        operationIdCounter[id] = operationIdCounter[id] + 1
+      if (operationIdCounter[id]) {
+        operationIdCounter[id]++
         tagObj[`${id}${operationIdCounter[id]}`] = cbResult
-      } else if (typeof tagObj[id] !== 'undefined') {
+      }
+      else if (typeof tagObj[id] !== 'undefined') {
         // Bump counter ( for this operationId )
-        let originalCounterValue = (operationIdCounter[id] || 1)
+        const originalCounterValue = (operationIdCounter[id] || 1)
         operationIdCounter[id] = originalCounterValue + 1
         // Append _x to the operationId
         tagObj[`${id}${operationIdCounter[id]}`] = cbResult
 
         // Rename the first operationId
-        let temp = tagObj[id]
+        const temp = tagObj[id]
         delete tagObj[id]
         tagObj[`${id}${originalCounterValue}`] = temp
-      } else {
+      }
+      else {
         // Assign callback result ( usually a bound function )
         tagObj[id] = cbResult
       }

src/resolver.js

@@ -23,7 +23,10 @@ export function clearCache() {
   plugins.refs.clearCache()
 }
 
-export default function resolve({http, fetch, spec, url, baseDoc, mode, allowMetaPatches = true, modelPropertyMacro, parameterMacro}) {
+export default function resolve({
+  http, fetch, spec, url, baseDoc, mode, allowMetaPatches = true,
+  modelPropertyMacro, parameterMacro
+}) {
   // @TODO Swagger-UI uses baseDoc instead of url, this is to allow both
   // need to fix and pick one.
   baseDoc = baseDoc || url

src/specmap/lib/index.js

@@ -48,12 +48,12 @@ function applyPatch(obj, patch, opts) {
     deepExtend(valPatch.value, patch.value)
 
     // deepExtend doesn't merge arrays, so we will do it manually
-    for ( let prop in patch.value ) {
-      if ( patch.value.hasOwnProperty(prop) ) {
+    for (const prop in patch.value) {
+      if (Object.prototype.hasOwnProperty.call(patch.value, prop)) {
         const propVal = patch.value[prop]
-        if ( Array.isArray(propVal) ) {
-          let existing = origValPatchValue[prop] || []
-          valPatch.value[prop] = existing.concat( propVal )
+        if (Array.isArray(propVal)) {
+          const existing = origValPatchValue[prop] || []
+          valPatch.value[prop] = existing.concat(propVal)
         }
       }
     }

src/specmap/lib/parameters.js

@@ -4,23 +4,22 @@ export default {
   key: 'parameters',
   plugin: (parameters, key, fullPath, specmap, patch) => {
     if (Array.isArray(parameters) && parameters.length) {
-      let val = Object.assign([], parameters)
-      let opPath = fullPath.slice(0, -1)
-      let op = Object.assign({}, lib.getIn(specmap.spec, opPath))
+      const val = Object.assign([], parameters)
+      const opPath = fullPath.slice(0, -1)
+      const op = Object.assign({}, lib.getIn(specmap.spec, opPath))
 
-      parameters.forEach((param, i)=>{
+      parameters.forEach((param, i) => {
         try {
           val[i].default = specmap.parameterMacro(op, param)
-        } catch(e) {
+        }
+        catch (e) {
           const err = new Error(e)
           err.fullPath = fullPath
           return err
         }
       })
 
-      const patch = lib.replace(fullPath, val)
-
-      return patch
+      return lib.replace(fullPath, val)
     }
 
     return lib.replace(fullPath, parameters)

src/specmap/lib/properties.js

@@ -3,22 +3,21 @@ import lib from '../lib'
 export default {
   key: 'properties',
   plugin: (properties, key, fullPath, specmap) => {
-    let val = Object.assign({}, properties)
+    const val = Object.assign({}, properties)
 
-    for (let k in properties) {
+    for (const k in properties) {
       try {
         val[k].default = specmap.modelPropertyMacro(val[k])
-      } catch(e) {
+      }
+      catch (e) {
         const err = new Error(e)
         err.fullPath = fullPath // This is an array
         return err
       }
-
     }
 
     const patch = lib.replace(fullPath, val)
 
     return patch
-
   }
 }