@tertium/hlpr 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Vitalii Balabanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# hlpr
+
+A CLI utility for running shell scripts with variable substitution.
+
+## Installation
+
+```bash
+# Install globally
+npm install -g @tertium/hlpr
+
+# Or with yarn
+yarn global add @tertium/hlpr
+
+# Or locally in your project
+npm install @tertium/hlpr
+```
+
+## Usage
+
+```bash
+# Basic usage
+hlpr <category> <command>
+
+# Examples
+hlpr git fodd
+hlpr hello world
+hlpr ssh init dir
+
+# Continue execution even if commands fail
+hlpr -f ssh init dir
+```
+
+## How It Works
+
+1. The command `hlpr hello world` looks for a script at `commands/hello/world.sh`
+2. If the script contains variables like `{{name}}`, you'll be prompted to enter values
+3. Each line of the script is executed with the variables replaced
+
+## Directory Structure
+
+```
+commands/
+├── git/
+│   └── fodd.sh
+├── hello/
+│   └── world.sh
+├── nvm/
+│   ├── install.sh
+│   └── lts.sh
+└── ssh/
+    └── initdir.sh
+```
+
+## Adding Your Own Scripts
+
+1. Create a directory structure in `commands/<category>/`
+2. Add your `.sh` script files
+3. Use `{{variable}}` syntax for user inputs
+
+Example script (`commands/hello/world.sh`):
+```bash
+echo "Hello World, {{name}}"
+```
+
+## Command Naming
+
+The utility maps command arguments to script files:
+- `hlpr git fodd` → runs `commands/git/fodd.sh`
+- `hlpr hello world` → runs `commands/hello/world.sh`
+- `hlpr ssh init dir` → runs `commands/ssh/initdir.sh`
+
+## Error Handling
+
+By default, the utility stops execution if any command fails. Use the `-f` flag to continue execution despite failures:
+
+```bash
+# Stop on first failure (default)
+hlpr ssh init dir
+
+# Continue despite failures
+hlpr -f ssh init dir
+```
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/tertiumnon/hlpr.git
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Link for local development
+npm link
+```
+
+## License
+
+MIT

package/bin/hlpr.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../dist/hlpr.js');

package/commands/git/fodd.sh

@@ -0,0 +1 @@
+git fetch origin develop:develop

package/commands/hello/world.sh

@@ -0,0 +1 @@
+echo "Hello World, {{name}}"

package/commands/nvm/install.sh

@@ -0,0 +1 @@
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

package/commands/nvm/lts.sh

@@ -0,0 +1,2 @@
+nvm install --lts
+nvm use --lts

package/commands/ssh/init-dir.sh

@@ -0,0 +1,6 @@
+mkdir ~/.ssh
+touch ~/.ssh/known_hosts
+touch ~/.ssh/config
+chmod 700 ~/.ssh
+chmod 644 ~/.ssh/known_hosts
+chmod 644 ~/.ssh/config

package/dist/hlpr.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hlpr.js

@@ -0,0 +1,153 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = require("node:fs/promises");
+const node_child_process_1 = require("node:child_process");
+const path = __importStar(require("node:path"));
+const fs = __importStar(require("node:fs"));
+const readline = __importStar(require("node:readline"));
+// Parse command line arguments
+const args = process.argv.slice(2);
+let forceFlag = false;
+let commandArgs = [];
+// Check for -f flag
+if (args[0] === "-f") {
+    forceFlag = true;
+    commandArgs = args.slice(1);
+}
+else {
+    commandArgs = args;
+}
+// Create readline interface for user input
+const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+});
+// Prompt for user input
+function prompt(question) {
+    return new Promise((resolve) => {
+        rl.question(question, (answer) => {
+            resolve(answer);
+        });
+    });
+}
+// Execute a command with variable substitution
+async function executeCommand(command, variables) {
+    // Replace variables in the command
+    let processedCommand = command;
+    for (const [key, value] of Object.entries(variables)) {
+        processedCommand = processedCommand.replace(new RegExp(`{{${key}}}`, 'g'), value);
+    }
+    return new Promise((resolve) => {
+        console.log(`Executing: ${processedCommand}`);
+        const childProcess = (0, node_child_process_1.exec)(processedCommand);
+        if (childProcess.stdout) {
+            childProcess.stdout.on("data", (data) => {
+                console.log(data.toString().trim());
+            });
+        }
+        if (childProcess.stderr) {
+            childProcess.stderr.on("data", (data) => {
+                console.error(data.toString().trim());
+            });
+        }
+        childProcess.on("exit", (code) => {
+            if (code === 0) {
+                resolve(true);
+            }
+            else {
+                console.error(`Command failed with exit code ${code}`);
+                resolve(false);
+            }
+        });
+    });
+}
+async function main() {
+    if (commandArgs.length === 0) {
+        console.error("Please provide a command. Example: hlpr ssh init-dir");
+        process.exit(1);
+    }
+    try {
+        // Get the category (first argument) and the rest of the command
+        const category = commandArgs[0];
+        const restArgs = commandArgs.slice(1);
+        // Join the rest of the arguments without hyphens
+        const scriptName = restArgs.join("");
+        const scriptPath = path.join(process.cwd(), "commands", category, `${scriptName}.sh`);
+        // Check if the script exists
+        if (!fs.existsSync(scriptPath)) {
+            console.error(`Script not found: ${scriptPath}`);
+            process.exit(1);
+        }
+        // Read the script content
+        const scriptContent = await (0, promises_1.readFile)(scriptPath, "utf-8");
+        const lines = scriptContent.split("\n");
+        // Extract variables from the script (anything in {{variable}})
+        const variableRegex = /{{([^}]+)}}/g;
+        const variables = {};
+        const uniqueVars = new Set();
+        lines.forEach(line => {
+            let match;
+            while ((match = variableRegex.exec(line)) !== null) {
+                uniqueVars.add(match[1]);
+            }
+        });
+        // Prompt for each variable
+        for (const varName of uniqueVars) {
+            const value = await prompt(`Enter ${varName}: `);
+            variables[varName] = value;
+        }
+        // Execute each line of the script
+        for (const line of lines) {
+            if (!line.trim())
+                continue;
+            const success = await executeCommand(line, variables);
+            // If command failed and force flag is not set, exit
+            if (!success && !forceFlag) {
+                console.error("Command failed, stopping execution.");
+                process.exit(1);
+            }
+        }
+        console.log("Command completed successfully!");
+    }
+    catch (error) {
+        console.error("Error:", error);
+        process.exit(1);
+    }
+    finally {
+        rl.close();
+    }
+}
+main();

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@tertium/hlpr",
+  "version": "0.1.2",
+  "description": "Windows and *Nix utility for typical programming activity",
+  "author": "Vitalii Balabanov",
+  "email": "tertiumnon@gmail.com",
+  "main": "dist/hlpr.js",
+  "type": "commonjs",
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "prepublishOnly": "npm run build",
+    "release:minor": "node_modules/@tertium/shared-js-configs-and-types/scripts/release.js --minor",
+    "release:patch": "node_modules/@tertium/shared-js-configs-and-types/scripts/release.js --patch",
+    "release:major": "node_modules/@tertium/shared-js-configs-and-types/scripts/release.js --major"
+  },
+  "devDependencies": {
+    "@tertium/shared-js-configs-and-types": "^0.14.0",
+    "@types/node": "^22.13.10",
+    "typescript": "^5.8.3"
+  },
+  "bin": {
+    "hlpr": "./bin/hlpr.js"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "commands"
+  ],
+  "keywords": [
+    "cli",
+    "utility",
+    "shell",
+    "scripts"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tertiumnon/hlpr.git"
+  },
+  "license": "MIT"
+}