SonarQube-Plugin-for-Java

Overview

This Java i18n SonarQube plugin is a Java code static analyzing plugin, it runs as a SonarQube platform plugin, the issue checking rule set of this plugin focuses on key internationalization issues, it covers internationalization issues around input/output, locales, formatting (dates, times, numbers, etc.), sorting, etc.

Try it out

Prerequisites

• JDK 11+ is installed.
• Maven is downloaded and setup correctly.
• Have a working SonarQube platform.

Build & Run

1. In the project root folder, run:

mvn package

2. Copy the generated plugin artifact to the SonarQube plugin folder

cp ./target/java-i18n-rules-1.0-SNAPSHOT.jar <sonarqube-platform-folder>/extensions/plugins

Restart the SonarQube server to make this new plugin loaded.

3. In the Java project to be scanned, create a config file sonar-project.properties, then run the command:

sonar-scanner

Documentation

Rule Set Information

The rule set of this plugin for internationalization static code analysis focus on key internationalization issues, particularly those issues that can cause more serious bugs in code. Plugin coverage for internationalization issues around input/output, locales, formatting (dates, times, numbers, etc.), sorting, etc.

• Rules V1002-1008 check for potential i18n issues with input/output.
• Rules V1010-1020 relate to locales. Many internationalization pieces, such as formatting, sorting, line-breaking, and more, depend on locales.
• Rules V1009-v1011 relate to date/time formatting issues.
• Rules V1014-V1018 relate to linguistic sorting/collation.

More details about the rules, the exact APIs checked, as well as suggested code fixes for resolution can be found in the HTML files that are part of this plugin.

Contributing

The SonarQube-Plugin-for-Java project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement, our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ. For more detailed information, refer to CONTRIBUTING.md.

• The github issues in the repository are for bug reports and feature requests.

• Feel free to start a conversation with us at Stackoverflow. Tag your question with "vmware-i18n-java-sonarqube-plugin" and we will get back to you.

License

Licensed under the GNU Lesser General Public License, Version 3.0