Blog

Sneak-Peek: IDE Integration for CodeScene!

Written by CodeScene Team | Feb 13, 2023 3:37:46 PM

At CodeScene we are proud to announce that we're launching an IDE integration, offering Code Health feedback in real-time. You'll get recommendations and suggested improvements directly in your editor, helping you to deliver maintainable code and foresee problems. The best part? It's free. Let's dig in and have a look at it.

 

 

Looking out for your Code Health - Powerful sidekick in your daily work 

 

Our main goal at CodeScene is to empower developers to write better code by reducing any accidental complexity. Until now, our main feedback loop has been the Automated Code Reviews in Pull Requests. There, we inspect new and modified code to make sure it's healthy. The PR Integration has been one of our most popular features with teams using it as (soft) quality gates. Yet, let's face it: a PR is pretty late in the development process. The code is already written, and you've mentally moved ahead to think about the next task.

 

Enter CodeScene's IDE integration.  With this new CodeScene Sidekick, we bring the Code Health analysis into your VS Code editor. Automatically detect God Functions, Complex Methods, files with Low Cohesion, various complexity patterns like the Bumpy Road code smell, and roughly ~20 additional code health issues. We'll explain more about the Code Health concept in a minute, but let's first take a tour of the supported environment and languages.

 

 

 

Key features of the CodeScene IDE Tool

 

 

1# Code Health Metrics for all major Programming Languages - and some more 


We support all the languages in the full coding product, which means all the popular ones from Java, C#, C, C++, Python, JavaScript to Go - and then some more. 

Words are good, but a preview is even better. So, drums, please! 🥁 Let's have a look at the demo that we've prepared for you.

 

 

 

 

 

2# Instant Feedback as you code

 

In the preceding video, we have a function with two separate issues: a Complex Methods -- high cyclomatic complexity -- as well as  the infamous Bumpy Road code smell.. Understanding this code will be a complex task due to its accidental complexity, meaning it slows down your development productivity and leads to excess maintenance efforts. This is something we want to avoid. 

 

The IDE integration provides this information up front as you read existing code. When you chose to refactor, the IDE verifies that the issue is resolved. No need to wait for a PR review. 

 

In the video above, we've identified some parts of the code which would be better of encapsulated in a separate function. It's a simple refactoring, so would it be enough to reduce the complexity and get rid of the issues? Yes, as showed in the video, it did help.  

 

 

3# Looking out for your code health  

 

CodeScene's Code Health metric helps you maintain a sustainable, healthy codebase. So what metrics are CodeScene considering and why are they important? 

 

The high-level concept for Code Health, an aggregated metric predicting risks and waste.

 

 

Code Health is an aggregated metric based on 25+ factors scanned from the source code. The code health factors correlate with increased maintenance costs and an increased risk for defects. In this blog post we explore how code health concept supports both developers and technical leaders with a continuous feedback loop for engineering decisions based on data. 

 

  • The Code Health information tends to be at a higher level than what you usually get from linting tools.
  • The Code Health metric is the only code quality measure with a proven impact on Time-In-Development and Defects. This means you can use your Code Health measures to make the business case for larger refactorings, too.  For further details on the business impact of code health, read our Code Red whitepaper.

All of this is available for free in the CodeScene IDE plugin.

 

 

4# Get the Free VS Code Plugin

 

If we now go back to our IDE and sum it up with one thing for you to remember: The IDE will be available for the VS Code Editor to begin with, and what we are most proud of, is that it will be free of charge. You'll simply download it and install it on your own device. Hopefully you've signed up for the release notification!