Feature/improve ux #50

andrzej-janczak · 2025-04-02T09:07:30Z

When there is no config dir Then welcome message is shown.

When there is BUT there is no command specified (codacy-cli) Then --help is shown

❯ go run cli-v2.go

👋 Welcome to Codacy CLI!

This tool helps you analyze and maintain code quality in your projects.

To get started, you'll need a Codacy API token.
You can find your Project API token in Codacy under:
Project > Settings > Integrations > Repository API tokens

Initialize your project with:
  codacy-cli init --repository-token YOUR_TOKEN

Or run without a token to use local configuration:
  codacy-cli init

Also add progees bar 🚀

🚀 Starting installation process...

📦 Items to install:
  • Runtime: node v22.2.0
  • Runtime: python v3.11.11
  • Tool: eslint v9.3.0
  • Tool: trivy v0.60.0
  • Tool: pylint v3.3.6

Installing tool: pylint v3.3.6... 100% │████████████│ (5/5, 11 it/min)                                                                                       

✅ Installation completed successfully!

codacy-production · 2025-04-02T09:52:10Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ -2.57%	✅ 0.00%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`8bc9720`)	1819	494	27.16%
Head commit (`7ecc4f8`)	2009 (+190)	494 (+0)	24.59% (-2.57%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#50)	227	0	0.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

Copilot

Pull Request Overview

This PR improves the CLI’s user experience by displaying a welcome message when no configuration directory exists, providing enhanced help text when configuration is present, and incorporating a progress bar during installations. It also updates workflow configurations and cleans up output messages.

Enhanced installation output and logging in the installer functions.
Improved CLI commands with a welcome message and detailed help text.
Updated CI workflow to reflect current supported OS environments.

Reviewed Changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
config/tools-installer.go	Added installation progress messages for each tool.
config/runtimes-installer.go	Commented out log messages for runtime downloads and extraction.
cmd/root.go	Enhanced CLI descriptions and added a welcome message function.
cmd/install.go	Introduced a progress bar for overall installation process.
cmd/init.go	Initiated configuration bootstrapping before token checks.
cli-v2.go	Removed legacy CLI functionality and simplified main flow.
.github/workflows/go.yml	Updated the CI workflow to exclude Windows and adjust build steps.

Files not reviewed (1)

go.mod: Language not supported

Comments suppressed due to low confidence (1)

cmd/install.go:68

Verify that progressbar.OptionShowIts() is a valid option for the progressbar library; if it is not, consider removing or replacing it to ensure the progress bar behaves as expected.

progressbar.OptionShowIts(),

machadoit · 2025-04-02T10:51:32Z

cmd/install.go

+		green := color.New(color.FgGreen)
+
+		// Initialize config
+		cfg.Init()


Do we want the init as part of the install? I think as it is, probably a bad ideia. As it will not have the token on the install command and will override the versions with CLI defaults instead of what the user has access no?

Maybe sooner than later, we need to have the 'init' mechanism to store the token or something, that would be able to be used during the steps? Whatever usually CLIs like gh or wtv, that you stay 'logged in' and don't need to pass a token to every command

this is Config object init, not cli init.
we were already doing it in main: https://github.com/codacy/codacy-cli-v2/pull/50/files#diff-5255824def31d434b7b0cd0d5befdda5e376565f53423f2f821844522fda4d46L11-L14

For now we can rename it or smth. In future refactor...

Then I am a bit confused. Is something needed for all the commands? If so, you need to remove it from main and add it all commands?

Can you explain me why we need to remove it from main, and why some commands need it and others not?

manufacturist · 2025-04-02T11:09:57Z

cmd/root.go

+	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")


I think we should use API token instead of Codacy API token. And then also expose the possibility of doing it with account API tokens as well, and specifying the URL directly.

This variant would be faster and more user friendly. To my understanding, it works with both types of API tokens, right?

Yeah, I also was thinking just go with "general" API token, not the project one.
Just for simplicity now and create more limited token in Future. I think the IDE plugin is using API token anway....
wdyt @machadoit

Anyway this will be resolved in another PR - this one is more UI specfifc - there is another Task for making setup flow easier

API token instead of Codacy API token

Sorry what? 😅 Now it works with repository-token, and you are talking about the Account API token correct?

Yeah, if it is a requirement for the MCP, we can add a task to add support for it (but agree that is out of scope of this PR)

Created https://codacy.atlassian.net/browse/PLUTO-1379 for the follow up, please take a look @andrzej-janczak @manufacturist

manufacturist · 2025-04-02T11:12:10Z

cmd/root.go

+	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")


The --repository-token option is not specified in the README.md. Would this be a part of the scope of this improvement, or will it be treated within https://codacy.atlassian.net/browse/PLUTO-1376 ?

The thing missing is not just the --repository-token but the full init command and its options. Can be either here or later, as @andrzej-janczak prefer. (I will add the note on the task anyway)

… Windows support

- Removed configuration file check from main function, allowing direct command execution. - Improved installation command to include detailed logging for tool installation progress. - Added user-friendly messages during the installation process to indicate success and failures.

- Added functions to verify if runtimes and tools are already installed. - Improved installation process to skip already installed components and provide user-friendly messages. - Updated Codacy configuration to use the latest version of Trivy.

- Renamed `codacyDirectory` to `globalCacheDirectory` for clarity. - Updated methods to create necessary directories during initialization and installation. - Removed the old directory creation function in favor of a more streamlined approach.

machadoit · 2025-04-02T16:21:36Z

.github/workflows/go.yml

      - name: Install dependencies from .codacy/codacy.yaml
        run: |
          go build ./cli-v2.go
+          ./cli-v2 init


Actually can we do it without the init on the CI? The init is something that should be done 'once' and locally, and committed

machadoit · 2025-04-02T16:23:19Z

cmd/init.go

 	Short: "Bootstraps project configuration",
 	Long:  "Bootstraps project configuration, creates codacy configuration file",
 	Run: func(cmd *cobra.Command, args []string) {
+		// Initialize configuration without creating directories


Would remove the comment. As we create the .codacy folder as part of it

machadoit

Maybe I am missing a couple things, but would like to go over them tomorrow

machadoit · 2025-04-02T16:24:12Z

cmd/init.go

 			if err != nil {
 				log.Fatal(err)
 			}
-			err = buildRepositoryConfigurationFiles(codacyRepositoryToken)


Why are we removing the repository configuration files with token option? 🤔 I guess we are moving it to the install? That seems strange / wrong. As the token should also be used to fetch the correct versions of runtimes and tools, no?

Can we make this as it was on the scope of this improvements / refactors?

machadoit · 2025-04-02T16:29:43Z

cmd/init.go

-var codacyRepositoryToken string
-
 func init() {
 	initCmd.Flags().StringVar(&codacyRepositoryToken, "repository-token", "", "optional codacy repository token, if defined configurations will be fetched from codacy")


actually something seems a bit off, we removed the var, but still exists here? 🤔

machadoit · 2025-04-02T16:30:21Z

cmd/install.go


 func init() {
 	installCmd.Flags().StringVarP(&registry, "registry", "r", "", "Registry to use for installing tools")
+	installCmd.Flags().StringVar(&codacyRepositoryToken, "repository-token", "", "Codacy repository token for fetching tool configurations")


I don't even see where this is used during installation, maybe it should be removed?

machadoit · 2025-04-02T16:32:54Z

cmd/root.go

+It provides functionality for code analysis, configuration management,
+and integration with Codacy's services.
+
+To get started, try running one of these commands:


This is to show when? Maybe this block can be removed, as the CLI already shows the available commands on the help?

when run witout args go run cli-v2.go (codacy-cli)
AND when you have codacy yaml file

Yeah, this part is redundant with help so removing it

- Added informative messages to guide users when no project token is specified. - Included next steps for users after successful initialization of Codacy configuration.

machadoit · 2025-04-03T09:10:26Z

cmd/root.go

-	Short: "Codacy CLI",
-	Long:  "Code analysis",
+	Short: "Codacy CLI - A command line interface for Codacy",
+	Long:  ``,


This is what? An empty line or?

machadoit

LGTM!

* 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

andrzej-janczak force-pushed the feature/improve-ux branch from be987e2 to d02017f Compare April 2, 2025 09:23

andrzej-janczak requested a review from Copilot April 2, 2025 10:23

Copilot AI reviewed Apr 2, 2025

View reviewed changes

machadoit reviewed Apr 2, 2025

View reviewed changes

manufacturist reviewed Apr 2, 2025

View reviewed changes

andrzej-janczak added 6 commits April 2, 2025 13:37

feature: improve starting from zero UX

e0681d3

fix: update API token instructions in welcome message

43d9262

chore: update GitHub Actions workflow to initialize cli-v2 and remove…

89c81c3

… Windows support

feature: installation progress bar

1749745

andrzej-janczak force-pushed the feature/improve-ux branch from 0835afe to 8aed5d8 Compare April 2, 2025 11:38

andrzej-janczak added 3 commits April 2, 2025 16:21

refactor: make config.init not create files

d99271c

fix: in main add parsing of file again

9a9d488

andrzej-janczak enabled auto-merge (squash) April 2, 2025 15:11

machadoit reviewed Apr 2, 2025

View reviewed changes

andrzej-janczak added 4 commits April 3, 2025 10:18

allow for showing help without codacy conf

359d205

review fixes

bebd563

refactor: remove long description from root command

a3efa99

feat: enhance user feedback during initialization

7ecc4f8

- Added informative messages to guide users when no project token is specified. - Included next steps for users after successful initialization of Codacy configuration.

machadoit reviewed Apr 3, 2025

View reviewed changes

machadoit approved these changes Apr 3, 2025

View reviewed changes

andrzej-janczak merged commit 096db1b into main Apr 3, 2025
7 checks passed

alerizzo deleted the feature/improve-ux branch June 3, 2025 09:45

Feature/improve ux #50

Feature/improve ux #50

Uh oh!

Conversation

andrzej-janczak commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codacy-production bot commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage summary from Codacy

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

machadoit Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

machadoit left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

machadoit left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

andrzej-janczak commented Apr 2, 2025 •

edited

Loading

codacy-production bot commented Apr 2, 2025 •

edited

Loading

machadoit Apr 2, 2025 •

edited

Loading