insideapp-oss / sonar-flutter

SonarQube plugin for Flutter / Dart
Other
449 stars 82 forks source link

Misleading documentation #233

Open gerken-tss opened 2 months ago

gerken-tss commented 2 months ago

In the README.md in the paragraph, which is about preventing the plugin from overriding the existing linter rules, it is recommended to set this to true:

The plugin uses its own analysis options file. If analysis_options.yaml file already exists under the project root, it will be saved during the analysis and then restored to its initial state.

To disable this behavior and use the existinganalysis_options.yaml file instead, add the following line to sonar-project.properties file :

# Use existing options to perform the dart analyzer analysis
sonar.dart.analyzer.options.override=true

However, the description of the available options states:

By default, any local analysis_options.yaml is replaced for the analysis. This can be prevented by setting this to false.

So do I need to set it to true or false if I want my own existing file to be used?

Does replace indicate whether the existing is replaced by an empty file? Or the other way around? I am confused when I read this!

Also, it says that the default value is true so the part where it says that setting it to true changes some behavior is confusing as well.

gerken-tss commented 2 months ago

Maybe related to this? https://github.com/insideapp-oss/sonar-flutter/issues/180