feature: analyze with initFlags and fetch config file if non existent - PLUTO-1423 by franciscoovazevedo · Pull Request #153 · codacy/codacy-cli-v2

franciscoovazevedo · 2025-06-16T15:30:52Z

Add API Config Generation Support to Analyze Command

Summary

The analyze command now supports passing initFlags and can automatically generate tool configuration files from the Codacy API when running in remote mode, but only if configuration files do not already exist.

Changes

Enhanced analyze command: Now accepts API token and other init flags
Automatic config generation: When a tool lacks a config file and the CLI runs in remote mode with an API token, the system automatically fetches and creates the appropriate configuration from Codacy's API
Remote mode no longer fails: When running in remote mode, the analyze command will continue execution even when config files are missing, providing helpful guidance instead of failing

Behavior

Local mode: Shows helpful message to add config files manually
Remote mode without token: Shows config not found message
Remote mode with token: Automatically creates config files using Codacy API patterns and settings

Testing

Added comprehensive test coverage for all scenarios including edge cases, with tests properly isolated to avoid creating config files in the project directory.

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.34%	✅ 41.32%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`66c17c5`)	5539	1034	18.67%
Head commit (`4277073`)	5623 (+84)	1069 (+35)	19.01% (+0.34%)

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 (#153)	121	50	41.32%

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 enhances the analyze command to accept initialization flags, automatically generate missing tool config files from the Codacy API in remote mode, and adds unit and integration tests for the new behavior.

Analyze now supports initFlags (e.g. API token) and cloud mode flags.
Automatically fetches and writes tool config files when none exist and an API token is provided.
Adds coverage for local vs remote mode config checks in both unit and integration tests.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tools/eslintConfigCreator.go	Handle ESLint rules that don’t accept options by keeping only error level.
cmd/configsetup/setup.go	Add `CreateToolConfigurationFile` and tool-name-to-UUID lookup.
cmd/analyze.go	Wire in cloud flags, validate/generate config files, update `runTool` signature.
cmd/analyze_test.go	Unit tests for `checkIfConfigExistsAndIsNeeded` behavior.
cmd/analyze_integration_test.go	Integration tests for config existence and edge cases.

Comments suppressed due to low confidence (2)

cmd/configsetup/setup.go:512

[nitpick] Go style recommends capitalizing common acronyms: rename getToolUuidByName to getToolUUIDByName and use toolUUID for variable names.

func getToolUuidByName(toolName string) string {

cmd/analyze_test.go:283

There’s no assertion that a config file is actually created when running in remote mode with an API token. Add a test case or assertion after checkIfConfigExistsAndIsNeeded to verify the file exists at toolConfigFileName[toolName].

tests := []struct {

andrzej-janczak · 2025-06-17T11:06:35Z

+	"no-useless-escape":             true,
+	"no-with":                       true,
+	"require-yield":                 true,
+}


what's this ? 🤔
why moving eslint int this PR ?

there was a bug on eslint config creation. this is the fix of that bug.

I am definitely missing a context and knowledge here 😄the error was on main branch or where ?
Anyway I don't want to block, please make a fix in new PR next time 🙏

since i was testing this scenario, when i created a new config file from API it generated this error:
Error: Key "rules": Key "no-misleading-character-class": Value [{"allowEscape":false}] should NOT have more than 0 items.
this is a fix for that. i can remove this code and add it in a different PR, but since it is happening in main i thought it could simply go in this one!

sure, ok next time like I wrote ;)

andrzej-janczak · 2025-06-18T08:20:31Z

+	} else if err != nil {
+		return fmt.Errorf("Error checking config file for tool %s: %w", toolName, err)
+	} else {
+		fmt.Printf("Config file found for %s: %s\n", toolName, toolConfigPath)


[imporve]
This is normall situation, why print it for user ?
MAybe just file logger is enough

andrzej-janczak · 2025-06-18T08:27:47Z

Overall ok but for local mode this scenario does not work:

init (no flags)
delete revive config
analyze
Revive config is not created. I just see: Config file not found for tool revive: .codacy/tools-configs/revive.toml. Please add a config file to the tools-configs directory

Expected:
Revice tool config should be created for local mode

Maybe it would be great idea to add it test for it...

franciscoovazevedo · 2025-06-18T08:46:29Z

Overall ok but for local mode this scenario does not work:

init (no flags)

delete revive config

analyze

Revive config is not created. I just see: Config file not found for tool revive: .codacy/tools-configs/revive.toml. Please add a config file to the tools-configs directory

Expected: Revice tool config should be created for local mode

Maybe it would be great idea to add it test for it...

are we also fetching it in local mode? i thought this feature was only to remote. but sure, we can also cover that for local.

* Refactor: Centralize tool configuration file names into constants - Introduced a new constants package to store tool configuration file names, reducing duplication across the codebase. - Updated references in the analyze and config setup files to use the new constants for improved maintainability. - Adjusted tests to align with the new constants structure, ensuring consistency in tool configuration handling. * fix test

franciscoovazevedo force-pushed the pluto-1423-init-flags-analyze branch from 47ce922 to 16a52f7 Compare June 16, 2025 17:57

franciscoovazevedo marked this pull request as ready for review June 16, 2025 18:05

franciscoovazevedo requested a review from Copilot June 17, 2025 08:31

Copilot AI reviewed Jun 17, 2025

View reviewed changes

Comment thread cmd/analyze.go Outdated

Comment thread tools/eslintConfigCreator.go Outdated

Comment thread cmd/analyze.go Outdated

andrzej-janczak reviewed Jun 17, 2025

View reviewed changes

Comment thread cmd/analyze.go Outdated

andrzej-janczak reviewed Jun 17, 2025

View reviewed changes

franciscoovazevedo force-pushed the pluto-1423-init-flags-analyze branch from 2db4726 to f04aa4a Compare June 17, 2025 14:37

andrzej-janczak reviewed Jun 18, 2025

View reviewed changes

franciscoovazevedo force-pushed the pluto-1423-init-flags-analyze branch 4 times, most recently from a958ab0 to 7f5c327 Compare June 23, 2025 10:22

zhamborova approved these changes Jun 26, 2025

View reviewed changes

franciscoovazevedo and others added 11 commits June 30, 2025 09:47

analyze now receives initFlags and fetches config file if non existent

3f2c965

added test

aac40ff

code review changes

079cb60

fix test

f363fe3

fetching default configs in local mode

603108d

fixed test

d7d206f

fixing tests and adding logs

117cdab

fixing eslint tests

395b715

fixing pylint tests

56264ee

rebase

4277073

franciscoovazevedo force-pushed the pluto-1423-init-flags-analyze branch from 49b87fb to 4277073 Compare June 30, 2025 08:49

franciscoovazevedo merged commit 1c23a76 into main Jun 30, 2025
10 checks passed

franciscoovazevedo deleted the pluto-1423-init-flags-analyze branch June 30, 2025 09:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: analyze with initFlags and fetch config file if non existent - PLUTO-1423#153

feature: analyze with initFlags and fetch config file if non existent - PLUTO-1423#153
franciscoovazevedo merged 11 commits intomainfrom
pluto-1423-init-flags-analyze

franciscoovazevedo commented Jun 16, 2025 •

edited

Loading

Uh oh!

codacy-production Bot commented Jun 16, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andrzej-janczak Jun 17, 2025 •

edited

Loading

Uh oh!

franciscoovazevedo Jun 17, 2025

Uh oh!

andrzej-janczak Jun 17, 2025

Uh oh!

franciscoovazevedo Jun 17, 2025

Uh oh!

andrzej-janczak Jun 18, 2025 •

edited

Loading

Uh oh!

andrzej-janczak Jun 18, 2025

Uh oh!

andrzej-janczak commented Jun 18, 2025 •

edited

Loading

Uh oh!

franciscoovazevedo commented Jun 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

franciscoovazevedo commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add API Config Generation Support to Analyze Command

Summary

Changes

Behavior

Testing

Related

Uh oh!

codacy-production Bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage summary from Codacy

See diff coverage on Codacy

See your quality gate settings Change summary preferences

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andrzej-janczak Jun 17, 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!

franciscoovazevedo Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

andrzej-janczak Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

franciscoovazevedo Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

andrzej-janczak Jun 18, 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!

andrzej-janczak Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

franciscoovazevedo commented Jun 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

franciscoovazevedo commented Jun 16, 2025 •

edited

Loading

codacy-production Bot commented Jun 16, 2025 •

edited

Loading

andrzej-janczak Jun 17, 2025 •

edited

Loading

andrzej-janczak Jun 18, 2025 •

edited

Loading

andrzej-janczak commented Jun 18, 2025 •

edited

Loading