You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ You can also add additional tasks to run linters and produce reports. Theses tas
34
34
35
35
In order to let Sonar analyze your project, you have to provide some configuration. You can define a file named sonar-project.properties at the root of your project with the following information:
36
36
37
-
```
37
+
```ini
38
38
# Required metadata
39
39
sonar.projectKey=<unique key for your project>
40
40
sonar.projectName=<human readable name for your project>
@@ -53,7 +53,7 @@ sonar.sourceEncoding=UTF-8
53
53
54
54
Example:
55
55
56
-
```
56
+
```ini
57
57
# Required metadata
58
58
sonar.projectKey=my-project
59
59
sonar.projectName=My Project Name
@@ -158,7 +158,7 @@ Same as above, the widget separates the count of duplicated code by language.
158
158
159
159
You can change the path to every generated report directly in your sonar.properties file by adding the following properties:
For indicating that reports are not found, the plugin logs a warning. This warning is useful when setting up your project to know if something is misconfigured. You can disable these logs using the following property in your sonar-project.properties:
204
204
205
-
```
205
+
```ini
206
206
sonar.sii.logs.report.missing.skip=true
207
207
```
208
208
209
209
#### Do not fail if a source file is missing
210
210
211
211
By default, in order to keep coherence, the analysis done by the plugin will fail if the generated report has an entry on a file that doesn't exist. Even if it is not recommended, you can disable the failure by using the one of the following properties in your sonar-project.properties:
212
212
213
-
```
213
+
```ini
214
214
# set to false to disable missing source file while analyzing code quality
215
215
sonar.sii.quality.js.file.missing.fail=false
216
216
sonar.sii.quality.scss.file.missing.fail=false
@@ -240,7 +240,7 @@ By default, the plugin also store information about the file (number of lines, n
240
240
241
241
Sonar doesn't allow two plugins to store the same information. So if you are using another plugin that also store this information, the second plugin analysis will fail. By default our plugin doesn't override information stored by another plugin. But we can't force plugin execution order. So it may happen that our plugin is run before the other one. That's why we provide the way to explicitly tell our plugin to not store file information. To do this, use the following properties in your sonar-project.properties:
0 commit comments