fix(cli): Improve CLI formatting, refine debug option filtering, and remove unused dgram import in SNMP manager

changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 2025-03-26 - 2.6.8 - fix(cli)
+Improve CLI formatting, refine debug option filtering, and remove unused dgram import in SNMP manager
+
+- Standardize whitespace and formatting in ts/cli.ts for consistency
+- Refine argument filtering for debug mode and prompt messages
+- Remove unused 'dgram' import from ts/snmp/manager.ts
+
 ## 2025-03-26 - 2.6.7 - fix(setup.sh)
 Clarify net-snmp dependency installation message in setup.sh
 

pnpm-lock.yaml

@@ -9,7 +9,7 @@ importers:
   .:
     dependencies:
       net-snmp:
-        specifier: ^3.20.0
+        specifier: 3.20.0
         version: 3.20.0
     devDependencies:
       '@git.zone/tsbuild':

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@serve.zone/nupst',
-  version: '2.6.7',
+  version: '2.6.8',
   description: 'Node.js UPS Shutdown Tool for SNMP-enabled UPS devices'
 }

ts/cli.ts

@@ -46,7 +46,7 @@ export class NupstCli {
   private extractDebugOptions(args: string[]): { debugMode: boolean; cleanedArgs: string[] } {
     const debugMode = args.includes('--debug') || args.includes('-d');
     // Remove debug flags from args
-    const cleanedArgs = args.filter(arg => arg !== '--debug' && arg !== '-d');
+    const cleanedArgs = args.filter((arg) => arg !== '--debug' && arg !== '-d');
 
     return { debugMode, cleanedArgs };
   }
@@ -151,7 +151,7 @@ export class NupstCli {
       console.log('Tailing nupst service logs (Ctrl+C to exit)...\n');
 
       const journalctl = spawn('journalctl', ['-u', 'nupst.service', '-n', '50', '-f'], {
-        stdio: ['ignore', 'inherit', 'inherit']
+        stdio: ['ignore', 'inherit', 'inherit'],
       });
 
       // Forward signals to child process
@@ -236,7 +236,7 @@ export class NupstCli {
       } catch (error) {
         console.error('┌─ Configuration Error ─────────────────────┐');
         console.error('│ No configuration found.');
-        console.error('│ Please run \'nupst setup\' first to create a configuration.');
+        console.error("│ Please run 'nupst setup' first to create a configuration.");
         console.error('└──────────────────────────────────────────┘');
         return;
       }
@@ -306,7 +306,7 @@ export class NupstCli {
       // Create a test config with a short timeout
       const testConfig = {
         ...config.snmp,
-        timeout: Math.min(config.snmp.timeout, 10000) // Use at most 10 seconds for testing
+        timeout: Math.min(config.snmp.timeout, 10000), // Use at most 10 seconds for testing
       };
 
       const status = await this.nupst.getSnmp().getUpsStatus(testConfig);
@@ -326,7 +326,7 @@ export class NupstCli {
       console.error('┌─ Connection Failed! ───────────────────────┐');
       console.error(`│ Error: ${error.message}`);
       console.error('└──────────────────────────────────────────┘');
-      console.log('\nPlease check your settings and run \'nupst setup\' to reconfigure.');
+      console.log("\nPlease check your settings and run 'nupst setup' to reconfigure.");
     }
   }
 
@@ -340,20 +340,28 @@ export class NupstCli {
 
     if (status.batteryCapacity < config.thresholds.battery) {
       console.log('│ ⚠️ WARNING: Battery capacity below threshold');
-      console.log(`│   Current: ${status.batteryCapacity}% | Threshold: ${config.thresholds.battery}%`);
+      console.log(
+        `│   Current: ${status.batteryCapacity}% | Threshold: ${config.thresholds.battery}%`
+      );
       console.log('│   System would initiate shutdown');
     } else {
       console.log('│ ✓ Battery capacity above threshold');
-      console.log(`│   Current: ${status.batteryCapacity}% | Threshold: ${config.thresholds.battery}%`);
+      console.log(
+        `│   Current: ${status.batteryCapacity}% | Threshold: ${config.thresholds.battery}%`
+      );
     }
 
     if (status.batteryRuntime < config.thresholds.runtime) {
       console.log('│ ⚠️ WARNING: Runtime below threshold');
-      console.log(`│   Current: ${status.batteryRuntime} min | Threshold: ${config.thresholds.runtime} min`);
+      console.log(
+        `│   Current: ${status.batteryRuntime} min | Threshold: ${config.thresholds.runtime} min`
+      );
       console.log('│   System would initiate shutdown');
     } else {
       console.log('│ ✓ Runtime above threshold');
-      console.log(`│   Current: ${status.batteryRuntime} min | Threshold: ${config.thresholds.runtime} min`);
+      console.log(
+        `│   Current: ${status.batteryRuntime} min | Threshold: ${config.thresholds.runtime} min`
+      );
     }
 
     console.log('└──────────────────────────────────────────┘');
@@ -393,7 +401,9 @@ Options:
   private async update(): Promise<void> {
     try {
       // Check if running as root
-      this.checkRootAccess('This command must be run as root to update NUPST and refresh the systemd service.');
+      this.checkRootAccess(
+        'This command must be run as root to update NUPST and refresh the systemd service.'
+      );
 
       console.log('┌─ NUPST Update Process ──────────────────┐');
       console.log('│ Updating NUPST from repository...');
@@ -412,7 +422,9 @@ Options:
       try {
         // 1. Update the repository
         console.log('│ Pulling latest changes from git repository...');
-        execSync(`cd ${installDir} && git fetch origin && git reset --hard origin/main`, { stdio: 'pipe' });
+        execSync(`cd ${installDir} && git fetch origin && git reset --hard origin/main`, {
+          stdio: 'pipe',
+        });
 
         // 2. Run the install.sh script
         console.log('│ Running install.sh to update NUPST...');
@@ -426,11 +438,19 @@ Options:
         console.log('│ Refreshing systemd service...');
 
         // First check if service exists
-        const serviceExists = execSync('systemctl list-unit-files | grep nupst.service').toString().includes('nupst.service');
+        let serviceExists = false;
+        try {
+          const output = execSync('systemctl list-unit-files | grep nupst.service').toString();
+          serviceExists = output.includes('nupst.service');
+        } catch (error) {
+          // If grep fails (service not found), serviceExists remains false
+          serviceExists = false;
+        }
 
         if (serviceExists) {
           // Stop the service if it's running
-          const isRunning = execSync('systemctl is-active nupst.service || true').toString().trim() === 'active';
+          const isRunning =
+            execSync('systemctl is-active nupst.service || true').toString().trim() === 'active';
           if (isRunning) {
             console.log('│ Stopping nupst service...');
             execSync('systemctl stop nupst.service');
@@ -474,7 +494,7 @@ Options:
 
       const rl = readline.createInterface({
         input: process.stdin,
-        output: process.stdout
+        output: process.stdout,
       });
 
       // Helper function to prompt for input
@@ -546,7 +566,10 @@ Options:
    * @param prompt Function to prompt for user input
    * @returns Updated configuration
    */
-  private async gatherSnmpSettings(config: any, prompt: (question: string) => Promise<string>): Promise<any> {
+  private async gatherSnmpSettings(
+    config: any,
+    prompt: (question: string) => Promise<string>
+  ): Promise<any> {
     // SNMP IP Address
     const defaultHost = config.snmp.host;
     const host = await prompt(`UPS IP Address [${defaultHost}]: `);
@@ -556,7 +579,7 @@ Options:
     const defaultPort = config.snmp.port;
     const portInput = await prompt(`SNMP Port [${defaultPort}]: `);
     const port = parseInt(portInput, 10);
-    config.snmp.port = (portInput.trim() && !isNaN(port)) ? port : defaultPort;
+    config.snmp.port = portInput.trim() && !isNaN(port) ? port : defaultPort;
 
     // SNMP Version
     const defaultVersion = config.snmp.version;
@@ -566,7 +589,10 @@ Options:
     console.log('  3) SNMPv3 (with security features)');
     const versionInput = await prompt(`Select SNMP version [${defaultVersion}]: `);
     const version = parseInt(versionInput, 10);
-    config.snmp.version = (versionInput.trim() && (version === 1 || version === 2 || version === 3)) ? version : defaultVersion;
+    config.snmp.version =
+      versionInput.trim() && (version === 1 || version === 2 || version === 3)
+        ? version
+        : defaultVersion;
 
     if (config.snmp.version === 1 || config.snmp.version === 2) {
       // SNMP Community String (for v1/v2c)
@@ -587,7 +613,10 @@ Options:
    * @param prompt Function to prompt for user input
    * @returns Updated configuration
    */
-  private async gatherSnmpV3Settings(config: any, prompt: (question: string) => Promise<string>): Promise<any> {
+  private async gatherSnmpV3Settings(
+    config: any,
+    prompt: (question: string) => Promise<string>
+  ): Promise<any> {
     console.log('\nSNMPv3 Security Settings:');
 
     // Security Level
@@ -595,9 +624,13 @@ Options:
     console.log('  1) noAuthNoPriv (No Authentication, No Privacy)');
     console.log('  2) authNoPriv (Authentication, No Privacy)');
     console.log('  3) authPriv (Authentication and Privacy)');
-    const defaultSecLevel = config.snmp.securityLevel ? 
+    const defaultSecLevel = config.snmp.securityLevel
-      (config.snmp.securityLevel === 'noAuthNoPriv' ? 1 : 
+      ? config.snmp.securityLevel === 'noAuthNoPriv'
-       config.snmp.securityLevel === 'authNoPriv' ? 2 : 3) : 3;
+        ? 1
+        : config.snmp.securityLevel === 'authNoPriv'
+        ? 2
+        : 3
+      : 3;
     const secLevelInput = await prompt(`Select Security Level [${defaultSecLevel}]: `);
     const secLevel = parseInt(secLevelInput, 10) || defaultSecLevel;
 
@@ -639,7 +672,9 @@ Options:
 
       // Allow customizing the timeout value
       const defaultTimeout = config.snmp.timeout / 1000; // Convert from ms to seconds for display
-      console.log('\nSNMPv3 operations with authentication and privacy may require longer timeouts.');
+      console.log(
+        '\nSNMPv3 operations with authentication and privacy may require longer timeouts.'
+      );
       const timeoutInput = await prompt(`SNMP Timeout in seconds [${defaultTimeout}]: `);
       const timeout = parseInt(timeoutInput, 10);
       if (timeoutInput.trim() && !isNaN(timeout)) {
@@ -656,13 +691,18 @@ Options:
    * @param prompt Function to prompt for user input
    * @returns Updated configuration
    */
-  private async gatherAuthenticationSettings(config: any, prompt: (question: string) => Promise<string>): Promise<any> {
+  private async gatherAuthenticationSettings(
+    config: any,
+    prompt: (question: string) => Promise<string>
+  ): Promise<any> {
     // Authentication protocol
     console.log('\nAuthentication Protocol:');
     console.log('  1) MD5');
     console.log('  2) SHA');
     const defaultAuthProtocol = config.snmp.authProtocol === 'SHA' ? 2 : 1;
-    const authProtocolInput = await prompt(`Select Authentication Protocol [${defaultAuthProtocol}]: `);
+    const authProtocolInput = await prompt(
+      `Select Authentication Protocol [${defaultAuthProtocol}]: `
+    );
     const authProtocol = parseInt(authProtocolInput, 10) || defaultAuthProtocol;
     config.snmp.authProtocol = authProtocol === 2 ? 'SHA' : 'MD5';
 
@@ -680,7 +720,10 @@ Options:
    * @param prompt Function to prompt for user input
    * @returns Updated configuration
    */
-  private async gatherPrivacySettings(config: any, prompt: (question: string) => Promise<string>): Promise<any> {
+  private async gatherPrivacySettings(
+    config: any,
+    prompt: (question: string) => Promise<string>
+  ): Promise<any> {
     // Privacy protocol
     console.log('\nPrivacy Protocol:');
     console.log('  1) DES');
@@ -704,32 +747,42 @@ Options:
    * @param prompt Function to prompt for user input
    * @returns Updated configuration
    */
-  private async gatherThresholdSettings(config: any, prompt: (question: string) => Promise<string>): Promise<any> {
+  private async gatherThresholdSettings(
+    config: any,
+    prompt: (question: string) => Promise<string>
+  ): Promise<any> {
     console.log('\nShutdown Thresholds:');
 
     // Battery threshold
     const defaultBatteryThreshold = config.thresholds.battery;
-    const batteryThresholdInput = await prompt(`Battery percentage threshold [${defaultBatteryThreshold}%]: `);
+    const batteryThresholdInput = await prompt(
+      `Battery percentage threshold [${defaultBatteryThreshold}%]: `
+    );
     const batteryThreshold = parseInt(batteryThresholdInput, 10);
-    config.thresholds.battery = (batteryThresholdInput.trim() && !isNaN(batteryThreshold)) 
+    config.thresholds.battery =
-      ? batteryThreshold 
+      batteryThresholdInput.trim() && !isNaN(batteryThreshold)
-      : defaultBatteryThreshold;
+        ? batteryThreshold
+        : defaultBatteryThreshold;
 
     // Runtime threshold
     const defaultRuntimeThreshold = config.thresholds.runtime;
-    const runtimeThresholdInput = await prompt(`Runtime minutes threshold [${defaultRuntimeThreshold} minutes]: `);
+    const runtimeThresholdInput = await prompt(
+      `Runtime minutes threshold [${defaultRuntimeThreshold} minutes]: `
+    );
     const runtimeThreshold = parseInt(runtimeThresholdInput, 10);
-    config.thresholds.runtime = (runtimeThresholdInput.trim() && !isNaN(runtimeThreshold)) 
+    config.thresholds.runtime =
-      ? runtimeThreshold 
+      runtimeThresholdInput.trim() && !isNaN(runtimeThreshold)
-      : defaultRuntimeThreshold;
+        ? runtimeThreshold
+        : defaultRuntimeThreshold;
 
     // Check interval
     const defaultInterval = config.checkInterval / 1000; // Convert from ms to seconds for display
     const intervalInput = await prompt(`Check interval in seconds [${defaultInterval}]: `);
     const interval = parseInt(intervalInput, 10);
-    config.checkInterval = (intervalInput.trim() && !isNaN(interval)) 
+    config.checkInterval =
-      ? interval * 1000 // Convert to ms
+      intervalInput.trim() && !isNaN(interval)
-      : defaultInterval * 1000;
+        ? interval * 1000 // Convert to ms
+        : defaultInterval * 1000;
 
     return config;
   }
@@ -740,7 +793,10 @@ Options:
    * @param prompt Function to prompt for user input
    * @returns Updated configuration
    */
-  private async gatherUpsModelSettings(config: any, prompt: (question: string) => Promise<string>): Promise<any> {
+  private async gatherUpsModelSettings(
+    config: any,
+    prompt: (question: string) => Promise<string>
+  ): Promise<any> {
     console.log('\nUPS Model Selection:');
     console.log('  1) CyberPower');
     console.log('  2) APC');
@@ -749,12 +805,20 @@ Options:
     console.log('  5) Liebert/Vertiv');
     console.log('  6) Custom (Advanced)');
 
-    const defaultModelValue = config.snmp.upsModel === 'cyberpower' ? 1 :
+    const defaultModelValue =
-                           config.snmp.upsModel === 'apc' ? 2 :
+      config.snmp.upsModel === 'cyberpower'
-                           config.snmp.upsModel === 'eaton' ? 3 :
+        ? 1
-                           config.snmp.upsModel === 'tripplite' ? 4 :
+        : config.snmp.upsModel === 'apc'
-                           config.snmp.upsModel === 'liebert' ? 5 : 
+        ? 2
-                           config.snmp.upsModel === 'custom' ? 6 : 1;
+        : config.snmp.upsModel === 'eaton'
+        ? 3
+        : config.snmp.upsModel === 'tripplite'
+        ? 4
+        : config.snmp.upsModel === 'liebert'
+        ? 5
+        : config.snmp.upsModel === 'custom'
+        ? 6
+        : 1;
 
     const modelInput = await prompt(`Select UPS model [${defaultModelValue}]: `);
     const modelValue = parseInt(modelInput, 10) || defaultModelValue;
@@ -783,7 +847,7 @@ Options:
       config.snmp.customOIDs = {
         POWER_STATUS: powerStatusOID.trim(),
         BATTERY_CAPACITY: batteryCapacityOID.trim(),
-        BATTERY_RUNTIME: batteryRuntimeOID.trim()
+        BATTERY_RUNTIME: batteryRuntimeOID.trim(),
       };
     }
 
@@ -799,8 +863,10 @@ Options:
     console.log(`│ SNMP Host: ${config.snmp.host}:${config.snmp.port}`);
     console.log(`│ SNMP Version: ${config.snmp.version}`);
     console.log(`│ UPS Model: ${config.snmp.upsModel}`);
-    console.log(`│ Thresholds: ${config.thresholds.battery}% battery, ${config.thresholds.runtime} min runtime`);
+    console.log(
-    console.log(`│ Check Interval: ${config.checkInterval/1000} seconds`);
+      `│ Thresholds: ${config.thresholds.battery}% battery, ${config.thresholds.runtime} min runtime`
+    );
+    console.log(`│ Check Interval: ${config.checkInterval / 1000} seconds`);
     console.log('└──────────────────────────────────────────┘\n');
   }
 
@@ -809,15 +875,20 @@ Options:
    * @param config Current configuration
    * @param prompt Function to prompt for user input
    */
-  private async optionallyTestConnection(config: any, prompt: (question: string) => Promise<string>): Promise<void> {
+  private async optionallyTestConnection(
-    const testConnection = await prompt('Would you like to test the connection to your UPS? (y/N): ');
+    config: any,
+    prompt: (question: string) => Promise<string>
+  ): Promise<void> {
+    const testConnection = await prompt(
+      'Would you like to test the connection to your UPS? (y/N): '
+    );
     if (testConnection.toLowerCase() === 'y') {
       console.log('\nTesting connection to UPS...');
       try {
         // Create a test config with a short timeout
         const testConfig = {
           ...config.snmp,
-          timeout: Math.min(config.snmp.timeout, 10000) // Use at most 10 seconds for testing
+          timeout: Math.min(config.snmp.timeout, 10000), // Use at most 10 seconds for testing
         };
 
         const status = await this.nupst.getSnmp().getUpsStatus(testConfig);
@@ -843,7 +914,8 @@ Options:
   private async restartServiceIfRunning(): Promise<void> {
     try {
       // Check if the service is active
-      const isActive = execSync('systemctl is-active nupst.service || true').toString().trim() === 'active';
+      const isActive =
+        execSync('systemctl is-active nupst.service || true').toString().trim() === 'active';
 
       if (isActive) {
         // Service is running, restart it
@@ -878,18 +950,24 @@ Options:
    * Optionally enable and start systemd service
    * @param prompt Function to prompt for user input
    */
-  private async optionallyEnableService(prompt: (question: string) => Promise<string>): Promise<void> {
+  private async optionallyEnableService(
+    prompt: (question: string) => Promise<string>
+  ): Promise<void> {
     if (process.getuid && process.getuid() !== 0) {
       console.log('\nNote: Run "sudo nupst enable" to set up NUPST as a system service.');
     } else {
-      const setupService = await prompt('Would you like to enable NUPST as a system service? (y/N): ');
+      const setupService = await prompt(
+        'Would you like to enable NUPST as a system service? (y/N): '
+      );
       if (setupService.toLowerCase() === 'y') {
         try {
           await this.nupst.getSystemd().install();
           console.log('Service installed and enabled to start on boot.');
 
           // Ask if the user wants to start the service now
-          const startService = await prompt('Would you like to start the NUPST service now? (Y/n): ');
+          const startService = await prompt(
+            'Would you like to start the NUPST service now? (Y/n): '
+          );
           if (startService.toLowerCase() !== 'n') {
             await this.nupst.getSystemd().start();
             console.log('NUPST service started successfully.');
@@ -914,7 +992,7 @@ Options:
       } catch (error) {
         console.error('┌─ Configuration Error ─────────────────────┐');
         console.error('│ No configuration found.');
-        console.error('│ Please run \'nupst setup\' first to create a configuration.');
+        console.error("│ Please run 'nupst setup' first to create a configuration.");
         console.error('└──────────────────────────────────────────┘');
         return;
       }
@@ -938,7 +1016,10 @@ Options:
         console.log(`│   Username: ${config.snmp.username}`);
 
         // Show auth and privacy details based on security level
-        if (config.snmp.securityLevel === 'authNoPriv' || config.snmp.securityLevel === 'authPriv') {
+        if (
+          config.snmp.securityLevel === 'authNoPriv' ||
+          config.snmp.securityLevel === 'authPriv'
+        ) {
           console.log(`│   Auth Protocol: ${config.snmp.authProtocol || 'None'}`);
         }
 
@@ -954,7 +1035,9 @@ Options:
       if (config.snmp.upsModel === 'custom' && config.snmp.customOIDs) {
         console.log('│ Custom OIDs:');
         console.log(`│   Power Status: ${config.snmp.customOIDs.POWER_STATUS || 'Not set'}`);
-        console.log(`│   Battery Capacity: ${config.snmp.customOIDs.BATTERY_CAPACITY || 'Not set'}`);
+        console.log(
+          `│   Battery Capacity: ${config.snmp.customOIDs.BATTERY_CAPACITY || 'Not set'}`
+        );
         console.log(`│   Battery Runtime: ${config.snmp.customOIDs.BATTERY_RUNTIME || 'Not set'}`);
       }
 
@@ -973,8 +1056,10 @@ Options:
 
       // Show service status
       try {
-        const isActive = execSync('systemctl is-active nupst.service || true').toString().trim() === 'active';
+        const isActive =
-        const isEnabled = execSync('systemctl is-enabled nupst.service || true').toString().trim() === 'enabled';
+          execSync('systemctl is-active nupst.service || true').toString().trim() === 'active';
+        const isEnabled =
+          execSync('systemctl is-enabled nupst.service || true').toString().trim() === 'enabled';
 
         console.log('┌─ Service Status ─────────────────────────┐');
         console.log(`│ Service Active: ${isActive ? 'Yes' : 'No'}`);
@@ -983,7 +1068,6 @@ Options:
       } catch (error) {
         // Ignore errors checking service status
       }
-      
     } catch (error) {
       console.error(`Failed to display configuration: ${error.message}`);
     }
@@ -1002,7 +1086,7 @@ Options:
 
       const rl = readline.createInterface({
         input: process.stdin,
-        output: process.stdout
+        output: process.stdout,
       });
 
       // Helper function to prompt for input
@@ -1019,7 +1103,9 @@ Options:
       console.log('This will completely remove NUPST from your system.\n');
 
       // Ask about removing configuration
-      const removeConfig = await prompt('Do you want to remove the NUPST configuration files? (y/N): ');
+      const removeConfig = await prompt(
+        'Do you want to remove the NUPST configuration files? (y/N): '
+      );
 
       // Find the uninstall.sh script location
       let uninstallScriptPath: string;
@@ -1036,10 +1122,7 @@ Options:
         await fs.access(uninstallScriptPath);
       } catch (error) {
         // If we can't find it in the expected location, try common installation paths
-        const commonPaths = [
+        const commonPaths = ['/opt/nupst/uninstall.sh', join(process.cwd(), 'uninstall.sh')];
-          '/opt/nupst/uninstall.sh',
-          join(process.cwd(), 'uninstall.sh')
-        ];
 
         for (const path of commonPaths) {
           try {
@@ -1068,16 +1151,15 @@ Options:
       const env = {
         ...process.env,
         REMOVE_CONFIG: removeConfig.toLowerCase() === 'y' ? 'yes' : 'no',
-        REMOVE_REPO: 'yes',  // Always remove repo as requested
+        REMOVE_REPO: 'yes', // Always remove repo as requested
-        NUPST_CLI_CALL: 'true'  // Flag to indicate this is being called from CLI
+        NUPST_CLI_CALL: 'true', // Flag to indicate this is being called from CLI
       };
 
       // Run the uninstall script with sudo
       execSync(`sudo bash ${uninstallScriptPath}`, {
         env,
-        stdio: 'inherit'  // Show output in the terminal
+        stdio: 'inherit', // Show output in the terminal
       });
-      
     } catch (error) {
       console.error(`Uninstall failed: ${error.message}`);
       process.exit(1);

ts/snmp/manager.ts

@@ -1,4 +1,3 @@
-import * as dgram from 'dgram';
 import * as snmp from 'net-snmp';
 import type { IOidSet, ISnmpConfig, TUpsModel, IUpsStatus } from './types.js';
 import { UpsOidSets } from './oid-sets.js';