| Table of Contents |
|---|
Because we want to deliver software on As part of our commitment to delivering software at a professional level, we do care about emphasize the importance of code quality. The groovy To evaluate Groovy source code is evaluated by , CodeNarc tool is used. In Pricefx Studio, the code quality evaluation is supported by the CodeNarc plugin that is available in IDEA.
Setup
Install CodeNarc Plugin
| Info |
|---|
Make sure you install IDEA 2023 or later, since older versions work with older versions of CodeNarc plugin which was causing issues. |
If you have not installed CodeNarc yet, navigate to Preferences > Plugins > MarketPlace Marketplace > search for “codenarc” and press click Install. When asked, restart IDEA for the changes to take effect.
...
Add Code Quality Profile
...
to Project
For To ensure code quality, we are using the utilize IDEA's standard inspection functionality built-in IDEA. Due to the unique nature of Pricefx nature, some of the inspections are not relevant and are causing false alerts and some of them we would like to certain inspections can produce false alerts, but other inspections we encourage you to follow. Therefore To align with this, we have disabled some adjusted the inspection rules that are enabled by default and enabled some that are initially disabled and that’s how we created – some defaults are disabled, while others initially disabled are enabled. This approach has led us to create a standard Pricefx code quality profile with that encompasses the best rules we think to follow. The profile is copied most fitting rules.
To copy the profile with Pricefx inspections to IDEA and assigned assign it to the project during the action Add Framework Support:
Right-click on the root folder > Add Framework Support > check Pricefx > OK.
| Note |
|---|
If you don’t have the “Add Framework Support” option in the menu, remove the “Pricefx API” library first: Right click on the root folder > Open Module Settings > Libraries > Pricefx API (last in the list) > click [-] button above to remove this library > OK. |
You should be able to :
Make sure there is “pom.xml” file in the project, you can easily create it from Studio, seeCreate New Project
Open the “Maven” tool window (on the right side of the screen).
Click “Reload All Maven Projects” button.
You should then see the inspection profile “Pricefx Configuration” in : Preferences > Inspections > Profile.
...
Repeat this step for every Pricefx project you work withat.
| Info |
|---|
In case the you would you’d need to manually install the profile manually e.g. if there would be a newer version published, download it as XML file from https://developer.pricefx.eu/studio/codenarc/Pricefx_Configuration.xml and import using “Import Profile” from the popup menu it under the gear icon in Preferences > Inspections > Profile by selecting Import Profile from the popup menu. |
For more details see https://www.jetbrains.com/help/idea/customizing-profiles.html.
How To Use
Once the CodeNarc plugin is installed and the inspection profile is added to the your project, you can start checking the inspections IDEA is displaying.
Current File
...
in Editor
The IDE continuously checks your code and searches for problems. The widget in the top-right corner of the editor displays the number of problems of each severity detected in the current file:
...
Click the widget to open the list of problems on the Current File tab of the Problems tool window. You can also access the Problems tool window by selecting View > Tool Windows > Problems or by pressing CTRL+6 (Windows) or ⌘+6 (Mac).
The color stripe in the scrollbar also marks the detected code problems and helps you quickly access the corresponding lines without scrolling the file. Hover over a mark on the stripe to see the detected problem in a tooltip. Click a mark to jump to the corresponding line.
For details see https://www.jetbrains.com/help/idea/file-and-project-analysis.html.
Current File
...
in Problems Tool Window
When the design-time code inspection is enabled, this tab lists all code issues found in the current file. The list is updated as you switch between files in the editor.
...
To see more detailed information about the rule, right click on any problem > Inspection xxx options > Show Quick-Fixes > Edit inspection profile setting.
| Info |
|---|
Hint: Lot of the Many inspection problems can be solved by auto-formatting the code: Code > Reformat Code or by pressing Ctrl Ctrl+Alt+L (Windows) or ⌥ ⌘ L (Mac). |
| Info |
|---|
Hint: Some inspection problems can be solved by IDEA by pressing Alt+Enter (Windows) or ⌥ ↩ (Mac) on the problem. |
For details see https://www.jetbrains.com/help/idea/problems-tool-window.html#current-file.
Analyze the Whole Project
To get a list of all problems across a project, navigate to Code > Inspect Code > Analyze. The tool window Problems will open and you will get the a report with the problems, their count and occurrences:
...
See also: