Add sonarqube support (#10)

* Add SonarQube

---------

Co-authored-by: yordan.ramchev <[email protected]>

Author: Yordan-Ramchev

index.ts

@@ -5,7 +5,7 @@ import * as path from 'node:path'
 
 import minimist from 'minimist'
 import prompts from 'prompts'
-import { red, green, bold } from 'kolorist'
+import { red, green, bold, yellow } from 'kolorist'
 
 import ejs from 'ejs'
 
@@ -104,6 +104,7 @@ async function init() {
       argv.pinia ??
       argv.tests ??
       argv.vitest ??
+      argv.sonarQube ??
       argv.cypress ??
       argv.nightwatch ??
       argv.playwright ??
@@ -126,6 +127,7 @@ async function init() {
     needsRouter?: boolean
     needsPinia?: boolean
     needsVitest?: boolean
+    needsSonarQube?: boolean
     needsE2eTesting?: false | 'cypress' | 'nightwatch' | 'playwright'
     needsEslint?: boolean
     needsPrettier?: boolean
@@ -224,6 +226,19 @@ async function init() {
           active: 'Yes',
           inactive: 'No'
         },
+        {
+          name: 'needsSonarQube',
+          type: (prev, values) => {
+            if (isFeatureFlagsUsed || !values.needsVitest) {
+              return null
+            }
+            return 'toggle'
+          },
+          message: 'Add SonarQube for code coverage?',
+          initial: false,
+          active: 'Yes',
+          inactive: 'No'
+        },
         {
           name: 'needsE2eTesting',
           type: () => (isFeatureFlagsUsed ? null : 'select'),
@@ -311,6 +326,7 @@ async function init() {
     needsRouter = argv.router,
     needsPinia = argv.pinia,
     needsVitest = argv.vitest || argv.tests,
+    needsSonarQube = argv.SneedsSonarQube,
     needsEslint = argv.eslint || argv['eslint-with-prettier'],
     needsPrettier = argv['eslint-with-prettier'],
     needsVueUse = argv.vueUse,
@@ -363,6 +379,9 @@ async function init() {
   if (needsVitest) {
     render('config/vitest')
   }
+  if (needsSonarQube) {
+    render('config/sonarQube')
+  }
   if (needsCypress) {
     render('config/cypress')
   }
@@ -520,8 +539,7 @@ async function init() {
       needsPlaywright,
       needsNightwatchCT,
       needsCypressCT,
-      needsEslint,
-      needsStorybook
+      needsEslint
     })
   )
 
@@ -539,6 +557,9 @@ async function init() {
   if (needsStorybook) {
     console.log(`  ${bold(green('npx storybook@latest init --builder vite'))}`)
   }
+  if (needsSonarQube) {
+    console.log(`  ${bold(yellow('Do not forget to update sonar-project.properties'))}`)
+  }
   console.log(`  ${bold(green(getCommand(packageManager, 'dev')))}`)
   console.log()
 }

pnpm-lock.yaml

@@ -0,0 +1,3 @@
+# TernJS port file
+coverage
+.scannerwork

template/config/sonarQube/_gitignore

@@ -0,0 +1,9 @@
+{
+  "scripts": {
+    "coverage": "vitest run --coverage",
+    "sonar": "npx sonar-scanner"
+  },
+  "devDependencies": {
+    "sonarqube-scanner": "^3.1.0"
+  }
+}

template/config/sonarQube/package.json

@@ -0,0 +1,7 @@
+sonar.projectKey=#Required
+sonar.sources=src/
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+sonar.exclusions=dist/**
+sonar.coverage.exclusions=**/*.test.*
+sonar.token=#Required
+host.url=http://localhost:9000

template/config/sonarQube/sonar-project.properties

@@ -0,0 +1,14 @@
+import { mergeConfig, defineConfig } from 'vite'
+import viteConfig from './vite.config'
+
+export default mergeConfig(
+  viteConfig,
+  defineConfig({
+    test: {
+      coverage: {
+        provider: 'v8', // or 'istanbul'
+        reporter: ['text', 'lcov', 'json', 'html']
+      }
+    }
+  })
+)