Skip to content

Commit 4990589

Browse files
NephtysFabien Bézagu
authored andcommitted
Improve documentation
- install the project - run Sonar scanner manually with proper host
1 parent 22cb5da commit 4990589

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@ But it can be useful to prepare a test project to check the correct execution of
4242
## Installation
4343

4444
1. Clone the Git repository
45-
2. Run `yarn install` inside **eslint-plugin** directory
46-
3. Synchronize dependencies using Maven inside **sonar-plugin** directory
47-
4. You are good to go! 🚀
45+
1. Inside **eslint-plugin** directory, run `yarn install`
46+
1. Inside **sonar-plugin** directory, synchronize dependencies using Maven with `mvn clean install -DskipTests`
47+
1. Inside root directory, initialize docker with `docker compose up --build -d`
48+
1. You are good to go! 🚀
4849

4950
## Create a rule
5051

test-project/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Use the following Shell script which will do the job for you:
2828
Or you can manually run these commands:
2929

3030
- Install dependencies: `yarn install`
31-
- Start Sonar Scanner: `yarn sonar -Dsonar.token=MY_SONAR_TOKEN`
31+
- Start Sonar Scanner: `yarn sonar -Dsonar.host.url=http://127.0.0.1:9000 -Dsonar.token=MY_SONAR_TOKEN`
3232

3333
### 3. Check errors
3434

test-project/tool_send_to_sonar.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
yarn install
88

99
# sending to Sonar phase
10-
yarn sonar -Dsonar.host.url=http://0.0.0.0:9000 -Dsonar.token=$1
10+
yarn sonar -Dsonar.host.url=http://127.0.0.1:9000 -Dsonar.token=$1

0 commit comments

Comments
 (0)