📊 Enhance table display and fix help formatting for v2.1.0

This commit includes several improvements for the v2.1.0 release:

- Fix compilation issues with help text formatting by replacing backtick concatenation with double quotes
- Optimize table display for queries with many labels:
  - Limit displayed columns to 10 (metric + 8 labels + value)
  - Truncate long headers and values for better readability
  - Implement intelligent column limiting for wide tables
- Add emojis to feature and tips sections for improved visual appeal
- Reorganize tips display to show before Prometheus connection
- Update README with v2.1.0 release notes and new features
- Improve alignment of command-line options in help output

These enhancements make the application more robust and user-friendly, particularly when working with complex metrics containing numerous labels.

Author: SckyzO

README.md

@@ -31,6 +31,7 @@ A powerful command-line tool for querying Prometheus metrics with advanced autoc
   - [📄 License](#-license)
   - [📝 Version History](#-version-history)
     - [v2.0.0 - Complete Go Rewrite 🚀](#v200---complete-go-rewrite-)
+    - [v2.1.0 - Enhanced Usability and Display 🚀](#v210---enhanced-usability-and-display-)
     - [v1.0.0 - Original Python Implementation](#v100---original-python-implementation)
 
 ## 📝 Overview
@@ -64,8 +65,9 @@ Prometheus CLI is a modern, feature-rich tool that allows you to query Prometheu
 
 ### ⚙️ Configuration
 - **🌐 Custom Prometheus URLs**: Connect to any Prometheus server
-- **📝 Command History**: Persistent command history across sessions
-- **🎛️ Configurable Options**: Flexible command-line options for all features
+- **📝 Command History**: Flexible command history management with options for persistent files and temporary files.
+- **🎛️ Configurable Options**: Flexible command-line options for all features, including history and debugging.
+- **🐛 Debugging**: Enable verbose output for detailed error diagnosis.
 
 ## 📥 Installation
 
@@ -124,6 +126,10 @@ Prometheus CLI supports the following command line options:
 --password             Password for basic authentication
 --insecure             Skip TLS certificate verification
 --enable-label-values  Enable autocompletion for label values (default: true)
+--history-file         Path to the command history file. If not set, a temporary file is used.
+--persist-history      Do not delete the history file on exit. Only applicable if --history-file is set or a temporary file is used.
+--debug                Enable verbose error output for debugging.
+--tips                 Display detailed feature and usage tips on startup.
 --help, -h             Show help
 --version              Show version information
 ```
@@ -241,12 +247,25 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 **Technical Enhancements:**
 - Refactored codebase with proper Go package structure
-- Comprehensive documentation following Go best practices
 - Automated testing and continuous integration
 - Memory-efficient data structures and algorithms
 - Robust error handling and user feedback
 
+### v2.1.0 - Enhanced Usability and Display 🚀
+**Major Features:**
+- **📝 Configurable History**: Added `--history-file` and `--persist-history` flags for flexible command history management.
+- **🐛 Improved Debugging**: Enhanced `--debug` flag with more verbose output for initialization and error diagnosis.
+- **💡 Optional Tips**: Introduced `--tips` flag to control the display of detailed feature and usage tips on startup.
+- **📊 Optimized Table Display**: Improved table rendering for queries with many labels, preventing excessive width issues.
+
+**Technical Enhancements:**
+- Refined error handling and logging for better debugging experience.
+- Improved command-line option parsing and validation.
+- Implemented intelligent column limiting and header truncation for better readability.
+- Fixed compilation issues with help text formatting.
+
 ### v1.0.0 - Original Python Implementation
 - Basic Prometheus querying functionality
 - Simple table output
 - Basic metric name autocompletion
+

cmd/prom-cli/main.go

@@ -5,7 +5,7 @@ package main
 import (
 	"fmt"
 	"os"
-	"path/filepath" // Added for filepath.Join
+	"path/filepath"
 	"strings"
 
 	"prometheus-cli/internal/completion"
@@ -19,32 +19,22 @@ import (
 
 // Command-line flags for configuring the application behavior.
 var (
-	// url specifies the Prometheus server URL to connect to.
-	url = kingpin.Flag("url", "Prometheus server URL.").Default("http://localhost:9090").String()
-
-	// username specifies the username for basic authentication.
+	// Prometheus Connection Flags
+	url      = kingpin.Flag("url", "Prometheus server URL.").Default("http://localhost:9090").String()
 	username = kingpin.Flag("username", "Username for basic authentication.").String()
-
-	// password specifies the password for basic authentication.
 	password = kingpin.Flag("password", "Password for basic authentication.").String()
-
-	// insecure determines whether to skip TLS certificate verification.
 	insecure = kingpin.Flag("insecure", "Skip TLS certificate verification.").Bool()
 
-	// enableLabelValues controls whether label values autocompletion is enabled.
+	// Autocompletion Flags
 	enableLabelValues = kingpin.Flag("enable-label-values", "Enable autocompletion for label values.").Default("true").Bool()
 
-	// debug enables verbose error output for debugging purposes.
-	debug = kingpin.Flag("debug", "Enable verbose error output for debugging.").Bool()
-
-	// historyFile specifies the path to the command history file.
-	historyFile = kingpin.Flag("history-file", "Path to the command history file. If not set, a temporary file is used.\n").String()
-
-	// persistHistory determines whether the history file should be persisted across sessions.
-persistHistory = kingpin.Flag("persist-history", "Do not delete the history file on exit. Only applicable if --history-file is set or a temporary file is used.\n").Bool()
+	// History Flags
+	historyFile    = kingpin.Flag("history-file", "Path to the command history file.").String()
+	persistHistory = kingpin.Flag("persist-history", "Do not delete the history file on exit.").Bool()
 
-	// tips enables the display of detailed feature and usage tips on startup.
-	tips = kingpin.Flag("tips", "Display detailed feature and usage tips on startup.").Bool()
+	// Display and Utility Flags
+	debug = kingpin.Flag("debug", "Enable verbose error output for debugging.").Bool()
+	tips  = kingpin.Flag("tips", "Display detailed feature and usage tips on startup.").Bool()
 )
 
 // main is the entry point of the Prometheus CLI application.
@@ -55,6 +45,13 @@ func main() {
 	kingpin.HelpFlag.Short('h')
 	kingpin.Parse()
 
+	// Display welcome message and feature information if tips are enabled
+	if *tips {
+		printWelcomeMessage()
+	} else {
+		fmt.Println("Enter Prometheus queries. Press Ctrl+C to exit.")
+	}
+
 	// Initialize Prometheus client with user-provided configuration
 	if *debug {
 		fmt.Printf("Debug: Setting Prometheus URL to %s/api/v1\n", *url)
@@ -67,15 +64,15 @@ func main() {
 
 	// Load available metrics from Prometheus for autocompletion
 	fmt.Print("Loading metrics...")
-		metrics, err := prometheus.GetMetrics()
-		if err != nil {
-			if *debug {
-				fmt.Printf("\rError getting metrics: %v\n", err)
-			} else {
-				fmt.Printf("\rError getting metrics. Use --debug for more details.\n")
-			}
-			os.Exit(1)
+	metrics, err := prometheus.GetMetrics()
+	if err != nil {
+		if *debug {
+			fmt.Printf("\rError getting metrics: %v\n", err)
+		} else {
+			fmt.Printf("\rError getting metrics. Use --debug for more details.\n")
 		}
+		os.Exit(1)
+	}
 	fmt.Printf("\rLoaded %d metrics successfully.\n", len(metrics))
 
 	// Initialize the advanced autocompletion system
@@ -164,9 +161,6 @@ func main() {
 		}
 	}()
 
-	// Display welcome message and feature information
-	printWelcomeMessage()
-
 	// Run the main interactive query loop
 	runQueryLoop(l)
 }
@@ -178,18 +172,18 @@ func printWelcomeMessage() {
 	if *tips {
 		fmt.Println(`
 ✨ Features:
-  - 📊 Metric Names: Smart autocompletion for all available Prometheus metrics
-  - 🏷️  Label Names: Context-aware label suggestions when typing ` + "`metric{`" + `
-  - 💎 Label Values: Real-time label value suggestions with caching for performance
-  - ⚡ PromQL Expressions: Complete support for operators, built-in functions, time range selectors, and query modifiers
-  - 🔧 Context-Aware Suggestions: Intelligent suggestions based on cursor position and query context
-  - 🚀 Navigation Support: Tab completion with arrow key navigation for easy selection
+	 - Metric Names: Smart autocompletion for all available Prometheus metrics
+	 - Label Names: Context-aware label suggestions when typing "metric{"
+	 - Label Values: Real-time label value suggestions with caching for performance
+	 - PromQL Expressions: Complete support for operators, built-in functions, time range selectors, and query modifiers
+	 - Context-Aware Suggestions: Intelligent suggestions based on cursor position and query context
+	 - Navigation Support: Tab completion with arrow key navigation for easy selection
 
 💡 Tips:
-  - Type 'rat' + Tab → 'rate('
-  - After metric{} + Tab → operators and modifiers
-  - Inside functions + Tab → metrics
-  - After operators + Tab → metrics and functions
+	 - Type 'rat' + Tab -> 'rate('
+	 - After metric{} + Tab -> operators and modifiers
+	 - Inside functions + Tab -> metrics
+	 - After operators + Tab -> metrics and functions
 `)
 	}
 }
@@ -223,4 +217,4 @@ func runQueryLoop(l *readline.Instance) {
 
 		display.DisplayTable(results)
 	}
-}
+}

internal/display/table.go

@@ -63,6 +63,28 @@ func DisplayTable(results []prometheus.QueryResult) {
 	headers := append([]string{"Metric"}, labels...)
 	headers = append(headers, "Value")
 
+	// Limit the number of columns to display to avoid overly wide tables
+	maxColumns := 10 // Metric + 8 most important labels + Value
+
+	if len(headers) > maxColumns {
+		// Keep only the first few labels
+		labels = labels[:maxColumns-2] // -2 for Metric and Value columns
+		// Update headers accordingly
+		headers = append([]string{"Metric"}, labels...)
+		headers = append(headers, "Value")
+	}
+
+	// Truncate long headers to improve readability
+	maxHeaderLength := 20
+	displayHeaders := make([]string, len(headers))
+	for i, header := range headers {
+		if len(header) > maxHeaderLength {
+			displayHeaders[i] = header[:maxHeaderLength-3] + "..."
+		} else {
+			displayHeaders[i] = header
+		}
+	}
+
 	// Initialize table writer with stdout as destination
 	table := tablewriter.NewWriter(os.Stdout)
 
@@ -78,7 +100,13 @@ func DisplayTable(results []prometheus.QueryResult) {
 		// Fill in label values in the correct column positions
 		for i, label := range labels {
 			// Column index is i+1 because metric name is at index 0
-			row[i+1] = result.Metric[label]
+			value := result.Metric[label]
+			// Truncate long values
+			if len(value) > maxHeaderLength {
+				row[i+1] = value[:maxHeaderLength-3] + "..."
+			} else {
+				row[i+1] = value
+			}
 		}
 
 		// Extract and format the metric value
@@ -97,7 +125,7 @@ func DisplayTable(results []prometheus.QueryResult) {
 
 	// Configure and render the table
 	// Using Header() and Bulk() methods for automatic formatting with separators
-	table.Header(headers)
+	table.Header(displayHeaders)
 
 	if err := table.Bulk(rows); err != nil {
 		fmt.Printf("Error adding bulk data to table: %v\n", err)