SonarQube — это платформа с открытым исходным кодом, разработанная SonarSource для непрерывной проверки качества кода. Sonar выполняет статический анализ кода, который предоставляет подробный отчет об ошибках, запахах кода, уязвимостях и дублировании кода. Он поддерживает множество языков благодаря встроенным наборам правил, а также может быть расширен с помощью различных плагинов.
В этой статье мы опишем, как настроить плагин sonarqube для проекта javascript.
Предпосылки:
Единственным предварительным условием для запуска SonarQube является наличие установленной Java (Oracle JRE 11 или OpenJDK 11) на вашем компьютере. ("Детали")
Установите системную переменную PATH: https://www.java.com/en/download/help/path.xml
Примечание. Для анализа кода JavaScript на машине, на которой выполняется сканирование, должен быть установлен Node.js ›= 8. Если стандартный
node
недоступен, вы должны установить для свойстваsonar.nodejs.executable
абсолютный путь к исполняемому файлу Node.js. ("Детали")
Загружает Sonarqube и Sonar Scanner:
- LTS-версия сонаркуба (https://www.sonarqube.org/downloads/)
- Скачать сонар-сканер для вашей платформы (https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/)
Настройка Sonarqube и Sonar Scanner:
- Добавьте путь к папке bin сканера сонара в переменные среды. Пример: C:\sonarQube\sonar-scanner-4.2.0.1873-windows\bin
- Настройте файл sonar-scanner.properties: (C:\sonarQube\sonar-scanner-4.2.0.1873-windows\conf)
Откройте файл sonar-scanner.properties и отредактируйте требуемую конфигурацию по вашему выбору, по умолчанию они будут прокомментированы. Ниже приведен пример сервера по умолчанию на локальном компьютере:
3. Создайте файл sonar-project.properties в корневой папке вашего проекта:
Настройте свойства projectKey, projectName, projectVersion, sources, как показано ниже. projectKey может быть любой уникальной строкой.
4. Обновите путь java SDK в файле wrapper.conf: (Расположение файла: C:\sonarQube\sonarqube-8.2.0.32929\sonarqube-8.2.0.32929\conf)
Откройте файл wrapper.conf и замените значение по умолчанию wrapper.java.command на путь к java SDK. Пример:
Запустите сервер Sonarqube и сканер Sonar:
- Чтобы запустить сонар-сервер, откройте cmd или терминал и перейдите по пути к папке sonarqube bin: (C:\sonarQube\sonarqube-8.2.0.32929\bin), выберите платформу и запустите команду запуска. Примеры :
Для Windows (командная строка): C:\sonarQube\sonarqube-8.2.0.32929\bin\windows-x86–64›StartSonar.bat
Для Mac (терминал): C:\sonarQube\sonarqube-8.2.0.32929\bin\macosx-universal-64›sonar.sh
2. Теперь откройте командную строку или терминал и перейдите в корневую папку вашего проекта, где находится файл sonar-project.properties, и выполните команду: ‹путь к корневой папке проекта›sonar-scanner
Теперь вы можете увидеть сгенерированный отчет сонара на localhost:9000, чтобы увидеть, как отчет вставляет этот URL-адрес в браузер (пример: http://localhost:9000/dashboard?id=lr_v2js_13042020).
Сонарный отчет:
Правила Eslint также могут быть применены в отчете гидролокатора с помощью этого плагина. Ссылка: https://github.com/sleroy/SonarEsLintPlugin