Skip to content

Conversation

@soumeh01
Copy link
Collaborator

Changes

  • Migrated from code_climate to QLTY

@soumeh01 soumeh01 added the github_actions Pull requests that update GitHub Actions code label May 25, 2025
Copy link
Collaborator Author

@soumeh01 soumeh01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jreineckearm The basic results look promising, but we should have a discussion about the configuration settings, specifically

  • Which checks/plugins should be enabled?
  • What thresholds should be defined?

@soumeh01 soumeh01 marked this pull request as ready for review May 26, 2025 06:34
@soumeh01 soumeh01 requested a review from jreineckearm May 26, 2025 06:34
jreineckearm
jreineckearm previously approved these changes May 26, 2025
Copy link
Collaborator

@jreineckearm jreineckearm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Let's start with this set of settings. We may change though settings over time and based on experience. @omarArm , @thorstendb-ARM , please raise if reports for certain issues become more of a problem than a help.

Candidates to consider adding in future to improve code readability:

  • [smells.function_parameters]
  • [smells.nested_control_flow]
  • [smells.function_complexity]

@soumeh01
Copy link
Collaborator Author

Thanks! Let's start with this set of settings. We may change though settings over time and based on experience. @omarArm , @thorstendb-ARM , please raise if reports for certain issues become more of a problem than a help.

Candidates to consider adding in future to improve code readability:

  • [smells.function_parameters]
  • [smells.nested_control_flow]
  • [smells.function_complexity]

For your information, several configurations related to the ones mentioned can be controlled. For example:

[smells.function_parameters]
enabled = true            # Flags functions with too many parameters
threshold = 3             # Maximum number of function parameters

[smells.nested_control_flow]
enabled = true            # Would flag deeply nested control flow (e.g., many if/else)
threshold = 3             # Maximum number of nested control flow statements

[smells.file_complexity]
enabled = true            # Would flag files with high overall complexity
threshold = 5             # Deeply nested control structures like if or case

@jreineckearm
Copy link
Collaborator

For your information, several configurations related to the ones mentioned can be controlled. For example:

Nice, setting a threshold looks handy. Does qlty also support code annotations for ignoring specific pieces of code you know that they will break guards? Similar to what eslint has?

Copy link
Collaborator

@jreineckearm jreineckearm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates. Let's merge and refine after gathering some experience with it.

@soumeh01 soumeh01 merged commit 07817ad into main May 26, 2025
12 checks passed
@soumeh01 soumeh01 deleted the qlty_coverage_scan branch May 26, 2025 13:37
@soumeh01
Copy link
Collaborator Author

For your information, several configurations related to the ones mentioned can be controlled. For example:

Nice, setting a threshold looks handy. Does qlty also support code annotations for ignoring specific pieces of code you know that they will break guards? Similar to what eslint has?

Yes, to some extent we can achieve this with annotation. Lets work on that in other PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants