[3Pillar KDB] Plug-n-Play SonarQube for TS Projects

README.md

1. Start SonarQube via Docker

# in the folder with docker-compose.yml
docker-compose up -d

(wait until server successfully started)

2. Access SonarQube and change default (admin/admin) password

http://localhost:9000/

2. Run Jest with coverage enabled

jest --coverage --detectOpenHandles --forceExit

3. Tweak sonar-project.properties to match the correct paths

4. Install SonarQube Scanner

npm install sonarqube-scanner

5. Run SonarQube Scanner

node_modules/.bin/sonar-scanner -X # -X is for debug, it can be omitted

6. Navigate to SonarQube and observe new analysis

http://localhost:9000/

docker-compose.yml

version: '3'
services:
  sonarqube:
    container_name: sonarqube
    image: sonarqube:latest
    ports:
      - '9000:9000'
      - '9092:9092'

jest-config.js

module.exports = {
  // The directory where Jest should output its coverage files
  coverageDirectory: "coverage",

  // A list of reporter names that Jest uses when writing coverage reports
  coverageReporters: [
    // "json",
    // "text",
    "lcov",
    // "clover"
  ],

  preset: 'ts-jest'
};

sonar-project.properties

sonar.projectKey=<my-project-key>
sonar.projectName=<Project Name>
sonar.projectVersion=<version>
sonar.language=ts
sonar.scm.provide=git
sonar.sources=<path-to-src-folder>
sonar.sourceEncoding=UTF-8
sonar.exclusions=<path-to-src-folder>/**/*.tests.ts
sonar.test.inclusions=<path-to-src-folder>/**/*.tests.ts
sonar.login=admin
sonar.password=admin1
sonar.coverage.exclusions=src/**/*.tests.ts,src/**/*.mock.ts,node_modules/*,coverage/lcov-report/*
sonar.javascript.lcov.reportPaths=coverage/lcov.info