@scalar/snippetz 0.7.4 → 0.7.5

package/dist/httpsnippet-lite/targets/shell/httpie/client.js

@@ -1,110 +1,124 @@
-import { CodeBuilder } from "../../../../httpsnippet-lite/helpers/code-builder.js";
-import { shellQuote } from "../../../../httpsnippet-lite/helpers/shell.js";
-const httpie = {
-  info: {
-    key: "httpie",
-    title: "HTTPie",
-    link: "http://httpie.org/",
-    description: "a CLI, cURL-like tool for humans"
-  },
-  convert: ({ allHeaders, postData, queryObj, fullUrl, method, url }, options) => {
-    const opts = {
-      body: false,
-      cert: false,
-      headers: false,
-      indent: "  ",
-      pretty: false,
-      print: false,
-      queryParams: false,
-      short: false,
-      style: false,
-      timeout: false,
-      verbose: false,
-      verify: false,
-      ...options
-    };
-    const { push, join, unshift } = new CodeBuilder({
-      indent: opts.indent,
-      // @ts-expect-error SEEMS LEGIT
-      join: opts.indent !== false ? ` \\
-${opts.indent}` : " "
-    });
-    let raw = false;
-    const flags = [];
-    if (opts.headers) {
-      flags.push(opts.short ? "-h" : "--headers");
-    }
-    if (opts.body) {
-      flags.push(opts.short ? "-b" : "--body");
-    }
-    if (opts.verbose) {
-      flags.push(opts.short ? "-v" : "--verbose");
-    }
-    if (opts.print) {
-      flags.push(`${opts.short ? "-p" : "--print"}=${opts.print}`);
-    }
-    if (opts.verify) {
-      flags.push(`--verify=${opts.verify}`);
-    }
-    if (opts.cert) {
-      flags.push(`--cert=${opts.cert}`);
-    }
-    if (opts.pretty) {
-      flags.push(`--pretty=${opts.pretty}`);
-    }
-    if (opts.style) {
-      flags.push(`--style=${opts.style}`);
-    }
-    if (opts.timeout) {
-      flags.push(`--timeout=${opts.timeout}`);
-    }
-    if (opts.queryParams) {
-      Object.keys(queryObj).forEach((name) => {
-        const value = queryObj[name];
-        if (Array.isArray(value)) {
-          value.forEach((val) => {
-            push(`${name}==${shellQuote(val)}`);
-          });
-        } else {
-          push(`${name}==${shellQuote(value)}`);
-        }
-      });
-    }
-    Object.keys(allHeaders).sort().forEach((key) => {
-      push(`${key}:${shellQuote(allHeaders[key])}`);
-    });
-    if ((postData === null || postData === void 0 ? void 0 : postData.mimeType) === "application/x-www-form-urlencoded") {
-      if (postData.params?.length) {
-        flags.push(opts.short ? "-f" : "--form");
-        postData.params.forEach((param) => {
-          push(`${param.name}=${shellQuote(param.value)}`);
+/**
+ * @description
+ * HTTP code snippet generator for the Shell using HTTPie.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import { CodeBuilder } from '../../../../httpsnippet-lite/helpers/code-builder.js';
+import { shellQuote } from '../../../../httpsnippet-lite/helpers/shell.js';
+export const httpie = {
+    info: {
+        key: 'httpie',
+        title: 'HTTPie',
+        link: 'http://httpie.org/',
+        description: 'a CLI, cURL-like tool for humans',
+    },
+    convert: ({ allHeaders, postData, queryObj, fullUrl, method, url }, options) => {
+        const opts = {
+            body: false,
+            cert: false,
+            headers: false,
+            indent: '  ',
+            pretty: false,
+            print: false,
+            queryParams: false,
+            short: false,
+            style: false,
+            timeout: false,
+            verbose: false,
+            verify: false,
+            ...options,
+        };
+        const { push, join, unshift } = new CodeBuilder({
+            indent: opts.indent,
+            // @ts-expect-error SEEMS LEGIT
+            join: opts.indent !== false ? ` \\\n${opts.indent}` : ' ',
         });
-      }
-    } else if ((postData === null || postData === void 0 ? void 0 : postData.mimeType) === "multipart/form-data") {
-      if (postData?.params?.length) {
-        flags.push("--multipart");
-        postData.params.forEach((param) => {
-          if (param.fileName) {
-            push(`${param.name}@${shellQuote(param.fileName)}`);
-          } else {
-            push(`${param.name}='${shellQuote(param.value)}'`);
-          }
+        let raw = false;
+        const flags = [];
+        if (opts.headers) {
+            flags.push(opts.short ? '-h' : '--headers');
+        }
+        if (opts.body) {
+            flags.push(opts.short ? '-b' : '--body');
+        }
+        if (opts.verbose) {
+            flags.push(opts.short ? '-v' : '--verbose');
+        }
+        if (opts.print) {
+            flags.push(`${opts.short ? '-p' : '--print'}=${opts.print}`);
+        }
+        if (opts.verify) {
+            flags.push(`--verify=${opts.verify}`);
+        }
+        if (opts.cert) {
+            flags.push(`--cert=${opts.cert}`);
+        }
+        if (opts.pretty) {
+            flags.push(`--pretty=${opts.pretty}`);
+        }
+        if (opts.style) {
+            flags.push(`--style=${opts.style}`);
+        }
+        if (opts.timeout) {
+            flags.push(`--timeout=${opts.timeout}`);
+        }
+        // construct query params
+        if (opts.queryParams) {
+            Object.keys(queryObj).forEach((name) => {
+                const value = queryObj[name];
+                if (Array.isArray(value)) {
+                    value.forEach((val) => {
+                        push(`${name}==${shellQuote(val)}`);
+                    });
+                }
+                else {
+                    push(`${name}==${shellQuote(value)}`);
+                }
+            });
+        }
+        // construct headers
+        Object.keys(allHeaders)
+            .sort()
+            .forEach((key) => {
+            push(`${key}:${shellQuote(allHeaders[key])}`);
         });
-      }
-    } else {
-      raw = true;
-    }
-    const cliFlags = flags.length ? `${flags.join(" ")} ` : "";
-    url = shellQuote(opts.queryParams ? url : fullUrl);
-    unshift(`http ${cliFlags}${method} ${url}`);
-    if (raw && (postData === null || postData === void 0 ? void 0 : postData.text)) {
-      const postDataText = shellQuote(postData.text);
-      unshift(`echo ${postDataText} | `);
-    }
-    return join();
-  }
-};
-export {
-  httpie
+        if ((postData === null || postData === void 0 ? void 0 : postData.mimeType) === 'application/x-www-form-urlencoded') {
+            // construct post params
+            if (postData.params?.length) {
+                flags.push(opts.short ? '-f' : '--form');
+                postData.params.forEach((param) => {
+                    push(`${param.name}=${shellQuote(param.value)}`);
+                });
+            }
+        }
+        else if ((postData === null || postData === void 0 ? void 0 : postData.mimeType) === 'multipart/form-data') {
+            // construct multipart form data
+            if (postData?.params?.length) {
+                flags.push('--multipart');
+                postData.params.forEach((param) => {
+                    if (param.fileName) {
+                        push(`${param.name}@${shellQuote(param.fileName)}`);
+                    }
+                    else {
+                        push(`${param.name}='${shellQuote(param.value)}'`);
+                    }
+                });
+            }
+        }
+        else {
+            raw = true;
+        }
+        const cliFlags = flags.length ? `${flags.join(' ')} ` : '';
+        url = shellQuote(opts.queryParams ? url : fullUrl);
+        unshift(`http ${cliFlags}${method} ${url}`);
+        if (raw && (postData === null || postData === void 0 ? void 0 : postData.text)) {
+            const postDataText = shellQuote(postData.text);
+            unshift(`echo ${postDataText} | `);
+        }
+        return join();
+    },
 };
-//# sourceMappingURL=client.js.map

package/dist/httpsnippet-lite/targets/shell/wget/client.js

@@ -1,44 +1,49 @@
-import { CodeBuilder } from "../../../../httpsnippet-lite/helpers/code-builder.js";
-import { shellEscape, shellQuote } from "../../../../httpsnippet-lite/helpers/shell.js";
-const wget = {
-  info: {
-    key: "wget",
-    title: "Wget",
-    link: "https://www.gnu.org/software/wget/",
-    description: "a free software package for retrieving files using HTTP, HTTPS"
-  },
-  convert: ({ method, postData, allHeaders, fullUrl }, options) => {
-    const opts = {
-      indent: "  ",
-      short: false,
-      verbose: false,
-      ...options
-    };
-    const { push, join } = new CodeBuilder({
-      indent: opts.indent,
-      // @ts-expect-error SEEMS LEGIT
-      join: opts.indent !== false ? ` \\
-${opts.indent}` : " "
-    });
-    if (opts.verbose) {
-      push(`wget ${opts.short ? "-v" : "--verbose"}`);
-    } else {
-      push(`wget ${opts.short ? "-q" : "--quiet"}`);
-    }
-    push(`--method ${shellQuote(method)}`);
-    Object.keys(allHeaders).forEach((key) => {
-      const header = `${key}: ${allHeaders[key]}`;
-      push(`--header ${shellQuote(header)}`);
-    });
-    if (postData === null || postData === void 0 ? void 0 : postData.text) {
-      push(`--body-data ${shellEscape(shellQuote(postData.text))}`);
-    }
-    push(opts.short ? "-O" : "--output-document");
-    push(`- ${shellQuote(fullUrl)}`);
-    return join();
-  }
+/**
+ * @description
+ * HTTP code snippet generator for the Shell using Wget.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import { CodeBuilder } from '../../../../httpsnippet-lite/helpers/code-builder.js';
+import { shellEscape, shellQuote } from '../../../../httpsnippet-lite/helpers/shell.js';
+export const wget = {
+    info: {
+        key: 'wget',
+        title: 'Wget',
+        link: 'https://www.gnu.org/software/wget/',
+        description: 'a free software package for retrieving files using HTTP, HTTPS',
+    },
+    convert: ({ method, postData, allHeaders, fullUrl }, options) => {
+        const opts = {
+            indent: '  ',
+            short: false,
+            verbose: false,
+            ...options,
+        };
+        const { push, join } = new CodeBuilder({
+            indent: opts.indent,
+            // @ts-expect-error SEEMS LEGIT
+            join: opts.indent !== false ? ` \\\n${opts.indent}` : ' ',
+        });
+        if (opts.verbose) {
+            push(`wget ${opts.short ? '-v' : '--verbose'}`);
+        }
+        else {
+            push(`wget ${opts.short ? '-q' : '--quiet'}`);
+        }
+        push(`--method ${shellQuote(method)}`);
+        Object.keys(allHeaders).forEach((key) => {
+            const header = `${key}: ${allHeaders[key]}`;
+            push(`--header ${shellQuote(header)}`);
+        });
+        if (postData === null || postData === void 0 ? void 0 : postData.text) {
+            push(`--body-data ${shellEscape(shellQuote(postData.text))}`);
+        }
+        push(opts.short ? '-O' : '--output-document');
+        push(`- ${shellQuote(fullUrl)}`);
+        return join();
+    },
 };
-export {
-  wget
-};
-//# sourceMappingURL=client.js.map

package/dist/httpsnippet-lite/targets/swift/helpers.js

@@ -1,52 +1,70 @@
+/**
+ * Create an string of given length filled with blank spaces
+ *
+ * @param length Length of the array to return
+ * @param str String to pad out with
+ */
 const buildString = (length, str) => str.repeat(length);
+/**
+ * Create a string corresponding to a Dictionary or Array literal representation with pretty option and indentation.
+ */
 const concatArray = (arr, pretty, indentation, indentLevel) => {
-  const currentIndent = buildString(indentLevel, indentation);
-  const closingBraceIndent = buildString(indentLevel - 1, indentation);
-  const join = pretty ? `,
-${currentIndent}` : ", ";
-  if (pretty) {
-    return `[
-${currentIndent}${arr.join(join)}
-${closingBraceIndent}]`;
-  }
-  return `[${arr.join(join)}]`;
+    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}]`;
+    }
+    return `[${arr.join(join)}]`;
 };
-const literalDeclaration = (name, parameters, opts) => `let ${name} = ${literalRepresentation(parameters, opts)}`;
+/**
+ * Create a string corresponding to a valid declaration and initialization of a Swift array or dictionary literal
+ *
+ * @param name Desired name of the instance
+ * @param parameters Key-value object of parameters to translate to a Swift object literal
+ * @param opts Target options
+ * @return {string}
+ */
+export const literalDeclaration = (name, parameters, opts) => `let ${name} = ${literalRepresentation(parameters, opts)}`;
+/**
+ * Create a valid Swift string of a literal value according to its type.
+ *
+ * @param value Any JavaScript literal
+ * @param opts Target options
+ */
 const literalRepresentation = (value, opts, indentLevelInput) => {
-  const indentLevel = indentLevelInput === void 0 ? 1 : indentLevelInput + 1;
-  switch (Object.prototype.toString.call(value)) {
-    case "[object Number]":
-      return value;
-    case "[object Array]": {
-      let pretty = false;
-      const valuesRepresentation = value.map((v) => {
-        if (Object.prototype.toString.call(v) === "[object Object]") {
-          pretty = Object.keys(v).length > 1;
+    const indentLevel = indentLevelInput === undefined ? 1 : indentLevelInput + 1;
+    switch (Object.prototype.toString.call(value)) {
+        case '[object Number]':
+            return value;
+        case '[object Array]': {
+            // Don't prettify arrays to avoid taking too much space
+            let pretty = false;
+            const valuesRepresentation = value.map((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 literalRepresentation(v, opts, indentLevel);
+            });
+            return concatArray(valuesRepresentation, pretty, opts.indent, indentLevel);
         }
-        return literalRepresentation(v, opts, indentLevel);
-      });
-      return concatArray(valuesRepresentation, pretty, opts.indent, indentLevel);
-    }
-    case "[object Object]": {
-      const keyValuePairs = [];
-      const _value = value;
-      for (const key in _value) {
-        if (Object.hasOwn(_value, key)) {
-          keyValuePairs.push(`"${key}": ${literalRepresentation(_value[key], opts, indentLevel)}`);
+        case '[object Object]': {
+            const keyValuePairs = [];
+            const _value = value;
+            for (const key in _value) {
+                if (Object.hasOwn(_value, key)) {
+                    keyValuePairs.push(`"${key}": ${literalRepresentation(_value[key], 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();
+        default:
+            if (value === null || value === undefined) {
+                return '';
+            }
+            return `"${value.toString().replace(/"/g, '\\"')}"`;
     }
-    case "[object Boolean]":
-      return value.toString();
-    default:
-      if (value === null || value === void 0) {
-        return "";
-      }
-      return `"${value.toString().replace(/"/g, '\\"')}"`;
-  }
-};
-export {
-  literalDeclaration
 };
-//# sourceMappingURL=helpers.js.map