Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To ensure code quality, we utilize IDEA's standard inspection functionality. Due to the unique nature of Pricefx, certain inspections can produce false alerts, but other inspections we encourage you to follow. To align with this, we have adjusted the inspection rules – some defaults are disabled, while others initially disabled are enabled. This approach has led us to create a standard Pricefx code quality profile that encompasses the most fitting rules.

The profile is copied To copy the profile with Pricefx inspections to IDEA and assigned assign it to the project during the action Add Framework Support: right-click the root folder > Add Framework Support > check Pricefx > click OK.

Note

If you do not have the “Add Framework Support” option in the menu, remove the “Pricefx API” library first: right-click the root folder > Open Module Settings > Libraries > Pricefx API (last in the list) > click [-] button above to remove this library > OK.

You should :

  • 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 at.

Info

If you In case you’d need to 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 it using Import Profile from the popup menu 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.

...

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: Many inspection problems can be solved by auto-formatting the code: Code > Reformat Code or by pressing 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.

...