@tertium/hlpr 0.5.5 → 0.5.6

package/README.md

@@ -45,24 +45,13 @@ hlpr -f ssh init dir
 
 ## Available Commands
 
-### Shell Script Commands
-
-Shell scripts support variable substitution using `{{variable}}` syntax.
-
-- `git fodd` - Git command
-- `hello world` - Hello world example
-- `ssh init dir` - SSH initialization
-
 ### TypeScript Commands
 
-TypeScript commands are implemented as `.ts` files and run directly with Bun.
-
 #### file rename
 
 Recursively rename files and folders according to a specific case style.
 
 **Supported styles:**
-
 - `title_underscore` - Title_Case_With_Underscores
 - `snake` - snake_case_lowercase
 - `kebab` - kebab-case-lowercase
@@ -71,8 +60,7 @@ Recursively rename files and folders according to a specific case style.
 - `upper` - UPPER_CASE_WITH_UNDERSCORES
 - `lower` - lower_case_with_underscores
 
-**Examples:**
-
+**Usage:**
 ```bash
 # Dry run (preview changes without applying)
 hlpr file rename ./my-project kebab --dry
@@ -84,15 +72,99 @@ hlpr file rename ./docs pascal
 ```
 
 **Features:**
-
 - ✅ Recursive directory traversal
-- ✅ Extension preservation (e.g., `file-name.md` core name only)
+- ✅ Extension preservation
 - ✅ Leading dot file support (e.g., `.gitignore`)
 - ✅ Case-only rename handling (Windows compatibility)
 - ✅ Conflict resolution (adds `_N` suffix)
 - ✅ Dry-run mode (`--dry` or `-n`)
 
-See `commands/file/rename/README.md` for detailed documentation.
+**See:** [`src/commands/file/rename/README.md`](src/commands/file/rename/README.md) for full documentation.
+
+---
+
+#### help
+
+Display help information about hlpr commands.
+
+**Usage:**
+```bash
+hlpr help
+```
+
+---
+
+### Shell Script Commands
+
+Shell scripts support variable substitution using `{{variable}}` syntax.
+
+#### git
+
+Helpful git utilities for common development workflows.
+
+**Usage:**
+```bash
+hlpr git <command>
+```
+
+**Commands:**
+- `fodd` - Fetch and update develop branch from origin
+- `precommit` - Run build and stage binaries before commit
+- `switch-clean` - Safely switch to a branch and delete the previous one (local & remote)
+
+**See:** [`src/commands/git/README.md`](src/commands/git/README.md) for full documentation.
+
+---
+
+#### hello
+
+Example/demo commands for testing the hlpr CLI tool.
+
+**Usage:**
+```bash
+hlpr hello world
+```
+
+Prompts for input and prints a personalized greeting with variable substitution.
+
+**See:** [`src/commands/hello/README.md`](src/commands/hello/README.md) for full documentation.
+
+---
+
+#### nvm
+
+Node Version Manager utilities for managing Node.js versions.
+
+**Usage:**
+```bash
+hlpr nvm <command>
+```
+
+**Commands:**
+- `install` - Install Node Version Manager (nvm)
+- `lts` - Install and use Node.js LTS version
+
+**See:** [`src/commands/nvm/README.md`](src/commands/nvm/README.md) for full documentation.
+
+---
+
+#### ssh
+
+SSH configuration and setup utilities.
+
+**Usage:**
+```bash
+hlpr ssh init-dir
+```
+
+Initializes SSH directory with proper permissions:
+- `~/.ssh/` directory with 700 permissions
+- `~/.ssh/known_hosts` with 644 permissions
+- `~/.ssh/config` with 644 permissions
+
+Portable across Unix/Linux/macOS and Git Bash on Windows.
+
+**See:** [`src/commands/ssh/README.md`](src/commands/ssh/README.md) for full documentation.
 
 ## How It Works
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tertium/hlpr",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "description": "Windows and *Nix utility for typical programming activity",
   "author": "Vitalii Balabanov",
   "email": "tertiumnon@gmail.com",
@@ -8,18 +8,20 @@
   "type": "module",
   "scripts": {
     "build:main": "bun build ./src/index.ts --outfile ./bin/index.js --target node",
-    "build:commands": "node build-commands.js",
+    "build:commands": "bun build-commands.js",
     "build": "bun run build:main && bun run build:commands",
     "test": "bun test",
-    "test:e2e": "node scripts/test-rename-e2e.cjs",
+    "test:e2e": "bun scripts/test-rename-e2e.cjs",
     "prepublishOnly": "bun run build",
-    "release:minor": "node node_modules/@tertium/js/scripts/release.js minor",
-    "release:patch": "node node_modules/@tertium/js/scripts/release.js patch",
-    "release:major": "node node_modules/@tertium/js/scripts/release.js major",
+    "release:minor": "bun node_modules/@tertium/js/scripts/release.js minor",
+    "release:patch": "bun node_modules/@tertium/js/scripts/release.js patch",
+    "release:major": "bun node_modules/@tertium/js/scripts/release.js major",
     "prepare": "husky"
   },
+  "dependencies": {
+    "@tertium/js": "^1.4.6"
+  },
   "devDependencies": {
-    "@tertium/js": "^0.16.0",
     "@types/node": "^22.13.10",
     "husky": "^9.1.7",
     "typescript": "^5.8.3"

package/bin/commands/deploy/deploy/deploy.sh

@@ -1,41 +0,0 @@
-#!/bin/bash
-# @description Deploy application to remote server with environment variables
-
-SKIP_BUILD="{{SKIP_BUILD}}"
-DEPLOY_USER="{{DEPLOY_USER}}"
-DEPLOY_HOST="{{DEPLOY_HOST}}"
-DEPLOY_PATH="{{DEPLOY_PATH}}"
-APP_NAME="{{APP_NAME}}"
-
-echo "Deploying to $DEPLOY_HOST:$DEPLOY_PATH"
-echo "=========================================="
-
-# Build phase (unless skip-build is set)
-if [ "$SKIP_BUILD" != "true" ]; then
-  echo "Building..."
-  bun run build
-  if [ $? -ne 0 ]; then
-    echo "✗ Build failed"
-    exit 1
-  fi
-fi
-
-# Deploy phase
-echo ""
-echo "Copying files to remote server..."
-scp -r dist/ $DEPLOY_USER@$DEPLOY_HOST:$DEPLOY_PATH/
-if [ $? -ne 0 ]; then
-  echo "✗ SCP failed"
-  exit 1
-fi
-
-echo ""
-echo "Installing dependencies and restarting service..."
-ssh $DEPLOY_USER@$DEPLOY_HOST "cd $DEPLOY_PATH && bun install --production && pm2 restart $APP_NAME --update-env"
-if [ $? -ne 0 ]; then
-  echo "✗ Remote deployment failed"
-  exit 1
-fi
-
-echo ""
-echo "✓ Deployment complete!"

package/bin/commands/deploy/deploy.js

@@ -1,68 +0,0 @@
-#!/usr/bin/env node
-
-// src/commands/deploy/deploy.ts
-import { execSync } from "child_process";
-import { existsSync, readFileSync } from "fs";
-import * as path from "path";
-function loadEnv(projectDir) {
-  const envPath = path.join(projectDir, ".env");
-  if (!existsSync(envPath)) {
-    console.error("Error: .env file not found");
-    console.error(`Please copy .env.example to .env in ${projectDir}`);
-    process.exit(1);
-  }
-  const env = {};
-  const content = readFileSync(envPath, "utf-8");
-  content.split(`
-`).forEach((line) => {
-    const trimmed = line.trim();
-    if (!trimmed || trimmed.startsWith("#"))
-      return;
-    const [key, ...valueParts] = trimmed.split("=");
-    if (key && valueParts.length > 0) {
-      env[key.trim()] = valueParts.join("=").trim();
-    }
-  });
-  return env;
-}
-function validate(env) {
-  const required = ["DEPLOY_USER", "DEPLOY_HOST", "DEPLOY_PATH", "APP_NAME"];
-  const missing = required.filter((key) => !env[key]);
-  if (missing.length > 0) {
-    console.error(`Error: Missing environment variables: ${missing.join(", ")}`);
-    process.exit(1);
-  }
-}
-function deploy() {
-  const projectDir = process.cwd();
-  const env = loadEnv(projectDir);
-  validate(env);
-  console.log(`
-Deploying to ${env.DEPLOY_HOST}:${env.DEPLOY_PATH}
-`);
-  try {
-    const scpCmd = `scp -r dist/ ${env.DEPLOY_USER}@${env.DEPLOY_HOST}:${env.DEPLOY_PATH}/`;
-    console.log(`→ ${scpCmd}`);
-    execSync(scpCmd, {
-      stdio: "inherit",
-      cwd: projectDir,
-      shell: true
-    });
-    const sshCmd = `ssh ${env.DEPLOY_USER}@${env.DEPLOY_HOST} "zsh -i -c 'cd ${env.DEPLOY_PATH} && bun install --production && (pm2 restart ${env.APP_NAME} --update-env || pm2 start dist/index.js --name ${env.APP_NAME} --update-env)'"`;
-    console.log(`→ ${sshCmd}`);
-    execSync(sshCmd, {
-      stdio: "inherit",
-      cwd: projectDir,
-      shell: true
-    });
-    console.log(`
-✓ Deployment complete!
-`);
-  } catch (error) {
-    console.error(`
-✗ Deployment failed: ${error.message}
-`);
-    process.exit(1);
-  }
-}
-deploy();

package/bin/commands/deploy/deploy.service.js

@@ -1,111 +0,0 @@
-// src/commands/deploy/deploy.service.ts
-import { execSync } from "node:child_process";
-import * as fs from "node:fs";
-
-class DeployService {
-  config;
-  constructor(config) {
-    this.config = config;
-  }
-  log(message) {
-    console.log(`[${new Date().toISOString()}] ${message}`);
-  }
-  async copyToServer() {
-    this.log("Copying dist folder to remote server...");
-    const { remoteHost, remoteUser, deployPath, localDist, envFile } = this.config;
-    if (!fs.existsSync(localDist)) {
-      throw new Error(`Local dist folder not found: ${localDist}`);
-    }
-    const sshHost = `${remoteUser}@${remoteHost}`;
-    const tempPath = `${deployPath}_tmp`;
-    try {
-      this.log(`Creating temp directory on remote: ${tempPath}`);
-      execSync(`ssh ${sshHost} "mkdir -p ${tempPath} && rm -rf ${tempPath}/*"`, { stdio: "inherit" });
-      this.log(`Copying ${localDist} to ${sshHost}:${tempPath}/`);
-      execSync(`scp -r "${localDist}" ${sshHost}:${tempPath}/dist`, {
-        stdio: "inherit"
-      });
-      if (envFile && fs.existsSync(envFile)) {
-        this.log(`Copying ${envFile} to remote`);
-        execSync(`scp "${envFile}" ${sshHost}:${tempPath}/.env`, {
-          stdio: "inherit"
-        });
-      }
-      if (fs.existsSync("package.json")) {
-        this.log("Copying package.json to remote");
-        execSync(`scp package.json ${sshHost}:${tempPath}/`, {
-          stdio: "inherit"
-        });
-      }
-      this.log(`Moving files from temp to deploy path...`);
-      const moveCmd = `rm -rf ${deployPath}/dist && ` + `mv ${tempPath}/dist ${deployPath}/ && ` + `[ -f ${tempPath}/.env ] && mv ${tempPath}/.env ${deployPath}/.env || true && ` + `[ -f ${tempPath}/package.json ] && mv ${tempPath}/package.json ${deployPath}/ || true && ` + `rm -rf ${tempPath}`;
-      execSync(`ssh ${sshHost} "${moveCmd}"`, { stdio: "inherit" });
-      this.log("✓ Files copied successfully");
-    } catch (error) {
-      throw new Error(`Failed to copy files: ${error instanceof Error ? error.message : String(error)}`);
-    }
-  }
-  async installDependencies() {
-    if (this.config.skipInstall) {
-      this.log("Skipping dependency installation");
-      return;
-    }
-    this.log("Installing dependencies on server...");
-    const { remoteHost, remoteUser, deployPath } = this.config;
-    const sshHost = `${remoteUser}@${remoteHost}`;
-    try {
-      const cmd = `cd ${deployPath} && bun install --production`;
-      execSync(`ssh ${sshHost} "${cmd}"`, { stdio: "inherit" });
-      this.log("✓ Dependencies installed");
-    } catch (error) {
-      this.log("⚠ Dependency installation skipped or failed");
-    }
-  }
-  async restartProcess() {
-    if (this.config.skipRestart) {
-      this.log("Skipping process restart");
-      return;
-    }
-    this.log("Restarting application via PM2...");
-    const { remoteHost, remoteUser, deployPath, appName, port } = this.config;
-    const sshHost = `${remoteUser}@${remoteHost}`;
-    try {
-      const portOpt = port ? ` --env PORT=${port}` : "";
-      const cmd = `cd ${deployPath} && ` + `(pm2 restart ${appName} --update-env 2>/dev/null || ` + `pm2 start dist/index.js --name ${appName}${portOpt} 2>/dev/null) && ` + `pm2 save 2>/dev/null || true`;
-      execSync(`ssh ${sshHost} "bash -l -c '${cmd}'"`, { stdio: "inherit" });
-      this.log("✓ Process restart attempted");
-    } catch (error) {
-      this.log("⚠ PM2 restart skipped - may need manual setup");
-    }
-  }
-  async deploy() {
-    const startTime = new Date().toISOString();
-    try {
-      this.log("Starting deployment...");
-      await this.copyToServer();
-      await this.installDependencies();
-      await this.restartProcess();
-      this.log("✅ Deployment completed successfully");
-      return {
-        success: true,
-        message: "Deployment completed successfully",
-        timestamp: startTime
-      };
-    } catch (error) {
-      const message = error instanceof Error ? error.message : "Unknown error";
-      this.log(`❌ Deployment failed: ${message}`);
-      return {
-        success: false,
-        message,
-        timestamp: startTime
-      };
-    }
-  }
-}
-async function createDeployService(config) {
-  return new DeployService(config);
-}
-export {
-  createDeployService,
-  DeployService
-};

package/bin/commands/deploy/deploy.sh

@@ -1,13 +0,0 @@
-#!/bin/bash
-# @description Deploy application to remote server
-
-echo "Building..."
-bun run build
-echo ""
-echo "Copying files to remote server..."
-scp -r dist/ {{DEPLOY_USER}}@{{DEPLOY_HOST}}:{{DEPLOY_PATH}}/
-echo ""
-echo "Installing dependencies and restarting service..."
-ssh {{DEPLOY_USER}}@{{DEPLOY_HOST}} "cd {{DEPLOY_PATH}} && bun install --production && pm2 restart {{APP_NAME}} --update-env"
-echo ""
-echo "✓ Deployment complete!"