@readme/httpsnippet 2.4.5 → 3.0.1

package/src/targets/shell/httpie.js

@@ -8,14 +8,12 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var util = require('util')
-var shell = require('../../helpers/shell')
-var CodeBuilder = require('../../helpers/code-builder')
+const { format } = require('util');
+const shell = require('./helpers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  var opts = Object.assign({
+  const opts = {
     body: false,
     cert: false,
     headers: false,
@@ -27,97 +25,105 @@ module.exports = function (source, options) {
     style: false,
     timeout: false,
     verbose: false,
-    verify: false
-  }, options)
+    verify: false,
+    ...options,
+  };
 
-  var code = new CodeBuilder(opts.indent, opts.indent !== false ? ' \\\n' + opts.indent : ' ')
+  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ` \\\n${opts.indent}` : ' ');
 
-  var raw = false
-  var flags = []
+  let raw = false;
+  const flags = [];
 
   if (opts.headers) {
-    flags.push(opts.short ? '-h' : '--headers')
+    flags.push(opts.short ? '-h' : '--headers');
   }
 
   if (opts.body) {
-    flags.push(opts.short ? '-b' : '--body')
+    flags.push(opts.short ? '-b' : '--body');
   }
 
   if (opts.verbose) {
-    flags.push(opts.short ? '-v' : '--verbose')
+    flags.push(opts.short ? '-v' : '--verbose');
   }
 
   if (opts.print) {
-    flags.push(util.format('%s=%s', opts.short ? '-p' : '--print', opts.print))
+    flags.push(format('%s=%s', opts.short ? '-p' : '--print', opts.print));
   }
 
   if (opts.verify) {
-    flags.push(util.format('--verify=%s', opts.verify))
+    flags.push(format('--verify=%s', opts.verify));
   }
 
   if (opts.cert) {
-    flags.push(util.format('--cert=%s', opts.cert))
+    flags.push(format('--cert=%s', opts.cert));
   }
 
   if (opts.pretty) {
-    flags.push(util.format('--pretty=%s', opts.pretty))
+    flags.push(format('--pretty=%s', opts.pretty));
   }
 
   if (opts.style) {
-    flags.push(util.format('--style=%s', opts.pretty))
+    flags.push(format('--style=%s', opts.pretty));
   }
 
   if (opts.timeout) {
-    flags.push(util.format('--timeout=%s', opts.timeout))
+    flags.push(format('--timeout=%s', opts.timeout));
   }
 
   // construct query params
   if (opts.queryParams) {
-    var queryStringKeys = Object.keys(source.queryObj)
+    const queryStringKeys = Object.keys(source.queryObj);
 
     queryStringKeys.forEach(function (name) {
-      var value = source.queryObj[name]
+      const value = source.queryObj[name];
 
       if (Array.isArray(value)) {
         value.forEach(function (val) {
-          code.push('%s==%s', name, shell.quote(val))
-        })
+          code.push('%s==%s', name, shell.quote(val));
+        });
       } else {
-        code.push('%s==%s', name, shell.quote(value))
+        code.push('%s==%s', name, shell.quote(value));
       }
-    })
+    });
   }
 
   // construct headers
-  Object.keys(source.allHeaders).sort().forEach(function (key) {
-    code.push('%s:%s', key, shell.quote(source.allHeaders[key]))
-  })
+  Object.keys(source.allHeaders)
+    .sort()
+    .forEach(function (key) {
+      code.push('%s:%s', key, shell.quote(source.allHeaders[key]));
+    });
 
   if (source.postData.mimeType === 'application/x-www-form-urlencoded') {
     // construct post params
     if (source.postData.params && source.postData.params.length) {
-      flags.push(opts.short ? '-f' : '--form')
+      flags.push(opts.short ? '-f' : '--form');
 
       source.postData.params.forEach(function (param) {
-        code.push('%s=%s', param.name, shell.quote(param.value))
-      })
+        code.push('%s=%s', param.name, shell.quote(param.value));
+      });
     }
   } else {
-    raw = true
+    raw = true;
   }
 
-  code.unshift('http %s%s %s', flags.length ? flags.join(' ') + ' ' : '', source.method, shell.quote(opts.queryParams ? source.url : source.fullUrl))
+  code.unshift(
+    'http %s%s %s',
+    flags.length ? `${flags.join(' ')} ` : '',
+    source.method,
+    shell.quote(opts.queryParams ? source.url : source.fullUrl)
+  );
 
   if (raw && source.postData.text) {
-    code.unshift('echo %s | ', shell.quote(source.postData.text))
+    code.unshift('echo %s | ', shell.quote(source.postData.text));
   }
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'httpie',
   title: 'HTTPie',
   link: 'http://httpie.org/',
-  description: 'a CLI, cURL-like tool for humans'
-}
+  description: 'a CLI, cURL-like tool for humans',
+};

package/src/targets/shell/index.js

@@ -1,14 +1,13 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'shell',
     title: 'Shell',
     extname: '.sh',
-    default: 'curl'
+    default: 'curl',
+    cli: '%s',
   },
 
   curl: require('./curl'),
   httpie: require('./httpie'),
-  wget: require('./wget')
-}
+  wget: require('./wget'),
+};

package/src/targets/shell/wget.js

@@ -8,47 +8,45 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var util = require('util')
-var helpers = require('../../helpers/shell')
-var CodeBuilder = require('../../helpers/code-builder')
+const { format } = require('util');
+const helpers = require('./helpers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  var opts = Object.assign({
+  const opts = {
     indent: '  ',
     short: false,
-    verbose: false
-  }, options)
+    verbose: false,
+    ...options,
+  };
 
-  var code = new CodeBuilder(opts.indent, opts.indent !== false ? ' \\\n' + opts.indent : ' ')
+  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ` \\\n${opts.indent}` : ' ');
 
   if (opts.verbose) {
-    code.push('wget %s', opts.short ? '-v' : '--verbose')
+    code.push('wget %s', opts.short ? '-v' : '--verbose');
   } else {
-    code.push('wget %s', opts.short ? '-q' : '--quiet')
+    code.push('wget %s', opts.short ? '-q' : '--quiet');
   }
 
-  code.push('--method %s', helpers.quote(source.method))
+  code.push('--method %s', helpers.quote(source.method));
 
   Object.keys(source.allHeaders).forEach(function (key) {
-    var header = util.format('%s: %s', key, source.allHeaders[key])
-    code.push('--header %s', helpers.quote(header))
-  })
+    const header = format('%s: %s', key, source.allHeaders[key]);
+    code.push('--header %s', helpers.quote(header));
+  });
 
   if (source.postData.text) {
-    code.push('--body-data ' + helpers.escape(helpers.quote(source.postData.text)))
+    code.push(`--body-data ${helpers.escape(helpers.quote(source.postData.text))}`);
   }
 
-  code.push(opts.short ? '-O' : '--output-document')
-      .push('- %s', helpers.quote(source.fullUrl))
+  code.push(opts.short ? '-O' : '--output-document').push('- %s', helpers.quote(source.fullUrl));
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'wget',
   title: 'Wget',
   link: 'https://www.gnu.org/software/wget/',
-  description: 'a free software package for retrieving files using HTTP, HTTPS'
-}
+  description: 'a free software package for retrieving files using HTTP, HTTPS',
+};

package/src/targets/swift/helpers.js

@@ -1,6 +1,4 @@
-'use strict'
-
-var util = require('util')
+const { format } = require('util');
 
 /**
  * Create an string of given length filled with blank spaces
@@ -9,24 +7,25 @@ var util = require('util')
  * @param {string} str String to pad out with
  * @return {string}
  */
-function buildString (length, str) {
-  return Array.apply(null, new Array(length)).map(String.prototype.valueOf, str).join('')
+function buildString(length, str) {
+  // eslint-disable-next-line prefer-spread
+  return Array.apply(null, new Array(length)).map(String.prototype.valueOf, str).join('');
 }
 
 /**
  * Create a string corresponding to a Dictionary or Array literal representation with pretty option
  * and indentation.
  */
-function concatArray (arr, pretty, indentation, indentLevel) {
-  var currentIndent = buildString(indentLevel, indentation)
-  var closingBraceIndent = buildString(indentLevel - 1, indentation)
-  var join = pretty ? ',\n' + currentIndent : ', '
+function concatArray(arr, pretty, indentation, indentLevel) {
+  const currentIndent = buildString(indentLevel, indentation);
+  const closingBraceIndent = buildString(indentLevel - 1, indentation);
+  const join = pretty ? `,\n${currentIndent}` : ', ';
 
   if (pretty) {
-    return '[\n' + currentIndent + arr.join(join) + '\n' + closingBraceIndent + ']'
-  } else {
-    return '[' + arr.join(join) + ']'
+    return `[\n${currentIndent}${arr.join(join)}\n${closingBraceIndent}]`;
   }
+
+  return `[${arr.join(join)}]`;
 }
 
 module.exports = {
@@ -39,7 +38,7 @@ module.exports = {
    * @return {string}
    */
   literalDeclaration: function (name, parameters, opts) {
-    return util.format('let %s = %s', name, this.literalRepresentation(parameters, opts))
+    return format('let %s = %s', name, this.literalRepresentation(parameters, opts));
   },
 
   /**
@@ -50,35 +49,45 @@ module.exports = {
    * @return {string}
    */
   literalRepresentation: function (value, opts, indentLevel) {
-    indentLevel = indentLevel === undefined ? 1 : indentLevel + 1
+    // eslint-disable-next-line no-param-reassign
+    indentLevel = indentLevel === undefined ? 1 : indentLevel + 1;
 
     switch (Object.prototype.toString.call(value)) {
       case '[object Number]':
-        return value
-      case '[object Array]':
+        return value;
+
+      case '[object Array]': {
         // Don't prettify arrays nto not take too much space
-        var pretty = false
-        var valuesRepresentation = value.map(function (v) {
-          // Switch to prettify if the value is a dictionary with multiple keys
-          if (Object.prototype.toString.call(v) === '[object Object]') {
-            pretty = Object.keys(v).length > 1
-          }
-          return this.literalRepresentation(v, opts, indentLevel)
-        }.bind(this))
-        return concatArray(valuesRepresentation, pretty, opts.indent, indentLevel)
-      case '[object Object]':
-        var keyValuePairs = []
-        for (var k in value) {
-          keyValuePairs.push(util.format('"%s": %s', k, this.literalRepresentation(value[k], opts, indentLevel)))
+        let pretty = false;
+        const valuesRepresentation = value.map(
+          function (v) {
+            // Switch to prettify if the value is a dictionary with multiple keys
+            if (Object.prototype.toString.call(v) === '[object Object]') {
+              pretty = Object.keys(v).length > 1;
+            }
+            return this.literalRepresentation(v, opts, indentLevel);
+          }.bind(this)
+        );
+        return concatArray(valuesRepresentation, pretty, opts.indent, indentLevel);
+      }
+
+      case '[object Object]': {
+        const keyValuePairs = [];
+        // eslint-disable-next-line guard-for-in, no-restricted-syntax
+        for (const k in value) {
+          keyValuePairs.push(format('"%s": %s', k, this.literalRepresentation(value[k], opts, indentLevel)));
         }
-        return concatArray(keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel)
+        return concatArray(keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel);
+      }
+
       case '[object Boolean]':
-        return value.toString()
+        return value.toString();
+
       default:
         if (value === null || value === undefined) {
-          return ''
+          return '';
         }
-        return '"' + value.toString().replace(/"/g, '\\"') + '"'
+        return `"${value.toString().replace(/"/g, '\\"')}"`;
     }
-  }
-}
+  },
+};

package/src/targets/swift/index.js

@@ -1,12 +1,10 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'swift',
     title: 'Swift',
     extname: '.swift',
-    default: 'nsurlsession'
+    default: 'nsurlsession',
   },
 
-  nsurlsession: require('./nsurlsession')
-}
+  nsurlsession: require('./nsurlsession'),
+};

package/src/targets/swift/nsurlsession.js

@@ -8,131 +8,145 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var helpers = require('./helpers')
-var CodeBuilder = require('../../helpers/code-builder')
+const helpers = require('./helpers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  var opts = Object.assign({
+  const opts = {
     indent: '  ',
     pretty: true,
-    timeout: '10'
-  }, options)
+    timeout: '10',
+    ...options,
+  };
 
-  var code = new CodeBuilder(opts.indent)
+  const code = new CodeBuilder(opts.indent);
 
   // Markers for headers to be created as litteral objects and later be set on the NSURLRequest if exist
-  var req = {
+  const req = {
     hasHeaders: false,
-    hasBody: false
-  }
+    hasBody: false,
+  };
 
   // We just want to make sure people understand that is the only dependency
-  code.push('import Foundation')
+  code.push('import Foundation');
 
   if (Object.keys(source.allHeaders).length) {
-    req.hasHeaders = true
-    code.blank()
-        .push(helpers.literalDeclaration('headers', source.allHeaders, opts))
+    req.hasHeaders = true;
+    code.blank().push(helpers.literalDeclaration('headers', source.allHeaders, opts));
   }
 
   if (source.postData.text || source.postData.jsonObj || source.postData.params) {
-    req.hasBody = true
+    req.hasBody = true;
 
     switch (source.postData.mimeType) {
       case 'application/x-www-form-urlencoded':
         // By appending parameters one by one in the resulting snippet,
         // we make it easier for the user to edit it according to his or her needs after pasting.
         // The user can just add/remove lines adding/removing body parameters.
-        code.blank()
-            .push('let postData = NSMutableData(data: "%s=%s".data(using: String.Encoding.utf8)!)', source.postData.params[0].name, source.postData.params[0].value)
-        for (var i = 1, len = source.postData.params.length; i < len; i++) {
-          code.push('postData.append("&%s=%s".data(using: String.Encoding.utf8)!)', source.postData.params[i].name, source.postData.params[i].value)
+        code
+          .blank()
+          .push(
+            'let postData = NSMutableData(data: "%s=%s".data(using: String.Encoding.utf8)!)',
+            source.postData.params[0].name,
+            source.postData.params[0].value
+          );
+
+        // eslint-disable-next-line no-plusplus
+        for (let i = 1, len = source.postData.params.length; i < len; i++) {
+          code.push(
+            'postData.append("&%s=%s".data(using: String.Encoding.utf8)!)',
+            source.postData.params[i].name,
+            source.postData.params[i].value
+          );
         }
-        break
+        break;
 
       case 'application/json':
         if (source.postData.jsonObj) {
-          code.push(helpers.literalDeclaration('parameters', source.postData.jsonObj, opts), 'as [String : Any]')
-              .blank()
-              .push('let postData = JSONSerialization.data(withJSONObject: parameters, options: [])')
+          code
+            .push(helpers.literalDeclaration('parameters', source.postData.jsonObj, opts), 'as [String : Any]')
+            .blank()
+            .push('let postData = JSONSerialization.data(withJSONObject: parameters, options: [])');
         }
-        break
+        break;
 
       case 'multipart/form-data':
         /**
          * By appending multipart parameters one by one in the resulting snippet,
          * we make it easier for the user to edit it according to his or her needs after pasting.
          * The user can just edit the parameters NSDictionary or put this part of a snippet in a multipart builder method.
-        */
-        code.push(helpers.literalDeclaration('parameters', source.postData.params, opts))
-            .blank()
-            .push('let boundary = "%s"', source.postData.boundary)
-            .blank()
-            .push('var body = ""')
-            .push('var error: NSError? = nil')
-            .push('for param in parameters {')
-            .push(1, 'let paramName = param["name"]!')
-            .push(1, 'body += "--\\(boundary)\\r\\n"')
-            .push(1, 'body += "Content-Disposition:form-data; name=\\"\\(paramName)\\""')
-            .push(1, 'if let filename = param["fileName"] {')
-            .push(2, 'let contentType = param["content-type"]!')
-            .push(2, 'let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)')
-            .push(2, 'if (error != nil) {')
-            .push(3, 'print(error)')
-            .push(2, '}')
-            .push(2, 'body += "; filename=\\"\\(filename)\\"\\r\\n"')
-            .push(2, 'body += "Content-Type: \\(contentType)\\r\\n\\r\\n"')
-            .push(2, 'body += fileContent')
-            .push(1, '} else if let paramValue = param["value"] {')
-            .push(2, 'body += "\\r\\n\\r\\n\\(paramValue)"')
-            .push(1, '}')
-            .push('}')
-        break
+         */
+        code
+          .push(helpers.literalDeclaration('parameters', source.postData.params, opts))
+          .blank()
+          .push('let boundary = "%s"', source.postData.boundary)
+          .blank()
+          .push('var body = ""')
+          .push('var error: NSError? = nil')
+          .push('for param in parameters {')
+          .push(1, 'let paramName = param["name"]!')
+          .push(1, 'body += "--\\(boundary)\\r\\n"')
+          .push(1, 'body += "Content-Disposition:form-data; name=\\"\\(paramName)\\""')
+          .push(1, 'if let filename = param["fileName"] {')
+          .push(2, 'let contentType = param["content-type"]!')
+          .push(2, 'let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)')
+          .push(2, 'if (error != nil) {')
+          .push(3, 'print(error)')
+          .push(2, '}')
+          .push(2, 'body += "; filename=\\"\\(filename)\\"\\r\\n"')
+          .push(2, 'body += "Content-Type: \\(contentType)\\r\\n\\r\\n"')
+          .push(2, 'body += fileContent')
+          .push(1, '} else if let paramValue = param["value"] {')
+          .push(2, 'body += "\\r\\n\\r\\n\\(paramValue)"')
+          .push(1, '}')
+          .push('}');
+        break;
 
       default:
-        code.blank()
-            .push('let postData = NSData(data: "%s".data(using: String.Encoding.utf8)!)', source.postData.text)
+        code.blank().push('let postData = NSData(data: "%s".data(using: String.Encoding.utf8)!)', source.postData.text);
     }
   }
 
-  code.blank()
-      // NSURLRequestUseProtocolCachePolicy is the default policy, let's just always set it to avoid confusion.
-      .push('let request = NSMutableURLRequest(url: NSURL(string: "%s")! as URL,', source.fullUrl)
-      .push('                                        cachePolicy: .useProtocolCachePolicy,')
-      .push('                                    timeoutInterval: %s)', parseInt(opts.timeout, 10).toFixed(1))
-      .push('request.httpMethod = "%s"', source.method)
+  code
+    .blank()
+    // NSURLRequestUseProtocolCachePolicy is the default policy, let's just always set it to avoid confusion.
+    .push('let request = NSMutableURLRequest(url: NSURL(string: "%s")! as URL,', source.fullUrl)
+    .push('                                        cachePolicy: .useProtocolCachePolicy,')
+    .push('                                    timeoutInterval: %s)', parseInt(opts.timeout, 10).toFixed(1))
+    .push('request.httpMethod = "%s"', source.method);
 
   if (req.hasHeaders) {
-    code.push('request.allHTTPHeaderFields = headers')
+    code.push('request.allHTTPHeaderFields = headers');
   }
 
   if (req.hasBody) {
-    code.push('request.httpBody = postData as Data')
+    code.push('request.httpBody = postData as Data');
   }
 
-  code.blank()
-      // Retrieving the shared session will be less verbose than creating a new one.
-      .push('let session = URLSession.shared')
-      .push('let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in')
-      .push(1, 'if (error != nil) {')
-      .push(2, 'print(error)')
-      .push(1, '} else {')
-      // Casting the NSURLResponse to NSHTTPURLResponse so the user can see the status     .
-      .push(2, 'let httpResponse = response as? HTTPURLResponse')
-      .push(2, 'print(httpResponse)')
-      .push(1, '}')
-      .push('})')
-      .blank()
-      .push('dataTask.resume()')
-
-  return code.join()
-}
+  code
+    .blank()
+    // Retrieving the shared session will be less verbose than creating a new one.
+    .push('let session = URLSession.shared')
+    .push(
+      'let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in'
+    )
+    .push(1, 'if (error != nil) {')
+    .push(2, 'print(error)')
+    .push(1, '} else {')
+    // Casting the NSURLResponse to NSHTTPURLResponse so the user can see the status     .
+    .push(2, 'let httpResponse = response as? HTTPURLResponse')
+    .push(2, 'print(httpResponse)')
+    .push(1, '}')
+    .push('})')
+    .blank()
+    .push('dataTask.resume()');
+
+  return code.join();
+};
 
 module.exports.info = {
   key: 'nsurlsession',
   title: 'NSURLSession',
   link: 'https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html',
-  description: 'Foundation\'s NSURLSession request'
-}
+  description: "Foundation's NSURLSession request",
+};