Skip to content

Commit 5ded16b

Browse files
author
SalmoJunior
committed
Change Sonar Runner references to Sonar Scanner on prerequisites session. Fix link to SonarQube, the old one was not working. Fix Markdown sintax on Readme file to improve readability and to work fine with GitHub's flavor of Markdown.
1 parent f7eae31 commit 5ded16b

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

README.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ In SonarQube under Quality Profiles the used Linter can be specified by selectin
2323
<img src="SwitchProfiles.png" alt="Set preferred profile (SwiftLint or Tailor) to default in SonarQube." width="100%"/>
2424
</p>
2525

26-
###Features
26+
### Features
2727

2828
| Feature | Supported | MacOS | Unix |
2929
|---------------|----------|:-----------:|:-----------:|
@@ -37,81 +37,80 @@ In SonarQube under Quality Profiles the used Linter can be specified by selectin
3737
| Code coverage |YES | Uses [slather](https://github.com/venmo/slather) | Not Supported|
3838

3939

40-
###Download
40+
### Download
4141

4242
Checkout the [Releases](https://github.com/Backelite/sonar-swift/releases) page.
4343

44-
###Launching an analysis
44+
### Launching an analysis
4545
If you use [Fastlane](https://fastlane.tools), please read [our Fastlane integration doc](docs/sonarqube-fastlane.md).
4646
Otherwise, run the ```run-sonar-swift.sh``` script from your Xcode project root folder
4747

48-
###Release history
48+
### Release history
4949

50-
####0.3.3
50+
#### 0.3.3
5151
- Updated run-sonar-swift.sh to support -usesonarscanner (for sonar-scanner instead of sonar-runner).
5252

53-
####0.3.2
53+
#### 0.3.2
5454
- SwiftLint 0.16.1 (75 rules now).
5555
- Fixed [Metric 'test_data' should not be computed by a Sensor](https://github.com/Backelite/sonar-swift/issues/61) with SonarQube 6.2
5656
- Fastlane documentation update by [mammuth](https://github.com/mammuth). See [PR 62](https://github.com/Backelite/sonar-swift/pull/62)
5757
- run-sonar-swift.sh fix by [TheSkwiggs](https://github.com/mammuth). See [PR 64](https://github.com/Backelite/sonar-swift/pull/64)
5858

59-
####0.3.1
59+
#### 0.3.1
6060
- Now falls back to sonar-scanner if sonar-runner is not installed (thanks to [MaikoHermans](https://github.com/MaikoHermans). See [PR 59](https://github.com/Backelite/sonar-swift/pull/59))
6161
- Ability to set *sonar.swift.appName*. Useful when basename is different from targeted scheme, or when slather fails with 'No product binary found' (thanks to [MaikoHermans](https://github.com/MaikoHermans). See [PR 58](https://github.com/Backelite/sonar-swift/pull/58))
6262
- Added a second linter: Tailor. Enables analysis of Swift code on linux. (thanks to [tzwickl](https://github.com/tzwickl) for the hard work. See [PR 51](https://github.com/Backelite/sonar-swift/pull/51))
6363

6464

65-
####0.3.0
65+
#### 0.3.0
6666
- SonarQube 6 support. Important : will work with SonarQube 5.x and above only. Will not work anymore with SonarQube 4.5.x anymore.
6767
- SwiftLint 0.13.1 support (49 rules now).
6868
- Desactivation of unit tests and coverage is now allowed. Use **run-sonar-swift.sh -nounittests** to do it.
6969

70-
####0.2.4
70+
#### 0.2.4
7171
- Analysis does not fail anymore when an unkwown issue is reported by SwiftLint. See [issue 35](https://github.com/Backelite/sonar-swift/issues/35)
7272
- Fastlane documentation (thanks to [viteinfinite](https://github.com/viteinfinite)). See [PR 33](https://github.com/Backelite/sonar-swift/pull/33)
7373
- Fixed Fastlane JUnit report support
7474
- SwiftLint 0.11.1 support
7575
- Better return code suppot for run-sonar-swift.sh
7676

77-
####0.2.3
77+
#### 0.2.3
7878
- Fixed Lizard Sensor wrong file path
7979

80-
####0.2.2
80+
#### 0.2.2
8181
- Added support for .xcodeproj only projects (thanks to [delannoyk](https://github.com/delannoyk))
8282
- Fix for Lizard Sensor to find indexed files (thanks to [gretzki](https://github.com/gretzki))
8383
- Got rid of confusion with commercial plugin in the update center
8484

85-
####0.2.1
85+
#### 0.2.1
8686
- SwiftLint 0.8 support (new rules added).
8787

88-
####0.2.0
88+
#### 0.2.0
8989
- Lizard complexity report support (thanks to [akshaysyaduvanshi](https://github.com/akshaysyaduvanshi))
9090

91-
####0.1.2
91+
#### 0.1.2
9292
- SwiftLint 0.5.1 support (new rules added).
9393
- Added *sonar.swift.simulator* key in *sonar-project.properties* to select destination simulator for running tests
9494
- SwiftLint scans source directories only
9595

96-
####0.1.1
96+
#### 0.1.1
9797
- SwiftLint 0.4.0 support (new rules added).
9898

99-
####0.1.0
99+
#### 0.1.0
100100
- Initial release.
101101

102102

103-
104-
###Prerequisites
103+
### Prerequisites
105104

106105
- a Mac with Xcode 7 or +
107-
- [SonarQube](http://docs.codehaus.org/display/SONAR/Setup+and+Upgrade) and [SonarQube Runner](http://docs.codehaus.org/display/SONAR/Installing+and+Configuring+SonarQube+Runner) installed ([HomeBrew](http://brew.sh) installed and ```brew install sonar-runner```)
106+
- [SonarQube](https://docs.sonarqube.org/display/SONAR/Setup+and+Upgrade) and [SonarQube Scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner)
108107
- [xcpretty](https://github.com/supermarin/xcpretty) (see instructions below)
109108
- [SwiftLint](https://github.com/realm/SwiftLint) ([HomeBrew](http://brew.sh) installed and ```brew install swiftlint```). Version 0.3.0 or above.
110109
- [Tailor](https://github.com/sleekbyte/tailor) ([HomeBrew](http://brew.sh) installed and ```brew install tailor```). Version 0.11.1 or above.
111110
- [slather](https://github.com/SlatherOrg/slather) (```gem install slather```). Version 2.1.0 or above.
112111
- [lizard](https://github.com/terryyin/lizard) ([PIP](https://pip.pypa.io/en/stable/installing/) installed and ```sudo pip install lizard```)
113112

114-
###Installation of xcpretty with JUnit reports fix
113+
### Installation of xcpretty with JUnit reports fix
115114

116115
At the time, xcpretty needs to be fixed to work with SonarQube.
117116

@@ -123,29 +122,29 @@ To install the fixed version, follow those steps :
123122
gem build xcpretty.gemspec
124123
sudo gem install --both xcpretty-0.2.2.gem
125124

126-
###Installation (once for all your Swift projects)
125+
### Installation (once for all your Swift projects)
127126
- Download the plugin binary into the $SONARQUBE_HOME/extensions/plugins directory
128127
- Copy [run-sonar-swift.sh](https://rawgithub.com/Backelite/sonar-swift/master/src/main/shell/run-sonar-swift.sh) somewhere in your PATH
129128
- Restart the SonarQube server.
130129

131-
###Configuration (once per project)
130+
### Configuration (once per project)
132131
- Copy [sonar-project.properties](https://raw.githubusercontent.com/Backelite/sonar-swift/master/sonar-project.properties) in your Xcode project root folder (along your .xcodeproj file)
133132
- Edit the ```sonar-project.properties``` file to match your Xcode iOS/MacOS project
134133

135134
**The good news is that you don't have to modify your Xcode project to enable SonarQube!**. Ok, there might be one needed modification if you don't have a specific scheme for your test target, but that's all.
136135

137-
###Update (once per plugin update)
136+
### Update (once per plugin update)
138137
- Install the lastest plugin version
139138
- Copy ```run-sonar-swift.sh``` somewhere in your PATH
140139

141140
If you still have *run-sonar-swift.sh* file in each of your project (not recommended), you will need to update all those files.
142141

143-
###Contributing
142+
### Contributing
144143

145144
Feel free to contribute to this plugin by issuing pull requests to this repository.
146145

147146
When creating a pull request: always create it for the *develop* branch.
148147

149-
###License
148+
### License
150149

151150
SonarQube Plugin for Swift is released under the [GNU LGPL 3 license](http://www.gnu.org/licenses/lgpl.txt).

0 commit comments

Comments
 (0)