SonarQube

継続的インスペクション

SonarQube は、アプリケーションの健全性を表示するだけでなく、新たに導入された問題を強調表示する機能も提供します。Quality Gate を設定することで、Clean Code を達成し、コード品質を体系的に向上させることができます。

リンク

Webサイト
ダウンロード
ドキュメント
Webapp ソースコード
X
SonarSource、SonarQube の開発元
課題トラッキング（読み取り専用）。チケットを作成できるのは SonarSource のメンバーのみです。
責任ある開示
次期 SonarQube バージョンの Next インスタンス

質問やフィードバックはありますか？

サポートに関する質問（「どうやったらいい？」「このエラーが出たけど、なぜ？」など）については、まずドキュメントをお読みいただき、それから SonarSource Community にアクセスしてください。あなたの質問の答えは、おそらくすでに回答されています！🤓

このフォーラムはコミュニティであることに注意してください。標準的な挨拶（「こんにちは」「ありがとう」など）が期待されます。また、スレッドに回答が得られない場合は、再投稿（bump）する前に少なくとも3日間は待つようにしてください。オペレーターが待機しているわけではありません。😄

コントリビューション

新しい機能を提案したい場合やバグを報告したい場合は、フォーラムに新しいスレッドを作成してください。

私たちは機能のコントリビューションを積極的に募集しているわけではないことにご注意ください。実際のところ、SonarSource の外部の方が私たちのロードマップと期待に沿うことは非常に困難です。そのため、通常は軽微な見た目の変更とタイポ修正のみを受け付けています。

その上で、コードのコントリビューションを提出したい場合は、このリポジトリにプルリクエストを作成してください。この変更にコントリビュートする動機を説明してください：解決しようとしている問題、達成しようとしている改善点。

コードスタイルに従い、すべてのテストがパスしていることを確認してください（各プルリクエストに対して Travis ビルドが実行されます）。

SonarSource 製品へのコントリビューションに興味がありますか？私たちは、世界クラスのコード品質ソリューションを構築するための、聡明で情熱的かつ熟練した人材を探しています。現在の求人情報はこちらをご覧ください！

ビルド

ソースをローカルでビルドするには、以下の手順に従ってください。

必要条件

Java 17 - プロジェクトのビルドに必要
ネイティブ Git - インストールされ、PATH に含まれている必要があります
テスト - 必要に応じて、gradle コマンドに -x test を追加することで無効化できます（テストを実行せずにビルドしたい場合に便利です）

ビルドと単体テストの実行

プロジェクトのベースディレクトリから実行します：

./gradlew build

zip 配布ファイルは sonar-application/build/distributions/ に生成されます。それを解凍し、以下を実行してサーバーを起動します：

# on Linux
bin/linux-x86-64/sonar.sh start
# or on MacOS
bin/macosx-universal-64/sonar.sh start
# or on Windows
bin\windows-x86-64\StartSonar.bat

IDE で開く

プロジェクトを一度もビルドしたことがない場合は、通常どおりビルドするか（前のセクションを参照）、より迅速なコマンドを使用します：

./gradlew ide

その後、ルートファイル build.gradle を IntelliJ または Eclipse でプロジェクトとして開きます。

Gradle ヒント

./gradlew command	説明
`dependencies`	依存関係を一覧表示
`spotlessApply`	HEADER を適用してソースヘッダーを修正
`wrapper --gradle-version 5.2.1`	ラッパーをアップグレード

UI の変更を伴うビルド

SonarQube の UI（私たちが webapp と呼んでいるもの）は、別のリポジトリにあります：sonarqube-webapp。

sonarqube リポジトリをビルドすると、webapp は依存関係として Maven Central から自動的にダウンロードされます。そのため、webapp を気にすることなくバックエンドの変更にコントリビュートできます。

ただし、コントリビューションに UI の変更も含まれる場合は、sonarqube-webapp リポジトリをクローンし、そこで変更を行い、ローカルでビルドしてから、WEBAPP_BUILD_PATH 環境変数を使用して UI のカスタムビルドを指定した上で sonarqube リポジトリをビルドする必要があります。

その方法の例は次のとおりです：

cd /path/to/sonarqube-webapp/server/sonar-web
# do your changes

# install dependencies, only needed the first time
yarn

# build the webapp
yarn build


cd /path/to/sonarqube

# build the sonarqube repository using the custom build of the webapp
WEBAPP_BUILD_PATH=/path/to/sonarqube-webapp/server/sonar-web/build/webapp ./gradlew build

また、./gradle.properties ファイルの webappVersion プロパティを更新してから sonarqube リポジトリを通常どおりビルドすることで、webapp の特定のバージョンを指定することもできます。

翻訳ファイル

これまで翻訳は sonar-core/src/main/resources/org/sonar/l10n/core.properties に保存されていましたが、このファイルは現在非推奨となり、更新されなくなりました。デフォルトの翻訳（英語）は現在、webapp リポジトリで定義されています： https://github.com/SonarSource/sonarqube-webapp/blob/master/libs/sq-server-shared/src/l10n/default.ts

フォーマットは変更されましたが、以下のコマンドを実行することで、依然として .properties ファイル形式で取得できます：

cd /path/to/sonarqube-webapp/server/sonar-web

# install dependencies, only needed the first time
yarn

# generate a backward compatible .properties file with all the translation keys
yarn generate-translation-keys

他の言語への翻訳拡張のコントリビューションは、これまでと同じように機能することに注意してください。変更されたのは、デフォルト翻訳の基準となる情報源だけです。

ライセンス

GNU Lesser General Public License, Version 3.0 に基づいてライセンスされています。

sonarqube

人気