Added an interactive flag to request. (#160)

If present you get to choose what request you want to make from a dropdown list.
2020-11-20 18:47:55 -06:00 · 2020-11-20 18:47:55 -06:00 · d6c6c0c7e4
parent 44919334be
commit d6c6c0c7e4
3 changed files with 57 additions and 47 deletions
--- a/bin/cli/commands/request.js
+++ b/bin/cli/commands/request.js
@ -1,8 +1,9 @@
+const Base = require('../base')
+const cj = require('color-json')
 const clc = require('cli-color')
+const inquirer = require('inquirer')
 const { Line, Spinner } = require('clui')
 const { flags } = require('@oclif/command')
-const cj = require('color-json')
-const Base = require('../base')

 class RequestCommand extends Base {
    prettyOutput(res, verbose = false) {
@ -28,7 +29,12 @@ class RequestCommand extends Base {

        new Line().output()

-        this.log(cj((verbose ? res : body) || null))
+        const result = (verbose ? res : body) || null
+        if (typeof result === 'object') {
+            this.log(cj(result))
+        } else if (typeof result === 'string') {
+            this.log(result)
+        }
    }

    async run() {
@ -39,7 +45,8 @@ class RequestCommand extends Base {
                'no-format': noFormat = false,
                verbose = false,
                'as-json': asJson = false,
-                quiet = false
+                quiet = false,
+                interactive = false
            },
            args
        } = this.parse(RequestCommand)
@ -51,12 +58,36 @@ class RequestCommand extends Base {

        let spinnerEnabled = !noFormat && !asJson && !quiet

+        if (typeof args.alias == 'undefined' && !interactive) {
+            this.error(
+                'Missing 1 required argument: The alias of the request to execute.'
+            )
+        }
+
+        if (interactive) {
+            const requests = Beau.requests.list.map(
+                ({ VERB, ALIAS, ENDPOINT, PATH }) => ({
+                    name: `${VERB} ${PATH} - ${ALIAS}`,
+                    value: ALIAS,
+                    description: 'Hello World'
+                })
+            )
+
+            const { name } = await inquirer.prompt({
+                name: 'name',
+                message: 'Pick as Request to execute',
+                type: 'list',
+                choices: requests
+            })
+
+            args.alias = name
+        }
+
        if (spinnerEnabled) {
            this.spinner.start()
        }

        let res
-
        try {
            res = await Beau.requests.execByAlias(args.alias)
        } catch (err) {
@ -106,13 +137,19 @@ RequestCommand.flags = {
    'as-json': flags.boolean({
        char: 'j',
        description: `Outputs the response as json.`
+    }),
+
+    interactive: flags.boolean({
+        char: 'i',
+        description: 'Choose request interactively.',
+        default: false
    })
 }

 RequestCommand.args = [
    {
        name: 'alias',
-        required: true,
+        required: false,
        description: `The alias of the request to execute.`
    }
 ]
--- a/package-lock.json
+++ b/package-lock.json
@ -2372,8 +2372,7 @@
        "chardet": {
            "version": "0.7.0",
            "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz",
-            "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==",
-            "dev": true
+            "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA=="
        },
        "ci-info": {
            "version": "2.0.0",
@ -2459,7 +2458,6 @@
            "version": "3.1.0",
            "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz",
            "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==",
-            "dev": true,
            "requires": {
                "restore-cursor": "^3.1.0"
            }
@ -2477,8 +2475,7 @@
        "cli-width": {
            "version": "3.0.0",
            "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-3.0.0.tgz",
-            "integrity": "sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==",
-            "dev": true
+            "integrity": "sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw=="
        },
        "cliui": {
            "version": "6.0.0",
@ -3382,7 +3379,6 @@
            "version": "3.1.0",
            "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz",
            "integrity": "sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==",
-            "dev": true,
            "requires": {
                "chardet": "^0.7.0",
                "iconv-lite": "^0.4.24",
@ -3559,7 +3555,6 @@
            "version": "3.2.0",
            "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz",
            "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==",
-            "dev": true,
            "requires": {
                "escape-string-regexp": "^1.0.5"
            }
@ -4027,7 +4022,6 @@
            "version": "0.4.24",
            "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz",
            "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==",
-            "dev": true,
            "requires": {
                "safer-buffer": ">= 2.1.2 < 3"
            }
@ -4116,7 +4110,6 @@
            "version": "7.3.3",
            "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-7.3.3.tgz",
            "integrity": "sha512-JG3eIAj5V9CwcGvuOmoo6LB9kbAYT8HXffUl6memuszlwDC/qvFAJw49XJ5NROSFNPxp3iQg1GqkFhaY/CR0IA==",
-            "dev": true,
            "requires": {
                "ansi-escapes": "^4.2.1",
                "chalk": "^4.1.0",
@ -4137,7 +4130,6 @@
                    "version": "4.3.1",
                    "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.1.tgz",
                    "integrity": "sha512-JWF7ocqNrp8u9oqpgV+wH5ftbt+cfvv+PTjOvKLT3AdYly/LmORARfEVT1iyjwN+4MqE5UmVKoAdIBqeoCHgLA==",
-                    "dev": true,
                    "requires": {
                        "type-fest": "^0.11.0"
                    }
@ -4146,7 +4138,6 @@
                    "version": "4.3.0",
                    "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
                    "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
-                    "dev": true,
                    "requires": {
                        "color-convert": "^2.0.1"
                    }
@ -4155,7 +4146,6 @@
                    "version": "4.1.0",
                    "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz",
                    "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==",
-                    "dev": true,
                    "requires": {
                        "ansi-styles": "^4.1.0",
                        "supports-color": "^7.1.0"
@ -4165,7 +4155,6 @@
                    "version": "2.0.1",
                    "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
                    "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
-                    "dev": true,
                    "requires": {
                        "color-name": "~1.1.4"
                    }
@ -4173,32 +4162,27 @@
                "color-name": {
                    "version": "1.1.4",
                    "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
-                    "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
-                    "dev": true
+                    "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
                },
                "emoji-regex": {
                    "version": "8.0.0",
                    "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
-                    "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
-                    "dev": true
+                    "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
                },
                "has-flag": {
                    "version": "4.0.0",
                    "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
-                    "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
-                    "dev": true
+                    "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ=="
                },
                "is-fullwidth-code-point": {
                    "version": "3.0.0",
                    "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
-                    "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
-                    "dev": true
+                    "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg=="
                },
                "string-width": {
                    "version": "4.2.0",
                    "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.0.tgz",
                    "integrity": "sha512-zUz5JD+tgqtuDjMhwIg5uFVV3dtqZ9yQJlZVfq4I01/K5Paj5UHj7VyrQOJvzawSVlKpObApbfD0Ed6yJc+1eg==",
-                    "dev": true,
                    "requires": {
                        "emoji-regex": "^8.0.0",
                        "is-fullwidth-code-point": "^3.0.0",
@ -4209,7 +4193,6 @@
                    "version": "7.2.0",
                    "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
                    "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
-                    "dev": true,
                    "requires": {
                        "has-flag": "^4.0.0"
                    }
@ -7329,8 +7312,7 @@
        "mute-stream": {
            "version": "0.0.8",
            "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz",
-            "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==",
-            "dev": true
+            "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA=="
        },
        "nanomatch": {
            "version": "1.2.13",
@ -7986,7 +7968,6 @@
            "version": "5.1.2",
            "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz",
            "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==",
-            "dev": true,
            "requires": {
                "mimic-fn": "^2.1.0"
            },
@ -7994,8 +7975,7 @@
                "mimic-fn": {
                    "version": "2.1.0",
                    "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz",
-                    "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==",
-                    "dev": true
+                    "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg=="
                }
            }
        },
@ -8043,8 +8023,7 @@
        "os-tmpdir": {
            "version": "1.0.2",
            "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz",
-            "integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ=",
-            "dev": true
+            "integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ="
        },
        "ow": {
            "version": "0.18.0",
@ -8765,7 +8744,6 @@
            "version": "3.1.0",
            "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz",
            "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==",
-            "dev": true,
            "requires": {
                "onetime": "^5.1.0",
                "signal-exit": "^3.0.2"
@ -8800,8 +8778,7 @@
        "run-async": {
            "version": "2.4.1",
            "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.4.1.tgz",
-            "integrity": "sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==",
-            "dev": true
+            "integrity": "sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ=="
        },
        "run-parallel": {
            "version": "1.1.9",
@ -8812,7 +8789,6 @@
            "version": "6.6.3",
            "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-6.6.3.tgz",
            "integrity": "sha512-trsQc+xYYXZ3urjOiJOuCOa5N3jAZ3eiSpQB5hIT8zGlL2QfnHLJ2r7GMkBGuIausdJN1OneaI6gQlsqNHHmZQ==",
-            "dev": true,
            "requires": {
                "tslib": "^1.9.0"
            }
@ -9115,8 +9091,7 @@
        "signal-exit": {
            "version": "3.0.2",
            "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz",
-            "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=",
-            "dev": true
+            "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0="
        },
        "sisteransi": {
            "version": "1.0.5",
@ -9586,8 +9561,7 @@
        "through": {
            "version": "2.3.8",
            "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz",
-            "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=",
-            "dev": true
+            "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU="
        },
        "timers-ext": {
            "version": "0.1.7",
@ -9602,7 +9576,6 @@
            "version": "0.0.33",
            "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz",
            "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==",
-            "dev": true,
            "requires": {
                "os-tmpdir": "~1.0.2"
            }
@ -9738,8 +9711,7 @@
        "type-fest": {
            "version": "0.11.0",
            "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.11.0.tgz",
-            "integrity": "sha512-OdjXJxnCN1AvyLSzeKIgXTXxV+99ZuXl3Hpo9XpJAv9MBcHrrJOQ5kV7ypXOuQie+AmWG25hLbiKdwYTifzcfQ==",
-            "dev": true
+            "integrity": "sha512-OdjXJxnCN1AvyLSzeKIgXTXxV+99ZuXl3Hpo9XpJAv9MBcHrrJOQ5kV7ypXOuQie+AmWG25hLbiKdwYTifzcfQ=="
        },
        "typedarray-to-buffer": {
            "version": "3.1.5",
--- a/package.json
+++ b/package.json
@ -28,6 +28,7 @@
        "deepmerge": "4.2.2",
        "dotenv": "8.2.0",
        "globby": "11.0.1",
+        "inquirer": "7.3.3",
        "is-plain-object": "5.0.0",
        "js-yaml": "3.14.0",
        "request": "2.88.2",