...
ONAP Eclipse Java Formatter (Optional)
| Expand |
|---|
As per https://gerrit.onap.org/r/#/c/79312/1/onap-java-formatter.xml, an ONAP Eclipse Java Formatter XML file has been merged and can be imported into Eclipse. Updates Updates to the settings should be committed and merged back into the repository (e.g. | Jira |
|---|
| server | ONAP JIRA |
|---|
| serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
|---|
| key | AAI-2198 |
|---|
|
) . TBC: This should probably be in oparent for all to share.Using the Eclipse Formatter file above and maven plugin configuration in pom.xml as per https://gerrit.onap.org/r/#/c/79312/1/per pom.xml (https://code.revelc.net/formatter-maven-plugin/ for Eclipse formatter and https://github.com/diffplug/spotless/tree/master/plugin-maven for import order) | Code Block |
|---|
| language | xml |
|---|
| title | Example pom.xml configuration |
|---|
| collapse | true |
|---|
| <plugins>
<!--
Using https://code.revelc.net/formatter-maven-plugin/ for Eclipse formatter
Using https://github.com/diffplug/spotless/tree/master/plugin-maven for import order
Use in combination to rewrite code and imports, then checkstyle
mvn formatter:format spotless:apply process-sources
-->
<plugin>
<groupId>net.revelc.code.formatter</groupId>
<artifactId>formatter-maven-plugin</artifactId>
<version>2.8.1</version>
<configuration>
<configFile>${project.parent.basedir}/onap-java-formatter.xml</configFile>
</configuration>
<!-- https://code.revelc.net/formatter-maven-plugin/
use mvn formatter:format to rewrite source files
use mvn formatter:validate to validate source files -->
</plugin>
<plugin>
<groupId>com.diffplug.spotless</groupId>
<artifactId>spotless-maven-plugin</artifactId>
<version>1.18.0</version>
<configuration>
<java>
<importOrder>
<order>com,java,javax,org</order>
</importOrder>
</java>
</configuration>
<!-- https://github.com/diffplug/spotless/tree/master/plugin-maven
use mvn spotless:apply to rewrite source files
use mvn spotless:check to validate source files -->
</plugin>
</plugins> |
the combination can be used in a maven command to rewrite code and imports, then checkstyle audit like so | Code Block |
|---|
| title | Example maven command |
|---|
| mvn formatter:format spotless:apply process-sources |
|
...
Add python binary to Path. Also, be sure to install "pip3".
git-review
Within Git Bash, type the following command: assumes you already installed python above
...
