custom-menu-cli 1.0.3 → 1.0.4

package/README-pt.md

@@ -1,5 +1,8 @@
 # Custom Menu CLI
 
+![Exemplo de Menu 1](./docs/example1.png)
+![Exemplo de Menu 2](./docs/example2.png)
+
 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
@@ -9,6 +12,12 @@ Esta é uma ferramenta de interface de linha de comando (CLI) que cria um menu i
 - Fácil de configurar e usar.
 - Suporte para execução de comandos com confirmação.
 
+
+## Lançamentos
+
+Você pode encontrar todas as versões lançadas e os executáveis standalone pré-compilados na página de [Releases do GitHub](https://github.com/mateusmed/custom-menu-cli/releases).
+
+
 ## Instalação
 
 Para instalar esta ferramenta globalmente, execute o seguinte comando:
@@ -19,22 +28,55 @@ npm install -g custom-menu-cli
 
 ## Uso
 
-Esta ferramenta pode ser utilizada de duas formas: como uma ferramenta de Linha de Comando (CLI) ou programaticamente, importando sua função principal.
+Existem três maneiras principais de utilizar esta ferramenta:
+
+### 1. Como Executável (Build de Release)
 
-### Como Ferramenta CLI
+Você pode gerar executáveis para Linux, macOS e Windows. Após o build, os arquivos estarão na pasta `dist/`.
 
-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.
+Primeiro, gere os arquivos com o comando:
+
+```bash
+npm run build
+```
+
+Depois, execute o arquivo correspondente ao seu sistema operacional, passando opcionalmente o caminho para um arquivo de menu. Se nenhum caminho for fornecido, ele procurará por um `menu.json` no diretório atual.
+
+```bash
+# No Linux/macOS
+./dist/custom-menu-linux [caminho/para/seu/menu.json]
+
+# No Windows
+.\dist\custom-menu-win.exe [caminho\para\seu\menu.json]
+```
+
+### 2. Globalmente via NPM
+
+Instale o pacote globalmente para usar o comando `custom-menu-cli` em qualquer lugar do seu sistema.
+
+```bash
+npm install -g custom-menu-cli
+```
+
+Depois de instalado, execute o comando:
 
 ```bash
 custom-menu-cli [caminho/para/seu/menu.json]
 ```
 
-### Uso Programático
+### 3. Programaticamente via `require`
+
+Você pode importar a função `runCli` em seus próprios projetos Node.js para integrar a funcionalidade do menu.
+
+Primeiro, adicione o pacote como uma dependência do seu projeto:
+```bash
+npm install custom-menu-cli
+```
 
-Você pode importar a função `runCli` do pacote e executá-la dentro de suas próprias aplicações Node.js. Isso permite integrar a funcionalidade do menu customizado em scripts ou sistemas maiores.
+Depois, use-o em seu código:
 
 ```javascript
-import { runCli } from 'custom-menu-cli';
+const { runCli } = require('custom-menu-cli');
 
 async function iniciarMeuMenuCustomizado() {
     console.log("Iniciando menu customizado...");

package/README.md

@@ -2,6 +2,9 @@
 
 [Português (Brasil)](./README-pt.md)
 
+![Menu Example 1](./docs/example1.png)
+![Menu Example 2](./docs/example2.png)
+
 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
@@ -11,6 +14,11 @@ This is a command-line interface (CLI) tool that creates an interactive menu bas
 - Easy to configure and use.
 - Support for command execution with confirmation.
 
+## Releases
+
+You can find all released versions and pre-compiled standalone executables on the [GitHub Releases page](https://github.com/mateusmed/custom-menu-cli/releases).
+
+
 ## Installation
 
 To install this tool globally, run the following command:
@@ -21,22 +29,55 @@ npm install -g custom-menu-cli
 
 ## Usage
 
-This tool can be used in two ways: as a Command-Line Interface (CLI) tool or programmatically by importing its main function.
+There are three main ways to use this tool:
+
+### 1. As an Executable (Release Build)
+
+You can generate executables for Linux, macOS, and Windows. After the build, the files will be in the `dist/` folder.
+
+First, generate the files with the command:
+
+```bash
+npm run build
+```
+
+Then, run the file corresponding to your operating system, optionally passing the path to a menu file. If no path is provided, it will look for a `menu.json` in the current directory.
+
+```bash
+# On Linux/macOS
+./dist/custom-menu-linux [path/to/your/menu.json]
+
+# On Windows
+.\dist\custom-menu-win.exe [path\to\your\menu.json]
+```
 
-### As a CLI Tool
+### 2. Globally via NPM
+
+Install the package globally to use the `custom-menu-cli` command anywhere on your system.
+
+```bash
+npm install -g custom-menu-cli
+```
 
-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.
+Once installed, run the command:
 
 ```bash
 custom-menu-cli [path/to/your/menu.json]
 ```
 
-### Programmatic Usage
+### 3. Programmatically via `require`
+
+You can import the `runCli` function into your own Node.js projects to integrate the menu functionality.
+
+First, add the package as a dependency to your project:
+```bash
+npm install custom-menu-cli
+```
 
-You can import the `runCli` function from the package and execute it within your own Node.js applications. This allows you to integrate the custom menu functionality into larger scripts or systems.
+Then, use it in your code:
 
 ```javascript
-import { runCli } from 'custom-menu-cli';
+const { runCli } = require('custom-menu-cli');
 
 async function startMyCustomMenu() {
     console.log("Starting custom menu...");

package/index.js

@@ -1,11 +1,10 @@
 #!/usr/bin/env node
 
-import { loadMenuConfig } from './src/configLoader.js';
-import { showMenu, buildIdMap } from './src/menu.js';
-import { displayHeader } from './src/header.js';
-import { fileURLToPath } from 'url';
+const { loadMenuConfig } = require('./src/configLoader.js');
+const { showMenu, buildIdMap } = require('./src/menu.js');
+const { displayHeader } = require('./src/header.js');
 
-export async function runCli(menuPath = null) {
+async function runCli(menuPath = null) {
     const data = loadMenuConfig(menuPath);
     if (data.options) {
         buildIdMap(data.options);
@@ -18,7 +17,8 @@ export async function runCli(menuPath = null) {
     await showMenu(data);
 }
 
-
-if (process.argv[1] === fileURLToPath(import.meta.url)) {
+if (require.main === module) {
     runCli();
 }
+
+module.exports = { runCli };

package/package.json

@@ -1,21 +1,22 @@
 {
   "name": "custom-menu-cli",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Menu interativo baseado em JSON para execução de comandos no terminal",
-  "type": "module",
   "main": "index.js",
-  "bin": {
-    "custom-menu-cli": "index.js"
-  },
+  "bin": "index.js",
   "scripts": {
-    "start": "node index.js"
+    "start": "node index.js",
+    "build": "pkg . --targets node16-linux-x64,node16-win-x64,node16-macos-x64 --output dist/custom-menu-v$npm_package_version"
   },
-  "keywords": ["cli", "menu", "json", "terminal", "deploy"],
+  "keywords": ["cli", "menu", "json", "terminal", "deploy", "custom"],
   "author": "Mateus Medeiros <https://github.com/mateusmed>",
   "license": "MIT",
   "dependencies": {
-    "chalk": "^5.3.0",
+    "chalk": "^4.1.2",
     "dotenv": "^16.3.1",
-    "inquirer": "^9.2.16"
+    "inquirer": "^8.2.4"
+  },
+  "devDependencies": {
+    "pkg": "^5.8.1"
   }
 }

package/src/actions.js

@@ -1,20 +1,20 @@
-import inquirer from 'inquirer';
-import chalk from 'chalk';
-import {terminal} from './terminal.js';
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const {terminal} = require('./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) {
+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) {
+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) {
@@ -27,6 +27,8 @@ export async function handleCustomAction(selected, flatMap) {
     }
 }
 
-export async function handleNavigation(selected) {
+async function handleNavigation(selected) {
     return selected;
-}
+}
+
+module.exports = { handleAction, handleCustomAction, handleNavigation };

package/src/configLoader.js

@@ -1,5 +1,5 @@
-import fs from 'fs';
-import chalk from 'chalk';
+const fs = require('fs');
+const chalk = require('chalk');
 
 const defaultMenu = {
     "name": "Example Menu",
@@ -15,7 +15,7 @@ const defaultMenu = {
     ]
 };
 
-export function loadMenuConfig(menuPath = null) {
+function loadMenuConfig(menuPath = null) {
     let data;
     let finalPath = menuPath;
 
@@ -51,3 +51,5 @@ export function loadMenuConfig(menuPath = null) {
 
     return data;
 }
+
+module.exports = { loadMenuConfig };

package/src/header.js

@@ -1,6 +1,6 @@
-import chalk from 'chalk';
+const chalk = require('chalk');
 
-export function displayHeader(data) {
+function displayHeader(data) {
     const name = data.name || 'Custom Menu';
     const description = data.description || 'A CLI Menu';
     const lines = [name, description];
@@ -23,3 +23,5 @@ export function displayHeader(data) {
     console.log(chalk.gray(`Developed by Mateus Medeiros - GitHub: @mateusmed`));
     console.log('');
 }
+
+module.exports = { displayHeader };

package/src/menu.js

@@ -1,17 +1,17 @@
-import inquirer from 'inquirer';
-import chalk from 'chalk';
-import { handleAction, handleCustomAction, handleNavigation } from './actions.js';
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const { handleAction, handleCustomAction, handleNavigation } = require('./actions.js');
 
-export const flatMap = {};
+const flatMap = {};
 
-export function buildIdMap(options) {
+function buildIdMap(options) {
     for (const opt of options) {
         flatMap[opt.id] = opt;
         if (opt.options) buildIdMap(opt.options);
     }
 }
 
-export async function showMenu(menu) {
+async function showMenu(menu) {
     while (true) {
         const choices = menu.options.map(o => `[${o.id}] ${o.name}`).concat([' Back']);
         const { choice } = await inquirer.prompt({
@@ -41,3 +41,5 @@ export async function showMenu(menu) {
         }
     }
 }
+
+module.exports = { flatMap, buildIdMap, showMenu };

package/src/terminal.js

@@ -1,16 +1,12 @@
-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);
+const { join } = require('path');
+const { config } = require('dotenv');
+const { access } = require('fs/promises');
+const { execSync } = require('child_process');
+const chalk = require('chalk');
 
 config({ path: join(__dirname, '../.env') });
 
-export const terminal = {
+const terminal = {
 
     async directoryExists(path) {
         try {
@@ -53,3 +49,5 @@ export const terminal = {
     }
 
 }
+
+module.exports = { terminal };