custom-menu-cli 1.0.0

package/README-en.md

@@ -0,0 +1,89 @@
+# Custom Menu CLI
+
+This is a command-line interface (CLI) tool that creates an interactive menu based on a JSON file. It's designed to simplify the execution of frequent commands in a terminal.
+
+## Features
+
+- Interactive menu in the terminal.
+- Menu structure defined by a JSON file.
+- Easy to configure and use.
+- Support for command execution with confirmation.
+
+## Installation
+
+To install this tool globally, run the following command:
+
+```bash
+npm install -g custom-menu-cli
+```
+
+## Usage
+
+To use the CLI, you can run the `custom-menu-cli` command, optionally passing the path to a JSON file. If no path is provided, it will look for a `menu.json` file in the current directory.
+
+```bash
+custom-menu-cli [path/to/your/menu.json]
+```
+
+## JSON Structure
+
+The JSON file that defines the menu has the following structure:
+
+```json
+{
+  "name": "Deploy Menu",
+  "description": "Menu de navegação para deploys",
+  "options": [
+    {
+      "id": "1",
+      "name": "Projeto A",
+      "type": "navigation",
+      "options": [
+        {
+          "id": "1.1",
+          "name": "Down Service",
+          "type": "action",
+          "command": "echo 'Down A'",
+          "confirm": true
+        },
+        {
+          "id": "1.2",
+          "name": "Up Service",
+          "type": "action",
+          "command": "echo 'Up A'"
+        }
+      ]
+    },
+    {
+      "id": "2",
+      "name": "Restart All",
+      "type": "custom-action",
+      "idList": ["1.1", "1.2"],
+      "confirm": true
+    }
+  ]
+}
+```
+
+### Fields
+
+- `name`: The name of the menu.
+- `description`: A brief description of the menu.
+- `options`: An array of menu options.
+  - `id`: A unique identifier for the option.
+  - `name`: The text that will be displayed for the option.
+  - `type`: The type of option. It can be `action` (executes a command), `navigation` (opens a submenu) or `custom-action` (executes a list of commands from other actions).
+  - `command`: The command to be executed (if the type is `action`).
+  - `idList`: A list of ids from other actions to be executed (if the type is `custom-action`).
+  - `confirm`: A boolean that indicates whether a confirmation should be requested before executing the command.
+  - `options`: An array of sub-options (if the type is `navigation`).
+
+## License
+
+This project is licensed under the MIT License.
+
+## Author
+
+- **Mateus Medeiros**
+  - GitHub: [@mateusmed](https://github.com/mateusmed)
+  - LinkedIn: [Mateus Medeiros](https://www.linkedin.com/in/mateus-med/)

package/README-pt.md

@@ -0,0 +1,89 @@
+# Custom Menu CLI
+
+Esta é uma ferramenta de interface de linha de comando (CLI) que cria um menu interativo com base em um arquivo JSON. Ele foi projetado para simplificar a execução de comandos frequentes em um terminal.
+
+## Funcionalidades
+
+- Menu interativo no terminal.
+- Estrutura do menu definida por um arquivo JSON.
+- Fácil de configurar e usar.
+- Suporte para execução de comandos com confirmação.
+
+## Instalação
+
+Para instalar esta ferramenta globalmente, execute o seguinte comando:
+
+```bash
+npm install -g custom-menu-cli
+```
+
+## Uso
+
+Para usar o CLI, você pode executar o comando `custom-menu-cli`, passando opcionalmente o caminho para um arquivo JSON. Se nenhum caminho for fornecido, ele procurará um arquivo `menu.json` no diretório atual.
+
+```bash
+custom-menu-cli [caminho/para/seu/menu.json]
+```
+
+## Estrutura do JSON
+
+O arquivo JSON que define o menu tem a seguinte estrutura:
+
+```json
+{
+  "name": "Deploy Menu",
+  "description": "Menu de navegação para deploys",
+  "options": [
+    {
+      "id": "1",
+      "name": "Projeto A",
+      "type": "navigation",
+      "options": [
+        {
+          "id": "1.1",
+          "name": "Down Service",
+          "type": "action",
+          "command": "echo 'Down A'",
+          "confirm": true
+        },
+        {
+          "id": "1.2",
+          "name": "Up Service",
+          "type": "action",
+          "command": "echo 'Up A'"
+        }
+      ]
+    },
+    {
+      "id": "2",
+      "name": "Restart All",
+      "type": "custom-action",
+      "idList": ["1.1", "1.2"],
+      "confirm": true
+    }
+  ]
+}
+```
+
+### Campos
+
+- `name`: O nome do menu.
+- `description`: Uma breve descrição do menu.
+- `options`: Um array de opções do menu.
+  - `id`: Um identificador único para a opção.
+  - `name`: O texto que será exibido para a opção.
+  - `type`: O tipo de opção. Pode ser `action` (executa um comando), `navigation` (abre um submenu) ou `custom-action` (executa uma lista de comandos de outras ações).
+  - `command`: O comando a ser executado (se o tipo for `action`).
+  - `idList`: Uma lista de ids de outras ações a serem executados (se o tipo for `custom-action`).
+  - `confirm`: Um booleano que indica se uma confirmação deve ser solicitada antes de executar o comando.
+  - `options`: Um array de sub-opções (se o tipo for `navigation`).
+
+## Licença
+
+Este projeto está licenciado sob a Licença MIT.
+
+## Autor
+
+- **Mateus Medeiros**
+  - GitHub: [@mateusmed](https://github.com/mateusmed)
+  - LinkedIn: [Mateus Medeiros](https://www.linkedin.com/in/mateus-med/)

package/README.md

@@ -0,0 +1,3 @@
+# Custom Menu CLI
+
+[English](./README-en.md) | [Português (Brasil)](./README-pt.md)

package/index.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+import chalk from 'chalk';
+import { loadMenuConfig } from './src/configLoader.js';
+import { showMenu, buildIdMap } from './src/menu.js';
+
+(async () => {
+    const data = loadMenuConfig();
+    if (data.options) {
+        buildIdMap(data.options);
+    }
+
+    console.clear();
+
+    // Dynamic Header
+    const name = data.name || 'Custom Menu';
+    const description = data.description || 'A CLI Menu';
+    const lines = [name, description];
+    const maxLength = Math.max(...lines.map(line => line.length));
+    const boxWidth = maxLength + 4;
+
+    const topBorder = '╔' + '═'.repeat(boxWidth) + '╗';
+    const bottomBorder = '╚' + '═'.repeat(boxWidth) + '╝';
+
+    console.log(chalk.bold.blueBright(topBorder));
+    lines.forEach(line => {
+        const paddingTotal = boxWidth - line.length;
+        const paddingLeft = Math.floor(paddingTotal / 2);
+        const paddingRight = Math.ceil(paddingTotal / 2);
+        const paddedLine = `║${' '.repeat(paddingLeft)}${line}${' '.repeat(paddingRight)}║`;
+        console.log(chalk.bold.blueBright(paddedLine));
+    });
+    console.log(chalk.bold.blueBright(bottomBorder));
+    console.log(''); // For spacing
+    console.log(chalk.gray(`Developed by Mateus Medeiros - GitHub: @mateusmed`));
+    console.log(''); // For spacing
+
+    await showMenu(data);
+})();

package/menu.json

@@ -0,0 +1,33 @@
+{
+  "name": "custom-menu-cli",
+  "description": "JSON-based terminal menu",
+  "options": [
+    {
+      "id": "1",
+      "name": "Projeto A",
+      "type": "navigation",
+      "options": [
+        {
+          "id": "1.1",
+          "name": "Down Service",
+          "type": "action",
+          "command": "echo 'Down A'",
+          "confirm": true
+        },
+        {
+          "id": "1.2",
+          "name": "Up Service",
+          "type": "action",
+          "command": "echo 'Up A'"
+        }
+      ]
+    },
+    {
+      "id": "2",
+      "name": "Restart All",
+      "type": "custom-action",
+      "idList": ["1.1", "1.2"],
+      "confirm": true
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "custom-menu-cli",
+  "version": "1.0.0",
+  "description": "Menu interativo baseado em JSON para execução de comandos no terminal",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "custom-menu-cli": "index.js"
+  },
+  "scripts": {
+    "start": "node index.js"
+  },
+  "keywords": ["cli", "menu", "json", "terminal", "deploy"],
+  "author": "Mateus Medeiros <https://github.com/mateusmed>",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "dotenv": "^16.3.1",
+    "inquirer": "^9.2.16"
+  }
+}

package/src/actions.js

@@ -0,0 +1,32 @@
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+import {terminal} from './terminal.js';
+
+async function confirmExecution(message) {
+    const {ok} = await inquirer.prompt({type: 'confirm', name: 'ok', message, default: false});
+    return ok;
+}
+
+export async function handleAction(selected) {
+    const proceed = selected.confirm ? await confirmExecution(chalk.yellow(`Executing command: [id: ${selected.id} name: ${selected.name} ]`)) : true;
+    if (proceed) {
+        await terminal.execCommandSync(selected.command);
+    }
+}
+
+export async function handleCustomAction(selected, flatMap) {
+    const proceed = selected.confirm ? await confirmExecution(chalk.yellow(`Execute command list ${selected.idList.join(', ')}?`)) : true;
+    if (proceed) {
+        for (const id of selected.idList) {
+            const cmd = flatMap[id];
+            if (cmd?.command) {
+                console.log(chalk.blue(`Executing command: [id: ${cmd.id} name: ${cmd.name} ]`));
+                await terminal.execCommandSync(cmd.command);
+            }
+        }
+    }
+}
+
+export async function handleNavigation(selected) {
+    return selected;
+}

package/src/configLoader.js

@@ -0,0 +1,48 @@
+import fs from 'fs';
+import chalk from 'chalk';
+
+const defaultMenu = {
+    "name": "Example Menu",
+    "description": "This is a default example menu. Create a 'menu.json' to customize.",
+    "options": [
+        {
+            "id": "hello",
+            "name": "Say Hello",
+            "type": "action",
+            "command": "echo 'Hello, World!'",
+            "confirm": false
+        }
+    ]
+};
+
+export function loadMenuConfig() {
+    const args = process.argv.slice(2);
+    const path = args[0];
+    let data;
+
+    if (path && fs.existsSync(path)) {
+        try {
+            data = JSON.parse(fs.readFileSync(path, 'utf-8'));
+        } catch (error) {
+            console.log(chalk.red(`Error parsing JSON file: ${path}`));
+            console.error(error);
+            process.exit(1);
+        }
+    } else if (path) {
+        console.log(chalk.red(`File not found: ${path}`));
+        process.exit(1);
+    } else if (fs.existsSync('./menu.json')) {
+        try {
+            data = JSON.parse(fs.readFileSync('./menu.json', 'utf-8'));
+        } catch (error) {
+            console.log(chalk.red(`Error parsing JSON file: ./menu.json`));
+            console.error(error);
+            process.exit(1);
+        }
+    } else {
+        console.log(chalk.yellow("No 'menu.json' found. Loading example menu."));
+        data = defaultMenu;
+    }
+
+    return data;
+}

package/src/menu.js

@@ -0,0 +1,43 @@
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+import { handleAction, handleCustomAction, handleNavigation } from './actions.js';
+
+export const flatMap = {};
+
+export function buildIdMap(options) {
+    for (const opt of options) {
+        flatMap[opt.id] = opt;
+        if (opt.options) buildIdMap(opt.options);
+    }
+}
+
+export async function showMenu(menu) {
+    while (true) {
+        const choices = menu.options.map(o => `[${o.id}] ${o.name}`).concat([' Back']);
+        const { choice } = await inquirer.prompt({
+            type: 'list',
+            name: 'choice',
+            message: chalk.cyan(menu.name),
+            choices
+        });
+
+        if (choice === ' Back') return;
+
+        const selected = menu.options.find(o => `[${o.id}] ${o.name}` === choice);
+        if (!selected) continue;
+
+        switch (selected.type) {
+            case 'action':
+                await handleAction(selected);
+                break;
+            case 'custom-action':
+                await handleCustomAction(selected, flatMap);
+                break;
+            case 'navigation':
+                await showMenu(selected);
+                break;
+            default:
+                console.log(chalk.red(`Unknown action type: ${selected.type}`));
+        }
+    }
+}

package/src/terminal.js

@@ -0,0 +1,55 @@
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import { config } from 'dotenv';
+import { access } from 'fs/promises';
+import { execSync } from 'child_process';
+import chalk from 'chalk';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+config({ path: join(__dirname, '../.env') });
+
+export const terminal = {
+
+    async directoryExists(path) {
+        try {
+            await access(path);
+            return true;
+        } catch (error) {
+            console.log(chalk.red(`❌ Diretório não encontrado: ${path}`));
+            return false;
+        }
+    },
+
+    async execCommandSync(command) {
+        try {
+            console.log(chalk.yellow(`\n Execute command:\n\t${chalk.bgBlackBright.red(command)}\n`));
+            const output = execSync(command, { encoding: 'utf8' });
+            console.log(chalk.green(`✅ Command executed with success.\n`));
+            if (output.trim()) {
+                console.log('--------[output command]-------');
+                console.log(chalk.greenBright(output));
+                console.log('-------------------------------');
+            }
+            return output;
+        } catch (error) {
+            console.error('-------------------');
+            console.error(chalk.red(`Error on execute command:`));
+            console.error(chalk.red(error.message));
+            return `Error: ${error.message}`;
+        }
+    },
+
+    async execList(list) {
+        let output = '';
+        console.log(chalk.cyan(`\n Running list of command: (${list.length}):\n`));
+        for (let command of list) {
+            console.log(chalk.blue(`→ ${command}`));
+            const result = await this.execCommandSync(command);
+            output += result + '\n';
+        }
+        return output;
+    }
+
+}