Feature: sonarqube를 세팅한다 (#46)

* feat: sonarqube를 세팅한다

* feat: sonarqube 스크립트를 추가한다

* refactor: 사용하지 않는 스크립트를 제거한다

* docs: 오타 제거 및 미사용 파일을 제거한다

* chore: sonarqube관련 스크립트를 추가한다

* doccs: sonar qube문서를 업데이트한다

* refactor: `settings.json`을 제거한다

* docs: Sonarqube README를 업데이트한다

package.json

@@ -28,7 +28,9 @@
     "update-version": "run-script-os",
     "update-version:win32": "bash update_version.sh",
     "update-version:default": "./update_version.sh",
-    "package": "pnpm i && pnpm clean && pnpm build && pnpm zip"
+    "package": "pnpm i && pnpm clean && pnpm build && pnpm zip",
+    "sonarqube": "./scripts/run-sonarqube.sh",
+    "sonarqube-scan": "./scripts/run-sonarscanner.sh"
   },
   "files": [
     "dist"

scripts/README.md

@@ -0,0 +1,20 @@
+# Sonarqube
+## 1. Sonarqube 설치 및 실행
+1. [SonarQube Developer Edition](https://www.sonarsource.com/products/sonarqube/downloads/success-download-developer-edition/)으로 설치하면 됩니다.
+2. `$ pnpm run sonarqube`
+    - 만약 권한 오류가 뜬다면, `$chmod 755 *.sh`로 모든 shell파일에 대해 권한을 열어주세요.
+    - 실행이 완료되면, `localhost:9000`으로 접속할 수 있습니다.
+
+## 2. Sonarqube 프로젝트 생성
+1. 프로젝트명은 `web-memo`이며, local에서 사용할 수 있도록 프로젝트를 생성합니다.
+2. 생성된 프로젝트의 토큰을 복사합니다.(3번에서 사용합니다)
+
+## 2. Sonarqube scanner 실행을 위한 전역 변수 설정
+1. `$ vi /etc/profile`
+2. 마지막 줄에 `export SONAR_TOKEN=2번에서 복사한토큰` 입력
+    - `:wq!`로 덮어쓰기를 해야 저장이 됩니다.
+3. `$ source /etc/profile`
+
+## 3. Sonarqube Scanner 실행
+1. `$ pnpm run sonarqube-scan`
+    - 만약 에러가 난다면, sonarqube를 정상적으로 실행했고, 로그인을 했고, 프로젝트 등록을 했는지 확인해주세요.

scripts/run-sonarqube.sh

@@ -0,0 +1 @@
+docker run -d -p 9000:9000 sonarqube

scripts/run-sonarscanner.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+token=$SONAR_TOKEN
+url="http://localhost:9000"
+project="web-memo"
+
+docker run \
+    --rm \
+    --net host \
+    -e SONAR_HOST_URL=$url \
+    -v ${PWD}:/usr/src \
+    sonarsource/sonar-scanner-cli \
+    --debug \
+    -Dsonar.projectKey=$project \
+    -Dsonar.sonar.sourceEncoding=UTF-8 \
+    -Dsonar.sonar.host.url=$url \
+    -Dsonar.sources=/usr/src \
+    -Dsonar.login=$token