The latest CodeScene Cloud updates brought Directives and PM integration support for GitLab and YouTrack.
Directives: Granular Control at a Functional Level
Directives are a feature that allows for granular control at a functional level. Developers can now add source code comments instructing CodeScene to ignore specific code smells, providing you with more control than ever before.
As the clear majority of all code health findings are real problems, we encourage the careful use of directives. We have made sure that transparency remains a top priority so the virtual code review will include a non-blocking warning informing you about the use of directives in the code together with the impact, ensuring nothing flies under the radar.
Below are a few examples of how you can disable a functional level smell in your source code:
Ensure your rationale is documented for future reference as this helps all programmers coming after you understand the reasons for hiding a potential code smell. By adding this context, you can revisit the rationale and see if it still applies. The directive syntax lets you provide the rationale on the same line: E.g. // @CodeScene(disable-all) Rewrite next week (2023-11-24).
Integrate GitLab & YouTrack Costs and Issues into CodeScene
Our Project Management integration now supports GitLab and YouTrack. If you are on a Pro plan and use these tools, you can now visualize accumulated costs, trends by work type, and more, all directly in CodeScene.
The prerequisites as with other PM tools is that issue numbers are included/referenced in the commit messages or pull requests/branch names. You should also use labels and/or issue types to distinguish different kinds of work (e.g. Bugs, Features).
To enable the Project Management integration, navigate to the Project Configuration -> PM Data Integration.
Minor Findings for Subtle Code Changes
We have also introduced a new section dedicated to tracking and documenting code modifications that are too minor to impact the overall code health, but are still noteworthy. For example, adding a line to an extensive file might not cross the next code health threshold, yet it can be of interest.
