@tertium/hlpr 0.1.16 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
 # hlpr
 
-A CLI utility for running shell scripts with variable substitution.
+A CLI utility for running shell scripts with variable substitution and TypeScript-based commands.
 
 ## Installation
 
@@ -26,20 +26,87 @@ hlpr git fodd
 hlpr hello world
 hlpr ssh init dir
 
+# TypeScript commands (nested structure)
+hlpr file rename <directory> <style> [--dry|-n]
+
 # Continue execution even if commands fail
 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
+- `camel` - camelCaseLowerFirst
+- `pascal` - PascalCaseUpperFirst
+- `upper` - UPPER_CASE_WITH_UNDERSCORES
+- `lower` - lower_case_with_underscores
+
+**Examples:**
+
+```bash
+# Dry run (preview changes without applying)
+hlpr file rename ./my-project kebab --dry
+hlpr file rename ./src snake -n
+
+# Apply changes
+hlpr file rename ./my-project kebab
+hlpr file rename ./docs pascal
+```
+
+**Features:**
+
+- ✅ Recursive directory traversal
+- ✅ Extension preservation (e.g., `file-name.md` core name only)
+- ✅ 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.
+
 ## How It Works
 
+### Shell Scripts
+
 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
 
+### TypeScript Commands
+
+1. The command `hlpr file rename` looks for a script at `commands/file/rename/rename.ts`
+2. Arguments are passed directly to the TypeScript module
+3. The module is executed with Bun runtime
+
 ## Directory Structure
 
 ```
 commands/
+├── file/
+│   └── rename/
+│       ├── rename.ts
+│       ├── rename.test.ts
+│       └── README.md
 ├── git/
 │   └── fodd.sh
 ├── hello/
@@ -53,22 +120,50 @@ commands/
 
 ## Adding Your Own Scripts
 
+### Shell 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}}"
 ```
 
+### TypeScript Commands
+
+1. Create a nested directory structure in `commands/<category>/<command>/`
+2. Add your TypeScript file named `<command>.ts`
+3. Implement CLI argument parsing and logic
+4. Optionally add tests in `<command>.test.ts`
+
+Example structure:
+
+```text
+commands/
+└── file/
+    └── rename/
+        ├── rename.ts      # Main implementation
+        ├── rename.test.ts # Tests
+        └── README.md      # Documentation
+```
+
 ## Command Naming
 
 The utility maps command arguments to script files:
+
+**Shell Scripts:**
+
 - `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`
 
+**TypeScript Commands:**
+
+- `hlpr file rename <args>` → runs `commands/file/rename/rename.ts`
+
 ## Error Handling
 
 By default, the utility stops execution if any command fails. Use the `-f` flag to continue execution despite failures:
@@ -99,4 +194,4 @@ npm link
 
 ## License
 
-MIT
+MIT

package/index.js

@@ -39,9 +39,9 @@ var rl = readline.createInterface({
   output: process.stdout
 });
 function prompt(question) {
-  return new Promise((resolve2) => {
+  return new Promise((resolve) => {
     rl.question(question, (answer) => {
-      resolve2(answer);
+      resolve(answer);
     });
   });
 }
@@ -50,7 +50,7 @@ async function executeCommand(command, variables) {
   for (const [key, value] of Object.entries(variables)) {
     processedCommand = processedCommand.replace(new RegExp(`{{${key}}}`, "g"), value);
   }
-  return new Promise((resolve2) => {
+  return new Promise((resolve) => {
     console.log(`Executing: ${processedCommand}`);
     const childProcess = exec(processedCommand);
     if (childProcess.stdout) {
@@ -65,10 +65,10 @@ async function executeCommand(command, variables) {
     }
     childProcess.on("exit", (code) => {
       if (code === 0) {
-        resolve2(true);
+        resolve(true);
       } else {
         console.error(`Command failed with exit code ${code}`);
-        resolve2(false);
+        resolve(false);
       }
     });
   });
@@ -79,22 +79,69 @@ async function main() {
     console.log(`hlpr version ${version}`);
     process.exit(0);
   }
-  if (commandArgs.length === 0) {
-    console.error("Please provide a command. Example: hlpr ssh init-dir");
-    process.exit(1);
+  if (commandArgs.length === 0 || commandArgs[0] === "help" || commandArgs[0] === "--help" || commandArgs[0] === "-h" || commandArgs[0] === "/help" || commandArgs[0] === "/h" || commandArgs[0] === "/?") {
+    const __filename2 = fileURLToPath(import.meta.url);
+    const __dirname2 = path.dirname(__filename2);
+    const helpScriptPath = path.join(__dirname2, "commands", "help", "help.ts");
+    if (fs.existsSync(helpScriptPath)) {
+      const helpCommand = `bun "${helpScriptPath}"`;
+      await executeCommand(helpCommand, {});
+      rl.close();
+      process.exit(0);
+    } else {
+      console.error("Please provide a command. Example: hlpr ssh init-dir");
+      console.error("Run 'hlpr help' for available commands.");
+      process.exit(1);
+    }
   }
   try {
     const category = commandArgs[0];
     const restArgs = commandArgs.slice(1);
-    const scriptName = restArgs.join("");
     const __filename2 = fileURLToPath(import.meta.url);
     const __dirname2 = path.dirname(__filename2);
-    const scriptDir = path.resolve(__dirname2, "..");
-    const scriptPath = path.join(scriptDir, "commands", category, `${scriptName}.sh`);
-    if (!fs.existsSync(scriptPath)) {
-      console.error(`Script not found: ${scriptPath}`);
+    const scriptDir = __dirname2;
+    let scriptPath;
+    let isTypeScriptCommand = false;
+    if (restArgs.length > 0) {
+      const subcategory = restArgs[0];
+      const nestedTsPath = path.join(scriptDir, "commands", category, subcategory, `${subcategory}.ts`);
+      if (fs.existsSync(nestedTsPath)) {
+        scriptPath = nestedTsPath;
+        isTypeScriptCommand = true;
+      }
+    }
+    if (!isTypeScriptCommand) {
+      const tsPath = path.join(scriptDir, "commands", category, `${category}.ts`);
+      if (fs.existsSync(tsPath)) {
+        scriptPath = tsPath;
+        isTypeScriptCommand = true;
+      }
+    }
+    if (!isTypeScriptCommand && restArgs.length > 0) {
+      const scriptName = restArgs.join("");
+      scriptPath = path.join(scriptDir, "commands", category, `${scriptName}.sh`);
+      if (!fs.existsSync(scriptPath)) {
+        console.error(`Script not found: ${scriptPath}`);
+        process.exit(1);
+      }
+    }
+    if (!scriptPath) {
+      console.error(`Command not found. Usage: hlpr ${category} <args>`);
       process.exit(1);
     }
+    if (isTypeScriptCommand) {
+      const tsArgs = restArgs.length > 0 && restArgs[0] && fs.existsSync(path.join(scriptDir, "commands", category, restArgs[0])) ? process.argv.slice(4) : process.argv.slice(3);
+      const finalCommand = `bun "${scriptPath}" ${tsArgs.join(" ")}`;
+      console.log(`Executing TypeScript command: ${finalCommand}`);
+      const success2 = await executeCommand(finalCommand, {});
+      if (!success2 && !forceFlag) {
+        console.error("Command failed, stopping execution.");
+        process.exit(1);
+      }
+      console.log("Command completed successfully!");
+      rl.close();
+      return;
+    }
     const scriptContent = await readFile(scriptPath, "utf-8");
     const variableRegex = /{{([^}]+)}}/g;
     const variables = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tertium/hlpr",
-  "version": "0.1.16",
+  "version": "0.3.0",
   "description": "Windows and *Nix utility for typical programming activity",
   "author": "Vitalii Balabanov",
   "email": "tertiumnon@gmail.com",
@@ -9,13 +9,13 @@
   "scripts": {
     "build": "bun build ./src/index.ts --outfile ./index.js --target node",
     "prepublishOnly": "npm run build",
-    "release:minor": "node node_modules/@tertium/shared-js-configs-and-types/scripts/release.js minor",
-    "release:patch": "node node_modules/@tertium/shared-js-configs-and-types/scripts/release.js patch",
-    "release:major": "node node_modules/@tertium/shared-js-configs-and-types/scripts/release.js major",
+    "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",
     "prepare": "husky"
   },
   "devDependencies": {
-    "@tertium/shared-js-configs-and-types": "^0.14.0",
+    "@tertium/js": "^0.16.0",
     "@types/node": "^22.13.10",
     "husky": "^9.1.7",
     "typescript": "^5.8.3"