...
Case 1: “This rule is not applicable at all to my code” : Deactivate it from the model
| Info |
|---|
If you find that a Kiuwan rule does not make sense at all for your application, you should |
...
“deactivate” it. |
For example, there’s a common bad practice that is to allow the use of the back navigation button in a web application. It’s commonly accepted that you should “catch” the use of the back button and do not rely in browser.
...
Reasons to “silence” (or mute) those defects can be of very different nature. It could be that in some specific points the rule is not applicable, or might be false positives.
| Info |
|---|
In any case, you want to keep active the rule but discard those specific defects. Kiuwan provides the Mute Defect functionality to do it. |
You can fine tune this muting mechanism to suite your needs:
...
A very common scenario is when you are analyzing your code but you are obtaining defects in files that you cannot fix for whatever reason. Common reasons are because those files are “open source” , “generated code” or “third-party code”.
| Info |
|---|
You cannot modify |
...
the source code, but their defects are decreasing the indicators of your application. In those cases, you should exclude |
...
those files from the analysis. |
Does this mean to delete them from the source directory previously to run the analysis? Not at all, Kiuwan provides an “exclusion” mechanism by which you can tell Kiuwan what files should not be analyzed (individually or matched by regular expressions) o even what files should only be analyzed.
...
As far as possible, Kiuwan configures the rules with reasonable default parameters. But we cannot cover all the different possibilities, so Kiuwan provides a mechanism to customize rules’ behavior.
| Info |
|---|
If you find that a rule does not exactly cover your needs, please look at its configuration parameters. It's likely that you find how to instruct the rule to suite your needs. |
Depending of the rule, the customization level can be different, so you should always consult the rule documentation to know the customization level and tune its behavior according to your needs.
...