Merge pull request #882 from swagger-api/linting

Linting

Author: fehguy

browser/swagger-client.js

@@ -293,6 +293,8 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
   this.security = response.security;
   this.title = response.title || '';
 
+  var key, definedTags = {}, k, location, self = this, i;
+
   if (response.externalDocs) {
     this.externalDocs = response.externalDocs;
   }
@@ -301,7 +303,7 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
   this.authSchemes = this.securityDefinitions;
 
   if(this.securityDefinitions) {
-    for(var key in this.securityDefinitions) {
+    for(key in this.securityDefinitions) {
       var securityDefinition = this.securityDefinitions[key];
       securityDefinition.vendorExtensions = {};
       for(var ext in securityDefinition) {
@@ -319,16 +321,13 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
     }
   }
 
-  var definedTags = {};
-  var k;
-
   if (Array.isArray(response.tags)) {
     definedTags = {};
 
     for (k = 0; k < response.tags.length; k++) {
       var t = _.cloneDeep(response.tags[k]);
       definedTags[t.name] = t;
-      for(var i in t) {
+      for(i in t) {
         if(i === 'externalDocs' && typeof t[i] === 'object') {
           for(var j in t[i]) {
             helpers.extractExtensions(j, t[i]);
@@ -339,7 +338,6 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
     }
   }
 
-  var location;
 
   if (typeof this.url === 'string') {
     location = this.parseUri(this.url);
@@ -395,8 +393,6 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
 
   this.definitions = response.definitions;
 
-  var key;
-
   for (key in this.definitions) {
     var model = new Model(key, this.definitions[key], this.models, this.modelPropertyMacro);
 
@@ -406,8 +402,7 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
   }
 
   // get paths, create functions for each operationId
-  var self = this;
-
+  
   // Bind help to 'client.apis'
   self.apis.help = _.bind(self.help, self);
 
@@ -449,14 +444,14 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
         self.clientAuthorizations);
 
       operationObject.vendorExtensions = {};
-      for(var i in operation) {
+      for(i in operation) {
         helpers.extractExtensions(i, operationObject, operation[i]);
       }
       operationObject.externalDocs = operation.externalDocs;
       if(operationObject.externalDocs) {
         operationObject.externalDocs = _.cloneDeep(operationObject.externalDocs);
         operationObject.externalDocs.vendorExtensions = {};
-        for(var i in operationObject.externalDocs) {
+        for(i in operationObject.externalDocs) {
           helpers.extractExtensions(i, operationObject.externalDocs);
         }
       }

browser/swagger-client.min.js

@@ -22,7 +22,7 @@ module.exports.fail = function (message) {
   log(message);
 };
 
-var optionHtml = module.exports.optionHtml = function (label, value) {
+module.exports.optionHtml = function (label, value) {
   return '<tr><td class="optionName">' + label + ':</td><td>' + value + '</td></tr>';
 };
 
@@ -34,7 +34,7 @@ var resolveSchema = module.exports.resolveSchema = function (schema) {
   return schema;
 };
 
-var simpleRef = module.exports.simpleRef = function (name) {
+module.exports.simpleRef = function (name) {
   if (typeof name === 'undefined') {
     return null;
   }
@@ -66,4 +66,4 @@ module.exports.extractExtensions = function (keyname, obj, value) {
       obj.vendorExtensions[keyname] = obj[keyname];
     }
   }
-}
+};

lib/client.js

@@ -263,6 +263,7 @@ SuperagentHttpClient.prototype.execute = function (obj) {
         }
       }
       else if (_.isObject(obj.body)) {
+        // non multipart/form-data
         obj.body = JSON.stringify(obj.body);
         r.send(obj.body);
       }

lib/helpers.js

@@ -44,7 +44,7 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
     callback = arg1;
     scope = arg2;
   }
-  var _root = root;
+  var _root = root, modelName;
   this.scope = (scope || this);
   this.iteration = this.iteration || 0;
 
@@ -56,15 +56,15 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
     opts.responseInterceptor = this.scope.options.responseInterceptor;
   }
 
-  var name, path, property, propertyName;
+  var name, path, property, propertyName, parameter, done, counter;
   var processedCalls = 0, resolvedRefs = {}, unresolvedRefs = {};
   var resolutionTable = []; // store objects for dereferencing
 
   spec.definitions = spec.definitions || {};
   // definitions
   for (name in spec.definitions) {
     var definition = spec.definitions[name];
-    if(definition['$ref']) {
+    if(definition.$ref) {
       this.resolveInline(root, spec, definition, resolutionTable, unresolvedRefs, definition);
     }
     else {
@@ -87,25 +87,25 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
   // shared parameters
   spec.parameters = spec.parameters || {};
   for(name in spec.parameters) {
-    var parameter = spec.parameters[name];
+    parameter = spec.parameters[name];
     if (parameter.in === 'body' && parameter.schema) {
       if(_.isArray(parameter.schema.allOf)) {
         // move to a definition
-        var modelName = 'inline_model';
-        var name = modelName;
-        var done = false; var counter = 0;
+        modelName = 'inline_model';
+        var _name = modelName;
+        done = false; counter = 0;
         while(!done) {
-          if(typeof spec.definitions[name] === 'undefined') {
+          if(typeof spec.definitions[_name] === 'undefined') {
             done = true;
             break;
           }
-          name = modelName + '_' + counter;
+          _name = modelName + '_' + counter;
           counter ++;
         }
-        spec.definitions[name] = { allOf: parameter.schema.allOf };
+        spec.definitions[_name] = { allOf: parameter.schema.allOf };
         delete parameter.schema.allOf;
-        parameter.schema.$ref = '#/definitions/' + name;
-        this.processAllOf(root, name, spec.definitions[name], resolutionTable, unresolvedRefs, spec);
+        parameter.schema.$ref = '#/definitions/' + _name;
+        this.processAllOf(root, _name, spec.definitions[_name], resolutionTable, unresolvedRefs, spec);
       }
       else {
         this.resolveTo(root, parameter.schema, resolutionTable, location);
@@ -137,24 +137,24 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
           var parameters = operation.parameters || [];
 
           for (i in sharedParameters) {
-            var parameter = sharedParameters[i];
+            parameter = sharedParameters[i];
             parameters.unshift(parameter);
           }
           if (method !== 'parameters' && _.isObject(operation)) {
             operation.parameters = operation.parameters || parameters;
           }
 
           for (i in parameters) {
-            var parameter = parameters[i];
+            parameter = parameters[i];
             location = '/paths' + name + '/' + method + '/parameters';
 
             if (parameter.in === 'body' && parameter.schema) {
               if (_.isArray(parameter.schema.allOf)) {
                 // move to a definition
-                var modelName = 'inline_model';
-                var name = modelName;
-                var done = false;
-                var counter = 0;
+                modelName = 'inline_model';
+                name = modelName;
+                done = false;
+                counter = 0;
                 while (!done) {
                   if (typeof spec.definitions[name] === 'undefined') {
                     done = true;
@@ -192,10 +192,10 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
                 var responseObj = response;
                 if (_.isArray(responseObj.schema.allOf)) {
                   // move to a definition
-                  var modelName = 'inline_model';
-                  var name = modelName;
-                  var done = false;
-                  var counter = 0;
+                  modelName = 'inline_model';
+                  name = modelName;
+                  done = false;
+                  counter = 0;
                   while (!done) {
                     if (typeof spec.definitions[name] === 'undefined') {
                       done = true;
@@ -389,7 +389,7 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
             else {
               var cached = self.resolverCache[obj.url];
               if (_.isObject(cached)) {
-                obj.on.response({obj: cached}), 1;
+                obj.on.response({obj: cached});
               }
               else {
                 lock[obj.url] = true;
@@ -467,7 +467,7 @@ Resolver.prototype.resolveItem = function(spec, root, resolutionTable, resolvedR
 
 Resolver.prototype.finish = function (spec, root, resolutionTable, resolvedRefs, unresolvedRefs, callback, localResolve) {
   // walk resolution table and replace with resolved refs
-  var ref;
+  var ref, abs;
   for (ref in resolutionTable) {
     var item = resolutionTable[ref];
 
@@ -479,7 +479,7 @@ Resolver.prototype.finish = function (spec, root, resolutionTable, resolvedRefs,
         if (localResolve !== true) {
           // don't retain root for local definitions
           for (key in resolvedTo.obj) {
-            var abs = this.retainRoot(key, resolvedTo.obj[key], item.root);
+            abs = this.retainRoot(key, resolvedTo.obj[key], item.root);
             resolvedTo.obj[key] = abs;
           }
         }
@@ -491,7 +491,7 @@ Resolver.prototype.finish = function (spec, root, resolutionTable, resolvedRefs,
         delete targetObj.$ref;
 
         for (key in resolvedTo.obj) {
-          var abs = resolvedTo.obj[key];
+          abs = resolvedTo.obj[key];
 
           if (localResolve !== true) {
             // don't retain root for local definitions
@@ -670,7 +670,7 @@ Resolver.prototype.resolveInline = function (root, spec, property, resolutionTab
   var key = property.$ref, ref = property.$ref, i, p, p2, rs;
   var rootTrimmed = false;
 
-  root = root || '' // Guard against .split. @fehguy, you'll need to check if this logic fits
+  root = root || ''; // Guard against .split. @fehguy, you'll need to check if this logic fits
   // More imporantly is how do we gracefully handle relative urls, when provided just a 'spec', not a 'url' ?
 
   if (ref) {
@@ -810,7 +810,7 @@ Resolver.prototype.resolveTo = function (root, property, resolutionTable, locati
       }
       delete property.title;
       this.spec.definitions[name] = _.cloneDeep(property);
-      property['$ref'] = '#/definitions/' + name;
+      property.$ref = '#/definitions/' + name;
       delete property.type;
       delete property.properties;
     }

lib/http.js

@@ -15,17 +15,11 @@ var _ = {
   forEach: require('lodash-compat/collection/forEach')
 };
 
-module.exports.optionHtml = optionHtml;
-module.exports.typeFromJsonSchema = typeFromJsonSchema;
-module.exports.getStringSignature = getStringSignature;
-module.exports.schemaToHTML = schemaToHTML;
-module.exports.schemaToJSON = schemaToJSON;
-
-function optionHtml(label, value) {
+var optionHtml = module.exports.optionHtml = function  (label, value) {
   return '<tr><td class="optionName">' + label + ':</td><td>' + value + '</td></tr>';
-}
+};
 
-function typeFromJsonSchema(type, format) {
+module.exports.typeFromJsonSchema = function (type, format) {
   var str;
 
   if (type === 'integer' && format === 'int32') {
@@ -51,9 +45,9 @@ function typeFromJsonSchema(type, format) {
   }
 
   return str;
-}
+};
 
-function getStringSignature(obj, baseComponent) {
+var getStringSignature = module.exports.getStringSignature = function (obj, baseComponent) {
   var str = '';
 
   if (typeof obj.$ref !== 'undefined') {
@@ -95,9 +89,9 @@ function getStringSignature(obj, baseComponent) {
   }
 
   return str;
-}
+};
 
-function schemaToJSON(schema, models, modelsToIgnore, modelPropertyMacro) {
+var schemaToJSON = module.exports.schemaToJSON = function (schema, models, modelsToIgnore, modelPropertyMacro) {
   // Resolve the schema (Handle nested schemas)
   schema = Helpers.resolveSchema(schema);
 
@@ -182,10 +176,9 @@ function schemaToJSON(schema, models, modelsToIgnore, modelPropertyMacro) {
   }
 
   return output;
-}
-
-function schemaToHTML(name, schema, models, modelPropertyMacro) {
+};
 
+module.exports.schemaToHTML =function (name, schema, models, modelPropertyMacro) {
   var strongOpen = '<span class="strong">';
   var strongClose = '</span>';
 
@@ -530,4 +523,4 @@ function schemaToHTML(name, schema, models, modelPropertyMacro) {
 
     return html + strongOpen + (isArray ? ']' : '}') + strongClose;
   }
-}
+};