custom-menu-cli 1.0.1 → 1.0.3

package/README-pt.md

@@ -19,12 +19,33 @@ 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.
+
+### Como Ferramenta CLI
+
 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]
 ```
 
+### Uso Programático
+
+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.
+
+```javascript
+import { runCli } from 'custom-menu-cli';
+
+async function iniciarMeuMenuCustomizado() {
+    console.log("Iniciando menu customizado...");
+    // Opcionalmente, passe o caminho para o seu arquivo menu.json
+    await runCli('./caminho/para/seu/menu.json');
+    console.log("Menu customizado finalizado.");
+}
+
+iniciarMeuMenuCustomizado();
+```
+
 ## Estrutura do JSON
 
 O arquivo JSON que define o menu tem a seguinte estrutura:

package/README.md

@@ -21,12 +21,33 @@ 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.
+
+### As a CLI Tool
+
 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]
 ```
 
+### Programmatic Usage
+
+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.
+
+```javascript
+import { runCli } from 'custom-menu-cli';
+
+async function startMyCustomMenu() {
+    console.log("Starting custom menu...");
+    // Optionally, pass the path to your menu.json file
+    await runCli('./path/to/your/menu.json');
+    console.log("Custom menu finished.");
+}
+
+startMyCustomMenu();
+```
+
 ## JSON Structure
 
 The JSON file that defines the menu has the following structure:

package/index.js

@@ -1,38 +1,24 @@
 #!/usr/bin/env node
-import chalk from 'chalk';
+
 import { loadMenuConfig } from './src/configLoader.js';
 import { showMenu, buildIdMap } from './src/menu.js';
+import { displayHeader } from './src/header.js';
+import { fileURLToPath } from 'url';
 
-(async () => {
-    const data = loadMenuConfig();
+export async function runCli(menuPath = null) {
+    const data = loadMenuConfig(menuPath);
     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;
+    displayHeader(data);
 
-    const topBorder = '╔' + '═'.repeat(boxWidth) + '╗';
-    const bottomBorder = '╚' + '═'.repeat(boxWidth) + '╝';
+    await showMenu(data);
+}
 
-    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);
-})();
+if (process.argv[1] === fileURLToPath(import.meta.url)) {
+    runCli();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "custom-menu-cli",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Menu interativo baseado em JSON para execução de comandos no terminal",
   "type": "module",
   "main": "index.js",

package/src/configLoader.js

@@ -15,21 +15,26 @@ const defaultMenu = {
     ]
 };
 
-export function loadMenuConfig() {
-    const args = process.argv.slice(2);
-    const path = args[0];
+export function loadMenuConfig(menuPath = null) {
     let data;
+    let finalPath = menuPath;
 
-    if (path && fs.existsSync(path)) {
+    // If menuPath is not provided, check command line arguments
+    if (!finalPath) {
+        const args = process.argv.slice(2);
+        finalPath = args[0];
+    }
+
+    if (finalPath && fs.existsSync(finalPath)) {
         try {
-            data = JSON.parse(fs.readFileSync(path, 'utf-8'));
+            data = JSON.parse(fs.readFileSync(finalPath, 'utf-8'));
         } catch (error) {
-            console.log(chalk.red(`Error parsing JSON file: ${path}`));
+            console.log(chalk.red(`Error parsing JSON file: ${finalPath}`));
             console.error(error);
             process.exit(1);
         }
-    } else if (path) {
-        console.log(chalk.red(`File not found: ${path}`));
+    } else if (finalPath) {
+        console.log(chalk.red(`File not found: ${finalPath}`));
         process.exit(1);
     } else if (fs.existsSync('./menu.json')) {
         try {

package/src/header.js

@@ -0,0 +1,25 @@
+import chalk from 'chalk';
+
+export function displayHeader(data) {
+    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('');
+    console.log(chalk.gray(`Developed by Mateus Medeiros - GitHub: @mateusmed`));
+    console.log('');
+}