@scalar/snippetz 0.2.7 → 0.2.8

package/dist/_virtual/client4.js

@@ -0,0 +1,70 @@
+import { CodeBuilder } from '../httpsnippet-lite/dist/esm/helpers/code-builder.js';
+import { escapeForSingleQuotes } from '../httpsnippet-lite/dist/esm/helpers/escape.js';
+
+const native = {
+    info: {
+        key: 'native',
+        title: 'net::http',
+        link: 'http://ruby-doc.org/stdlib-2.2.1/libdoc/net/http/rdoc/Net/HTTP.html',
+        description: 'Ruby HTTP client',
+    },
+    convert: ({ uriObj, method: rawMethod, fullUrl, postData, allHeaders }, options = {}) => {
+        const { insecureSkipVerify = false } = options;
+        const { push, blank, join } = new CodeBuilder();
+        push("require 'uri'");
+        push("require 'net/http'");
+        blank();
+        // To support custom methods we check for the supported methods
+        // and if doesn't exist then we build a custom class for it
+        const method = rawMethod.toUpperCase();
+        const methods = [
+            'GET',
+            'POST',
+            'HEAD',
+            'DELETE',
+            'PATCH',
+            'PUT',
+            'OPTIONS',
+            'COPY',
+            'LOCK',
+            'UNLOCK',
+            'MOVE',
+            'TRACE',
+        ];
+        const capMethod = method.charAt(0) + method.substring(1).toLowerCase();
+        if (!methods.includes(method)) {
+            push(`class Net::HTTP::${capMethod} < Net::HTTPRequest`);
+            push(`  METHOD = '${method.toUpperCase()}'`);
+            push(`  REQUEST_HAS_BODY = '${(postData === null || postData === void 0 ? void 0 : postData.text) ? 'true' : 'false'}'`);
+            push('  RESPONSE_HAS_BODY = true');
+            push('end');
+            blank();
+        }
+        push(`url = URI("${fullUrl}")`);
+        blank();
+        push('http = Net::HTTP.new(url.host, url.port)');
+        if (uriObj.protocol === 'https:') {
+            push('http.use_ssl = true');
+            if (insecureSkipVerify) {
+                push('http.verify_mode = OpenSSL::SSL::VERIFY_NONE');
+            }
+        }
+        blank();
+        push(`request = Net::HTTP::${capMethod}.new(url)`);
+        const headers = Object.keys(allHeaders);
+        if (headers.length) {
+            headers.forEach(key => {
+                push(`request["${key}"] = '${escapeForSingleQuotes(allHeaders[key])}'`);
+            });
+        }
+        if (postData === null || postData === void 0 ? void 0 : postData.text) {
+            push(`request.body = ${JSON.stringify(postData.text)}`);
+        }
+        blank();
+        push('response = http.request(request)');
+        push('puts response.read_body');
+        return join();
+    },
+};
+
+export { native };

package/dist/_virtual/client5.js

@@ -0,0 +1,123 @@
+import { CodeBuilder } from '../httpsnippet-lite/dist/esm/helpers/code-builder.js';
+import { escapeForDoubleQuotes, escapeForSingleQuotes } from '../httpsnippet-lite/dist/esm/helpers/escape.js';
+import { getHeader } from '../httpsnippet-lite/dist/esm/helpers/headers.js';
+
+/**
+ * @description
+ * HTTP code snippet generator for R using httr
+ *
+ * @author
+ * @gabrielakoreeda
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+const httr = {
+    info: {
+        key: 'httr',
+        title: 'httr',
+        link: 'https://cran.r-project.org/web/packages/httr/vignettes/quickstart.html',
+        description: 'httr: Tools for Working with URLs and HTTP',
+    },
+    convert: ({ url, queryObj, queryString, postData, allHeaders, method }, options = {}) => {
+        var _a, _b;
+        // Start snippet
+        const { push, blank, join } = new CodeBuilder({
+            indent: (_a = options.indent) !== null && _a !== void 0 ? _a : '  ',
+        });
+        // Import httr
+        push('library(httr)');
+        blank();
+        // Set URL
+        push(`url <- "${url}"`);
+        blank();
+        // Construct query string
+        const qs = queryObj;
+        delete queryObj.key;
+        const entries = Object.entries(qs);
+        const entriesCount = entries.length;
+        if (entriesCount === 1) {
+            const entry = entries[0];
+            push(`queryString <- list(${entry[0]} = "${entry[1]}")`);
+            blank();
+        }
+        else if (entriesCount > 1) {
+            push('queryString <- list(');
+            entries.forEach(([key, value], i) => {
+                const isLastItem = i !== entriesCount - 1;
+                const maybeComma = isLastItem ? ',' : '';
+                push(`${key} = "${value}"${maybeComma}`, 1);
+            });
+            push(')');
+            blank();
+        }
+        // Construct payload
+        const payload = JSON.stringify(postData === null || postData === void 0 ? void 0 : postData.text);
+        if (payload) {
+            push(`payload <- ${payload}`);
+            blank();
+        }
+        // Define encode
+        if (postData && (postData.text || postData.jsonObj || postData.params)) {
+            switch (postData.mimeType) {
+                case 'application/x-www-form-urlencoded':
+                    push('encode <- "form"');
+                    blank();
+                    break;
+                case 'application/json':
+                    push('encode <- "json"');
+                    blank();
+                    break;
+                case 'multipart/form-data':
+                    push('encode <- "multipart"');
+                    blank();
+                    break;
+                default:
+                    push('encode <- "raw"');
+                    blank();
+                    break;
+            }
+        }
+        // Construct headers
+        const cookieHeader = getHeader(allHeaders, 'cookie');
+        const acceptHeader = getHeader(allHeaders, 'accept');
+        const setCookies = cookieHeader
+            ? `set_cookies(\`${String(cookieHeader)
+                .replace(/;/g, '", `')
+                .replace(/` /g, '`')
+                .replace(/[=]/g, '` = "')}")`
+            : undefined;
+        const setAccept = acceptHeader ? `accept("${escapeForDoubleQuotes(acceptHeader)}")` : undefined;
+        const setContentType = `content_type("${escapeForDoubleQuotes((_b = postData === null || postData === void 0 ? void 0 : postData.mimeType) !== null && _b !== void 0 ? _b : 'application/octet-stream')}")`;
+        const otherHeaders = Object.entries(allHeaders)
+            // These headers are all handled separately:
+            .filter(([key]) => !['cookie', 'accept', 'content-type'].includes(key.toLowerCase()))
+            .map(([key, value]) => `'${key}' = '${escapeForSingleQuotes(value)}'`)
+            .join(', ');
+        const setHeaders = otherHeaders ? `add_headers(${otherHeaders})` : undefined;
+        // Construct request
+        let request = `response <- VERB("${method}", url`;
+        if (payload) {
+            request += ', body = payload';
+        }
+        if (queryString.length) {
+            request += ', query = queryString';
+        }
+        const headerAdditions = [setHeaders, setContentType, setAccept, setCookies]
+            .filter(x => !!x)
+            .join(', ');
+        if (headerAdditions) {
+            request += `, ${headerAdditions}`;
+        }
+        if (postData && (postData.text || postData.jsonObj || postData.params)) {
+            request += ', encode = encode';
+        }
+        request += ')';
+        push(request);
+        blank();
+        // Print response
+        push('content(response, "text")');
+        return join();
+    },
+};
+
+export { httr };

package/dist/_virtual/client6.js

@@ -0,0 +1,166 @@
+import { CodeBuilder } from '../httpsnippet-lite/dist/esm/helpers/code-builder.js';
+import { escapeForDoubleQuotes } from '../httpsnippet-lite/dist/esm/helpers/escape.js';
+import { getHeaderName } from '../httpsnippet-lite/dist/esm/helpers/headers.js';
+import { literalRepresentation } from '../httpsnippet-lite/dist/esm/targets/python/helpers.js';
+
+/**
+ * @description
+ * HTTP code snippet generator for Python using Requests
+ *
+ * @author
+ * @montanaflynn
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+const builtInMethods = ['HEAD', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'];
+const requests = {
+    info: {
+        key: 'requests',
+        title: 'Requests',
+        link: 'http://docs.python-requests.org/en/latest/api/#requests.request',
+        description: 'Requests HTTP library',
+    },
+    convert: ({ queryObj, url, postData, allHeaders, method }, options) => {
+        const opts = {
+            indent: '    ',
+            pretty: true,
+            ...options,
+        };
+        // Start snippet
+        const { push, blank, join } = new CodeBuilder({ indent: opts.indent });
+        // Import requests
+        push('import requests');
+        blank();
+        // Set URL
+        push(`url = "${url}"`);
+        blank();
+        // Construct query string
+        let qs;
+        if (Object.keys(queryObj).length) {
+            qs = `querystring = ${JSON.stringify(queryObj)}`;
+            push(qs);
+            blank();
+        }
+        const headers = allHeaders;
+        // Construct payload
+        let payload = {};
+        const files = {};
+        let hasFiles = false;
+        let hasPayload = false;
+        let jsonPayload = false;
+        switch (postData === null || postData === void 0 ? void 0 : postData.mimeType) {
+            case 'application/json':
+                if (postData.jsonObj) {
+                    push(`payload = ${literalRepresentation(postData.jsonObj, opts)}`);
+                    jsonPayload = true;
+                    hasPayload = true;
+                }
+                break;
+            case 'multipart/form-data':
+                if (!postData.params) {
+                    break;
+                }
+                payload = {};
+                postData.params.forEach(p => {
+                    if (p.fileName) {
+                        files[p.name] = `open('${p.fileName}', 'rb')`;
+                        hasFiles = true;
+                    }
+                    else {
+                        payload[p.name] = p.value;
+                        hasPayload = true;
+                    }
+                });
+                if (hasFiles) {
+                    push(`files = ${literalRepresentation(files, opts)}`);
+                    if (hasPayload) {
+                        push(`payload = ${literalRepresentation(payload, opts)}`);
+                    }
+                    // The requests library will only automatically add a `multipart/form-data` header if there are files being sent. If we're **only** sending form data we still need to send the boundary ourselves.
+                    const headerName = getHeaderName(headers, 'content-type');
+                    if (headerName) {
+                        delete headers[headerName];
+                    }
+                }
+                else {
+                    const nonFilePayload = JSON.stringify(postData.text);
+                    if (nonFilePayload) {
+                        push(`payload = ${nonFilePayload}`);
+                        hasPayload = true;
+                    }
+                }
+                break;
+            default: {
+                if (!postData) {
+                    break;
+                }
+                if (postData.mimeType === 'application/x-www-form-urlencoded' && postData.paramsObj) {
+                    push(`payload = ${literalRepresentation(postData.paramsObj, opts)}`);
+                    hasPayload = true;
+                    break;
+                }
+                const payload = JSON.stringify(postData.text);
+                if (payload) {
+                    push(`payload = ${payload}`);
+                    hasPayload = true;
+                }
+            }
+        }
+        // Construct headers
+        const headerCount = Object.keys(headers).length;
+        if (headerCount === 0 && (hasPayload || hasFiles)) {
+            // If we don't have any heads but we do have a payload we should put a blank line here between that payload consturction and our execution of the requests library.
+            blank();
+        }
+        else if (headerCount === 1) {
+            for (const header in headers) {
+                push(`headers = {"${header}": "${escapeForDoubleQuotes(headers[header])}"}`);
+                blank();
+            }
+        }
+        else if (headerCount > 1) {
+            let count = 1;
+            push('headers = {');
+            for (const header in headers) {
+                if (count !== headerCount) {
+                    push(`"${header}": "${escapeForDoubleQuotes(headers[header])}",`, 1);
+                }
+                else {
+                    push(`"${header}": "${escapeForDoubleQuotes(headers[header])}"`, 1);
+                }
+                count += 1;
+            }
+            push('}');
+            blank();
+        }
+        // Construct request
+        let request = builtInMethods.includes(method)
+            ? `response = requests.${method.toLowerCase()}(url`
+            : `response = requests.request("${method}", url`;
+        if (hasPayload) {
+            if (jsonPayload) {
+                request += ', json=payload';
+            }
+            else {
+                request += ', data=payload';
+            }
+        }
+        if (hasFiles) {
+            request += ', files=files';
+        }
+        if (headerCount > 0) {
+            request += ', headers=headers';
+        }
+        if (qs) {
+            request += ', params=querystring';
+        }
+        request += ')';
+        push(request);
+        blank();
+        // Print response
+        push('print(response.json())');
+        return join();
+    },
+};
+
+export { requests };

package/dist/_virtual/client7.js

@@ -0,0 +1,91 @@
+import { CodeBuilder } from '../httpsnippet-lite/dist/esm/helpers/code-builder.js';
+import { escapeForDoubleQuotes } from '../httpsnippet-lite/dist/esm/helpers/escape.js';
+
+/**
+ * @description
+ * HTTP code snippet generator for native Python3.
+ *
+ * @author
+ * @montanaflynn
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+const python3 = {
+    info: {
+        key: 'python3',
+        title: 'http.client',
+        link: 'https://docs.python.org/3/library/http.client.html',
+        description: 'Python3 HTTP Client',
+    },
+    convert: ({ uriObj: { path, protocol, host }, postData, allHeaders, method }, options = {}) => {
+        const { insecureSkipVerify = false } = options;
+        const { push, blank, join } = new CodeBuilder();
+        // Start Request
+        push('import http.client');
+        if (insecureSkipVerify) {
+            push('import ssl');
+        }
+        blank();
+        // Check which protocol to be used for the client connection
+        if (protocol === 'https:') {
+            const sslContext = insecureSkipVerify ? ', context = ssl._create_unverified_context()' : '';
+            push(`conn = http.client.HTTPSConnection("${host}"${sslContext})`);
+            blank();
+        }
+        else {
+            push(`conn = http.client.HTTPConnection("${host}")`);
+            blank();
+        }
+        // Create payload string if it exists
+        const payload = JSON.stringify(postData === null || postData === void 0 ? void 0 : postData.text);
+        if (payload) {
+            push(`payload = ${payload}`);
+            blank();
+        }
+        // Create Headers
+        const headers = allHeaders;
+        const headerCount = Object.keys(headers).length;
+        if (headerCount === 1) {
+            for (const header in headers) {
+                push(`headers = { '${header}': "${escapeForDoubleQuotes(headers[header])}" }`);
+                blank();
+            }
+        }
+        else if (headerCount > 1) {
+            let count = 1;
+            push('headers = {');
+            for (const header in headers) {
+                if (count++ !== headerCount) {
+                    push(`    '${header}': "${escapeForDoubleQuotes(headers[header])}",`);
+                }
+                else {
+                    push(`    '${header}': "${escapeForDoubleQuotes(headers[header])}"`);
+                }
+            }
+            push('}');
+            blank();
+        }
+        // Make Request
+        if (payload && headerCount) {
+            push(`conn.request("${method}", "${path}", payload, headers)`);
+        }
+        else if (payload && !headerCount) {
+            push(`conn.request("${method}", "${path}", payload)`);
+        }
+        else if (!payload && headerCount) {
+            push(`conn.request("${method}", "${path}", headers=headers)`);
+        }
+        else {
+            push(`conn.request("${method}", "${path}")`);
+        }
+        // Get Response
+        blank();
+        push('res = conn.getresponse()');
+        push('data = res.read()');
+        blank();
+        push('print(data.decode("utf-8"))');
+        return join();
+    },
+};
+
+export { python3 };

package/dist/_virtual/client8.js

@@ -0,0 +1,13 @@
+import { generatePowershellConvert } from '../httpsnippet-lite/dist/esm/targets/powershell/common.js';
+
+const webrequest = {
+    info: {
+        key: 'webrequest',
+        title: 'Invoke-WebRequest',
+        link: 'https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-WebRequest',
+        description: 'Powershell Invoke-WebRequest client',
+    },
+    convert: generatePowershellConvert('Invoke-WebRequest'),
+};
+
+export { webrequest };

package/dist/_virtual/client9.js

@@ -0,0 +1,13 @@
+import { generatePowershellConvert } from '../httpsnippet-lite/dist/esm/targets/powershell/common.js';
+
+const restmethod = {
+    info: {
+        key: 'restmethod',
+        title: 'Invoke-RestMethod',
+        link: 'https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod',
+        description: 'Powershell Invoke-RestMethod client',
+    },
+    convert: generatePowershellConvert('Invoke-RestMethod'),
+};
+
+export { restmethod };

package/dist/core/utils/convertWithHttpSnippetLite.d.ts

@@ -1,5 +1,5 @@
+import type { Client } from '@/httpsnippet-lite/dist/types/targets/targets';
 import type { Request } from 'har-format';
-import type { Client } from '../../../node_modules/httpsnippet-lite/dist/types/targets/targets';
 /**
  * Takes a httpsnippet-lite client and converts the given request to a code example with it.
  */

package/dist/core/utils/convertWithHttpSnippetLite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"convertWithHttpSnippetLite.d.ts","sourceRoot":"","sources":["../../../src/core/utils/convertWithHttpSnippetLite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8CAA8C,CAAA;AAE1E;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EACtB,cAAc,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAChC,MAAM,CAiGR"}
+{"version":3,"file":"convertWithHttpSnippetLite.d.ts","sourceRoot":"","sources":["../../../src/core/utils/convertWithHttpSnippetLite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+CAA+C,CAAA;AAC3E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEzC;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EACtB,cAAc,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAChC,MAAM,CAiGR"}

package/dist/httpsnippet-lite/dist/esm/helpers/code-builder.js

@@ -0,0 +1,60 @@
+const DEFAULT_INDENTATION_CHARACTER = '';
+const DEFAULT_LINE_JOIN = '\n';
+class CodeBuilder {
+    /**
+     * Helper object to format and aggragate lines of code.
+     * Lines are aggregated in a `code` array, and need to be joined to obtain a proper code snippet.
+     */
+    constructor({ indent, join } = {}) {
+        this.postProcessors = [];
+        this.code = [];
+        this.indentationCharacter = DEFAULT_INDENTATION_CHARACTER;
+        this.lineJoin = DEFAULT_LINE_JOIN;
+        /**
+         * Add given indentation level to given line of code
+         */
+        this.indentLine = (line, indentationLevel = 0) => {
+            const indent = this.indentationCharacter.repeat(indentationLevel);
+            return `${indent}${line}`;
+        };
+        /**
+         * Add the line at the beginning of the current lines
+         */
+        this.unshift = (line, indentationLevel) => {
+            const newLine = this.indentLine(line, indentationLevel);
+            this.code.unshift(newLine);
+        };
+        /**
+         * Add the line at the end of the current lines
+         */
+        this.push = (line, indentationLevel) => {
+            const newLine = this.indentLine(line, indentationLevel);
+            this.code.push(newLine);
+        };
+        /**
+         * Add an empty line at the end of current lines
+         */
+        this.blank = () => {
+            this.code.push('');
+        };
+        /**
+         * Concatenate all current lines using the given lineJoin, then apply any replacers that may have been added
+         */
+        this.join = () => {
+            const unreplacedCode = this.code.join(this.lineJoin);
+            const replacedOutput = this.postProcessors.reduce((accumulator, replacer) => replacer(accumulator), unreplacedCode);
+            return replacedOutput;
+        };
+        /**
+         * Often when writing modules you may wish to add a literal tag or bit of metadata that you wish to transform after other processing as a final step.
+         * To do so, you can provide a PostProcessor function and it will be run automatically for you when you call `join()` later on.
+         */
+        this.addPostProcessor = (postProcessor) => {
+            this.postProcessors = [...this.postProcessors, postProcessor];
+        };
+        this.indentationCharacter = indent || DEFAULT_INDENTATION_CHARACTER;
+        this.lineJoin = join !== null && join !== void 0 ? join : DEFAULT_LINE_JOIN;
+    }
+}
+
+export { CodeBuilder };

package/dist/httpsnippet-lite/dist/esm/helpers/escape.js

@@ -0,0 +1,72 @@
+/**
+ * Escape characters within a value to make it safe to insert directly into a
+ * snippet. Takes options which define the escape requirements.
+ *
+ * This is closely based on the JSON-stringify string serialization algorithm,
+ * but generalized for other string delimiters (e.g. " or ') and different escape
+ * characters (e.g. Powershell uses `)
+ *
+ * See https://tc39.es/ecma262/multipage/structured-data.html#sec-quotejsonstring
+ * for the complete original algorithm.
+ */
+function escapeString(rawValue, options = {}) {
+    const { delimiter = '"', escapeChar = '\\', escapeNewlines = true } = options;
+    const stringValue = rawValue.toString();
+    return [...stringValue]
+        .map(c => {
+        if (c === '\b') {
+            return `${escapeChar}b`;
+        }
+        else if (c === '\t') {
+            return `${escapeChar}t`;
+        }
+        else if (c === '\n') {
+            if (escapeNewlines) {
+                return `${escapeChar}n`;
+            }
+            return c; // Don't just continue, or this is caught by < \u0020
+        }
+        else if (c === '\f') {
+            return `${escapeChar}f`;
+        }
+        else if (c === '\r') {
+            if (escapeNewlines) {
+                return `${escapeChar}r`;
+            }
+            return c; // Don't just continue, or this is caught by < \u0020
+        }
+        else if (c === escapeChar) {
+            return escapeChar + escapeChar;
+        }
+        else if (c === delimiter) {
+            return escapeChar + delimiter;
+        }
+        else if (c < '\u0020' || c > '\u007E') {
+            // Delegate the trickier non-ASCII cases to the normal algorithm. Some of these
+            // are escaped as \uXXXX, whilst others are represented literally. Since we're
+            // using this primarily for header values that are generally (though not 100%
+            // strictly?) ASCII-only, this should almost never happen.
+            return JSON.stringify(c).slice(1, -1);
+        }
+        return c;
+    })
+        .join('');
+}
+/**
+ * Make a string value safe to insert literally into a snippet within single quotes,
+ * by escaping problematic characters, including single quotes inside the string,
+ * backslashes, newlines, and other special characters.
+ *
+ * If value is not a string, it will be stringified with .toString() first.
+ */
+const escapeForSingleQuotes = (value) => escapeString(value, { delimiter: "'" });
+/**
+ * Make a string value safe to insert literally into a snippet within double quotes,
+ * by escaping problematic characters, including double quotes inside the string,
+ * backslashes, newlines, and other special characters.
+ *
+ * If value is not a string, it will be stringified with .toString() first.
+ */
+const escapeForDoubleQuotes = (value) => escapeString(value, { delimiter: '"' });
+
+export { escapeForDoubleQuotes, escapeForSingleQuotes, escapeString };

package/dist/httpsnippet-lite/dist/esm/helpers/headers.js

@@ -0,0 +1,20 @@
+/**
+ * Given a headers object retrieve a specific header out of it via a case-insensitive key.
+ */
+const getHeaderName = (headers, name) => Object.keys(headers).find(header => header.toLowerCase() === name.toLowerCase());
+/**
+ * Given a headers object retrieve the contents of a header out of it via a case-insensitive key.
+ */
+const getHeader = (headers, name) => {
+    const headerName = getHeaderName(headers, name);
+    if (!headerName) {
+        return undefined;
+    }
+    return headers[headerName];
+};
+/**
+ * Determine if a given case-insensitive header exists within a header object.
+ */
+const hasHeader = (headers, name) => Boolean(getHeaderName(headers, name));
+
+export { getHeader, getHeaderName, hasHeader };

package/dist/httpsnippet-lite/dist/esm/helpers/shell.js

@@ -0,0 +1,16 @@
+/**
+ * Use 'strong quoting' using single quotes so that we only need to deal with nested single quote characters.
+ * see: http://wiki.bash-hackers.org/syntax/quoting#strong_quoting
+ */
+const quote = (value = '') => {
+    const safe = /^[a-z0-9-_/.@%^=:]+$/i;
+    const isShellSafe = safe.test(value);
+    if (isShellSafe) {
+        return value;
+    }
+    // if the value is not shell safe, then quote it
+    return `'${value.replace(/'/g, "'\\''")}'`;
+};
+const escape = (value) => value.replace(/\r/g, '\\r').replace(/\n/g, '\\n');
+
+export { escape, quote };