Feature/improve ux (#50)

* feature: improve starting from zero UX
* ux: update API token instructions in welcome message
* chore: update GitHub Actions workflow to initialize cli-v2 and remove Windows support
* feature: installation progress bar
* feature: enhance installation checks and user feedback
* refactor: update configuration handling and directory creation

Author: andrzej-janczak

.codacy/codacy.yaml

@@ -4,5 +4,5 @@ runtimes:
 tools:
     - [email protected]
     - [email protected]
-    - [email protected]
     - [email protected]
+    - [email protected]

.github/workflows/go.yml

@@ -54,7 +54,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest]
     steps:
       - name: Checkout
         uses: actions/checkout@v4

cli-v2.go

@@ -3,19 +3,34 @@ package main
 import (
 	"codacy/cli-v2/cmd"
 	"codacy/cli-v2/config"
-	cfg "codacy/cli-v2/config-file"
+	config_file "codacy/cli-v2/config-file"
 	"fmt"
 	"os"
 )
 
 func main() {
-	fmt.Println("Running original CLI functionality...")
-	// Original functionality
+	// Initialize config global object
 	config.Init()
 
-	configErr := cfg.ReadConfigFile(config.Config.ProjectConfigFile())
-	// whenever there is no configuration file, the only command allowed to run is the 'init'
-	if configErr != nil && len(os.Args) > 1 && os.Args[1] != "init" {
+	// This also setup the config global !
+	configErr := config_file.ReadConfigFile(config.Config.ProjectConfigFile())
+
+	// Show help if any argument contains help
+	for _, arg := range os.Args {
+		if arg == "--help" || arg == "-h" || arg == "help" {
+			cmd.Execute()
+			return
+		}
+	}
+
+	// Check if command is init
+	if len(os.Args) > 1 && os.Args[1] == "init" {
+		cmd.Execute()
+		return
+	}
+
+	// All other commands require a configuration file
+	if configErr != nil && len(os.Args) > 1 {
 		fmt.Println("No configuration file was found, execute init command first.")
 		return
 	}

cmd/init.go

@@ -29,8 +29,12 @@ var initCmd = &cobra.Command{
 	Short: "Bootstraps project configuration",
 	Long:  "Bootstraps project configuration, creates codacy configuration file",
 	Run: func(cmd *cobra.Command, args []string) {
+
+		config.Config.CreateLocalCodacyDir()
+
 		if len(codacyRepositoryToken) == 0 {
-			fmt.Println("No project token was specified, skipping fetch configurations ")
+			fmt.Println()
+			fmt.Println("ℹ️  No project token was specified, skipping fetch configurations")
 			noTools := []tools.Tool{}
 			err := createConfigurationFile(noTools)
 			if err != nil {
@@ -50,7 +54,13 @@ var initCmd = &cobra.Command{
 				log.Fatal(err)
 			}
 		}
-		fmt.Println("Run install command to install dependencies.")
+		fmt.Println()
+		fmt.Println("✅ Successfully initialized Codacy configuration!")
+		fmt.Println()
+		fmt.Println("🔧 Next steps:")
+		fmt.Println("  1. Run 'codacy-cli install' to install all dependencies")
+		fmt.Println("  2. Run 'codacy-cli analyze' to start analyzing your code")
+		fmt.Println()
 	},
 }
 
@@ -76,7 +86,7 @@ func configFileTemplate(tools []tools.Tool) string {
 	eslintVersion := "9.3.0"
 	trivyVersion := "0.59.1" // Latest stable version
 	pylintVersion := "3.3.6"
-
+	pmdVersion := "7.12.0"
 	for _, tool := range tools {
 		if tool.Uuid == "f8b29663-2cb2-498d-b923-a10c6a8c05cd" {
 			eslintVersion = tool.Version
@@ -96,7 +106,8 @@ tools:
     - eslint@%s
     - trivy@%s
     - pylint@%s
-`, eslintVersion, trivyVersion, pylintVersion)
+    - pmd@%s
+`, eslintVersion, trivyVersion, pylintVersion, pmdVersion)
 }
 
 func buildRepositoryConfigurationFiles(token string) error {

cmd/install.go

@@ -1,9 +1,17 @@
 package cmd
 
 import (
+	"codacy/cli-v2/config"
 	cfg "codacy/cli-v2/config"
+	config_file "codacy/cli-v2/config-file"
+	"fmt"
+	"io"
 	"log"
+	"os"
+	"time"
 
+	"github.com/fatih/color"
+	"github.com/schollz/progressbar/v3"
 	"github.com/spf13/cobra"
 )
 
@@ -19,8 +27,154 @@ var installCmd = &cobra.Command{
 	Short: "Installs the tools specified in the project's config-file.",
 	Long:  "Installs all runtimes and tools specified in the project's config-file file.",
 	Run: func(cmd *cobra.Command, args []string) {
-		installRuntimes(&cfg.Config)
-		installTools(&cfg.Config)
+		bold := color.New(color.Bold)
+		green := color.New(color.FgGreen)
+
+		// Create necessary directories
+		if err := config.Config.CreateCodacyDirs(); err != nil {
+			log.Fatal(err)
+		}
+
+		// Load config file
+		if err := config_file.ReadConfigFile(cfg.Config.ProjectConfigFile()); err != nil {
+			fmt.Println()
+			color.Red("⚠️  Warning: Could not find configuration file!")
+			fmt.Println("Please run 'codacy-cli init' first to create a configuration file.")
+			fmt.Println()
+			os.Exit(1)
+		}
+
+		// Check if anything needs to be installed
+		needsInstallation := false
+		for name, runtime := range cfg.Config.Runtimes() {
+			if !cfg.Config.IsRuntimeInstalled(name, runtime) {
+				needsInstallation = true
+				break
+			}
+		}
+		if !needsInstallation {
+			for name, tool := range cfg.Config.Tools() {
+				if !cfg.Config.IsToolInstalled(name, tool) {
+					needsInstallation = true
+					break
+				}
+			}
+		}
+
+		if !needsInstallation {
+			fmt.Println()
+			bold.Println("✅ All components are already installed!")
+			return
+		}
+
+		fmt.Println()
+		bold.Println("🚀 Starting installation process...")
+		fmt.Println()
+
+		// Calculate total items to install
+		totalItems := 0
+		for name, runtime := range cfg.Config.Runtimes() {
+			if !cfg.Config.IsRuntimeInstalled(name, runtime) {
+				totalItems++
+			}
+		}
+		for name, tool := range cfg.Config.Tools() {
+			if !cfg.Config.IsToolInstalled(name, tool) {
+				totalItems++
+			}
+		}
+
+		if totalItems == 0 {
+			fmt.Println()
+			bold.Println("✅ All components are already installed!")
+			return
+		}
+
+		// Print list of items to install
+		fmt.Println("📦 Items to install:")
+		for name, runtime := range cfg.Config.Runtimes() {
+			if !cfg.Config.IsRuntimeInstalled(name, runtime) {
+				fmt.Printf("  • Runtime: %s v%s\n", name, runtime.Version)
+			}
+		}
+		for name, tool := range cfg.Config.Tools() {
+			if !cfg.Config.IsToolInstalled(name, tool) {
+				fmt.Printf("  • Tool: %s v%s\n", name, tool.Version)
+			}
+		}
+		fmt.Println()
+
+		// Create a single progress bar for the entire installation
+		progressBar := progressbar.NewOptions(totalItems,
+			progressbar.OptionSetDescription("Installing components..."),
+			progressbar.OptionSetTheme(progressbar.Theme{
+				Saucer:        "█",
+				SaucerHead:    "█",
+				SaucerPadding: "░",
+				BarStart:      "│",
+				BarEnd:        "│",
+			}),
+			progressbar.OptionShowCount(),
+			progressbar.OptionShowIts(),
+			progressbar.OptionSetWidth(50),
+			progressbar.OptionThrottle(100*time.Millisecond),
+			progressbar.OptionSpinnerType(14),
+			progressbar.OptionFullWidth(),
+			progressbar.OptionSetRenderBlankState(true),
+			progressbar.OptionOnCompletion(func() {
+				fmt.Println()
+			}),
+		)
+
+		// Redirect all output to /dev/null during installation
+		oldStdout := os.Stdout
+		devNull, _ := os.Open(os.DevNull)
+		os.Stdout = devNull
+		log.SetOutput(io.Discard)
+
+		// Install runtimes first
+		for name, runtime := range cfg.Config.Runtimes() {
+			if !cfg.Config.IsRuntimeInstalled(name, runtime) {
+				progressBar.Describe(fmt.Sprintf("Installing runtime: %s v%s...", name, runtime.Version))
+				err := cfg.InstallRuntime(name, runtime)
+				if err != nil {
+					log.Fatal(err)
+				}
+				progressBar.Add(1)
+			}
+		}
+
+		// Install tools
+		for name, tool := range cfg.Config.Tools() {
+			if !cfg.Config.IsToolInstalled(name, tool) {
+				progressBar.Describe(fmt.Sprintf("Installing tool: %s v%s...", name, tool.Version))
+				err := cfg.InstallTool(name, tool)
+				if err != nil {
+					log.Fatal(err)
+				}
+				progressBar.Add(1)
+			}
+		}
+
+		// Restore output
+		os.Stdout = oldStdout
+		devNull.Close()
+		log.SetOutput(os.Stderr)
+
+		// Print completion status
+		fmt.Println()
+		for name, runtime := range cfg.Config.Runtimes() {
+			if !cfg.Config.IsRuntimeInstalled(name, runtime) {
+				green.Printf("  ✓ Runtime: %s v%s\n", name, runtime.Version)
+			}
+		}
+		for name, tool := range cfg.Config.Tools() {
+			if !cfg.Config.IsToolInstalled(name, tool) {
+				green.Printf("  ✓ Tool: %s v%s\n", name, tool.Version)
+			}
+		}
+		fmt.Println()
+		bold.Println("✅ Installation completed successfully!")
 	},
 }
 
@@ -37,4 +191,4 @@ func installTools(config *cfg.ConfigType) {
 	if err != nil {
 		log.Fatal(err)
 	}
-}
+}

cmd/root.go

@@ -4,14 +4,24 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 )
 
 var rootCmd = &cobra.Command{
 	Use:   "codacy-cli",
-	Short: "Codacy CLI",
-	Long:  "Code analysis",
+	Short: "Codacy CLI - A command line interface for Codacy",
+	Long:  ``,
 	Run: func(cmd *cobra.Command, args []string) {
+		// Check if .codacy directory exists
+		if _, err := os.Stat(".codacy"); os.IsNotExist(err) {
+			// Show welcome message if .codacy doesn't exist
+			showWelcomeMessage()
+			return
+		}
+
+		// If .codacy exists, show regular help
+		cmd.Help()
 	},
 }
 
@@ -21,3 +31,24 @@ func Execute() {
 		os.Exit(1)
 	}
 }
+
+func showWelcomeMessage() {
+	bold := color.New(color.Bold)
+	cyan := color.New(color.FgCyan)
+	yellow := color.New(color.FgYellow)
+
+	fmt.Println()
+	bold.Println("👋 Welcome to Codacy CLI!")
+	fmt.Println()
+	fmt.Println("This tool helps you analyze and maintain code quality in your projects.")
+	fmt.Println()
+	yellow.Println("To get started, you'll need a Codacy API token.")
+	fmt.Println("You can find your Project API token in Codacy under:")
+	fmt.Println("Project > Settings > Integrations > Repository API tokens")
+	fmt.Println()
+	cyan.Println("Initialize your project with:")
+	fmt.Println("  codacy-cli init --repository-token YOUR_TOKEN")
+	fmt.Println()
+	fmt.Println("Or run without a token to use local configuration:")
+	fmt.Println("  codacy-cli init")
+}