Skip to content

Commit 4ebf20d

Browse files
committed
README update
1 parent fe87748 commit 4ebf20d

File tree

2 files changed

+25
-20
lines changed

2 files changed

+25
-20
lines changed

.github/workflows/maven.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Java CI
1+
name: CI
22

33
on: [push]
44

README.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
![Java CI](https://github.com/insideapp-oss/sonar-flutter/workflows/Java%20CI/badge.svg)
2+
![Coverage](https://codecov.io/gh/insideapp-oss/sonar-flutter/branch/master/graph/badge.svg)
23

34
# SonarQube plugin for Flutter / Dart
45

@@ -59,19 +60,21 @@ Install sonar-scanner as explained in the official documentation.
5960

6061
Create a **sonar-project.properties** file at the root with this content :
6162

62-
# Project identification
63-
sonar.projectKey=flutter_rocks
64-
sonar.projectName=Flutter Rocks
65-
sonar.projectVersion=1.0
63+
```console
64+
# Project identification
65+
sonar.projectKey=flutter_rocks
66+
sonar.projectName=Flutter Rocks
67+
sonar.projectVersion=1.0
6668
67-
# Source code location.
68-
# Path is relative to the sonar-project.properties file. Defaults to .
69-
# Use commas to specify more than one folder.
70-
sonar.sources=lib
71-
sonar.tests=test
69+
# Source code location.
70+
# Path is relative to the sonar-project.properties file. Defaults to .
71+
# Use commas to specify more than one folder.
72+
sonar.sources=lib
73+
sonar.tests=test
7274
73-
# Encoding of the source code. Default is default system encoding.
74-
sonar.sourceEncoding=UTF-8
75+
# Encoding of the source code. Default is default system encoding.
76+
sonar.sourceEncoding=UTF-8
77+
```
7578

7679
*For a complete list of available options, please refer to the [SonarQube documentation](https://docs.sonarqube.org/latest/analysis/analysis-parameters/).*
7780

@@ -80,14 +83,16 @@ Create a **sonar-project.properties** file at the root with this content :
8083

8184
Use the following commands from the root folder to start an analysis:
8285

83-
# Download dependencies
84-
flutter pub get
85-
# Run tests
86-
flutter test --machine > tests.output
87-
# Compute coverage (--machine and --coverage cannot be run at once...)
88-
flutter test --coverage
89-
# Run the analysis and publish to the SonarQube server
90-
sonar-scanner
86+
```console
87+
# Download dependencies
88+
flutter pub get
89+
# Run tests
90+
flutter test --machine > tests.output
91+
# Compute coverage (--machine and --coverage cannot be run at once...)
92+
flutter test --coverage
93+
# Run the analysis and publish to the SonarQube server
94+
sonar-scanner
95+
```
9196

9297
## Contributing
9398

0 commit comments

Comments
 (0)