Skip to content

Instantly share code, notes, and snippets.

@Tanapruk
Created May 28, 2018 08:20
Show Gist options
  • Save Tanapruk/662d4fc761d12c87bad62cc883aab533 to your computer and use it in GitHub Desktop.
Save Tanapruk/662d4fc761d12c87bad62cc883aab533 to your computer and use it in GitHub Desktop.
Sonarqube Setup Guides for Typescript/Javascript
#SonarQube
## Requirements
* Your project - Your codes that you want to analyse
* SonarQube Server - Place where analysis result will stay. You need to deploy it.
* SonarQube Scanner - the analyser. Install by `brew install sonar-scanner`.
## Configurations
* create `sonar-project.properties` and put it at the root.
Example of the file is as belows:
```
# must be unique in a given SonarQube instance
sonar.projectKey=my:project
# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
sonar.projectName=My project
sonar.projectVersion=1.0
# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
# This property is optional if sonar.modules is set.
sonar.sources=.
# Encoding of the source code. Default is default system encoding
#sonar.sourceEncoding=UTF-8
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment