Skip to content

invesdwin/invesdwin-maven-plugin

BranchesTags

Repository files navigation

invesdwin-maven-plugin

This plugin provides auto configuration for eclipse projects using the invesdwin platform standards. It automatically sets up Checkstyle, SpotBugs, Spring Tools, MoreUnit, m2e-apt, save actions, code formatter and other things.

When using the included checkstyle config, please make sure you have the invesdwin-checkstyle-plugin installed in eclipse or else you will get exceptions thrown during checks.

Maven

Releases and snapshots are deployed to this maven repository:

https://invesdwin.de/repo/invesdwin-oss-remote/

Dependency declaration:

<plugin>
	<groupId>de.invesdwin</groupId>
	<artifactId>invesdwin-maven-plugin</artifactId>
	<version>1.0.13</version><!---project.version.invesdwin-maven-plugin-parent-->
	<executions>
		<execution>
			<goals>
				<goal>initialize</goal>
				<goal>generate-sources</goal>
				<goal>compile</goal>
			</goals>
			<configuration>
				<useInvesdwinEclipseSettings>true</useInvesdwinEclipseSettings>
				<codeComplianceLevel>1.8</codeComplianceLevel>
			</configuration>
		</execution>
	</executions>
</plugin>

Goals

The plugins has the following goals which you can include/exclude:

  • initialize: this extracts the eclipse settings and sets up the git/svn ignores properly for the module
    • the configuration parameter useInvesdwinEclipseSettings can be used to disable extraction of the eclipse settings
    • the configuration parameter codeComplianceLevel can be used to set the java code compliance level for the eclipse project
  • generate-sources: this generates a helper class with which the JAXB context finds out about XSD files used by the invesdwin platform
  • compile: this sets up checkstyle and findbugs builder and nature for this eclipse project

Handling Multiple Projects/Repositories

  • On Windows, install Git for Windows and select the line break setting "Checkout as-is and commit as-is" to effectively select "git config --global core.autocrlf false" during the installation wizard of Git for Windows.
    • It is recommended to install Notepad++ beforehand and select that as the default editor during the installation wizard of Git for Windows.
    • You can optionally also install TortoiseGit which provides a File Explorer integration for Git.
    • It is recommended to checkout repositories into a short path without any spaces and install tools near it. An example structure is this:
      • C:\tools\cygwin64 (add C:\tools\cygwin64\bin to the PATH)
      • C:\tools\maven (add C:\tools\maven\bin to the PATH)
      • C:\tools\invesdwin\eclipse (make sure to edit eclipse.ini to increase RAM by adding the line -Xmx5g and to add the invesdwin-checkstyle-plugin to the dropin folder dropin)
      • C:\tools\invesdwin\eclipse-workspace (the eclipse workspace with the hidedn .metadata folder should be separated from the checkouts)
      • C:\tools\invesdwin\invesdwin-workspace (the workspace repo checkout)
  • Git setup:
# On windows open terminal as administrator
git config --global core.longpaths true
git config --global core.autocrlf false # 
# On linux if thre is no credential manager available
git config --global  credential.helper store
  • Optional: Check out individual git repos and create a parent pom to build them all in one go (invesdwin-workspace and invesdwin-oss already do that for you):
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0                              http://maven.apache.org/maven-v4_0_0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>de.invesdwin</groupId>
	<artifactId>invesdwin-build-all</artifactId>
	<version>0.0.0-SNAPSHOT</version>
	<packaging>pom</packaging>

	<modules>
		<!-- list all projects here -->
		<module>invesdwin-oss</module>
        	<module>invesdwin-trading/invesdwin-trading-parent</module>
        	<module>invesdwin-trading-test/invesdwin-trading-backtest-test</module>
        	<module>invesdwin-trading-jforex/invesdwin-trading-jforex-parent</module>
        	<module>invesdwin-trading-fxcm/invesdwin-trading-fxcm-parent</module>
        	<module>invesdwin-trading-metatrader/invesdwin-trading-metatrader-parent</module>
        	<module>orbox/orbox-parent</module>
        	<module>irisalpha/irisalpha-parent</module>
  	</modules>

</project>
  • Optional: On Linux, install myrepos: apt install myrepos
    • run mr register <PROJECT_FOLDER> for each repository
    • with that you can use mr update from any parent directory to pull all projects (nested symlinks are not supported)
    • edit .mrconfig as below
# use special update scripts for invesdwin-oss that properly handle git submodules
[/ABSOLUTE/PATH/TO/invesdwin/invesdwin-oss]
update = bash pull.sh
push = bash push.sh
commit = bash commit.sh
checkout = git clone 'https://github.com/subes/invesdwin-oss.git' 'invesdwin-oss'
# private repos might require credentials in the URL to allow checkout (otherwise 404 might be returned)
[/ABSOLUTE/PATH/TO/invesdwin-trading]
checkout = git clone 'https://<USERNAME>:<PASSWORD>@github.com/subes/invesdwin-trading.git' 'invesdwin-trading'
  • On Windows
    • install Cygwin and add it to the PATH or run scripts directly from <CYGWIN_HOME>/bin/bash.exe (or use Git Bash which was installed with Git for Windows the File Explorer context menu).
      • A recent Maven version should be downloaded and added to the PATH.
      • A recent JDK version should be donloaded and added to the PATH, as well as JAVA_HOME defined.
    • Optional: Use a pull script like this (invesdwin-workspace and invesdwin-oss already have that for you, as well as a build_offline_parents.sh to resolve pom issues before a build):
#! /bin/bash

for dir in *
do
  test "dependencies" = "$dir" && continue
  test -d "$dir" || continue
  echo -- $dir
  cd $dir

  git pull

  cd ..
done

cd invesdwin-oss
./pull.sh

Eclipse Tips

  • Download Eclipse IDE for Java Developers as a zip package (not the Oomph installer, as that can cause issues with plugins) and install it similar to: installEclipse.sh
    • on Ubuntu you can create a shortcut via Menulibre: apt install menulibre
    • using the created /usr/local/bin/eclipse launcher script and <ECLIPSE_HOME>/eclipse48.png
  • Install Plugins
  • Install m2eclipse connectors:
    • Window -> Preferences -> Maven -> Discovery -> Open Catalog -> Select "buildhelper" -> Finish
      • If this does not work, install manually using the update site: https://github.com/tesla/m2eclipse-buildhelper/releases/download/latest/
      • This plugin will ensure that generated sources are added to the project build path.
      • Manual Workaround: Right Click on the Project -> Propertries -> Java Build Path -> Source -> Add Folder… -> Select target/generated-sources/apt
    • Window -> Preferences -> Maven -> Java Configurator -> JRE System Library Version -> Use Workspace Default
      • This ensures that maven-surefire-plugin settings are not applied to eclipse JUnit launchers and that these launchers don't mess up the default JDK version when creating new launchers.
  • Prefer Java Perspective over JEE Perspective (top right buttons)
  • In Package Explorer configure (three dots)
    • Top Level Elemements -> Working Sets
    • Package Presentation -> Hierarchical
    • Filters and Customization... -> .* resources -> Uncheck -> OK
    • or use Project Explorer instead
  • In Problems View configure (three dots)
    • Show -> Show All (default in Java Perspective)
  • Change some general settings
    • Window -> Preferences -> General -> Workspace -> Refresh using native hooks or polling -> Check
    • Window -> Preferences -> General -> Show heap status -> Check
    • Window -> Preferences -> Java -> Editor -> Content Assist -> Completion inserts -> Select
    • Window -> Preferences -> Run/Debug -> Console -> Limit console output -> Check
    • Window -> Preferences -> Run/Debug -> Console -> Console buffer size (characters) -> 8000000
  • Remove annoying completions
    • Window -> Preferences -> Java -> Appearance -> Type Filters -> Add
      • ch.qos.logback.core.recovery.ResilientSyslogOutputStream
      • org.assertj.*.Arrays
      • org.assertj.*.Assertions
  • Assign the File Associations for .class files without sources to enhanced class decompiler
    • Window -> Preferences -> Java -> Debug -> Use advanced source lookup (JRE 1.5 and higher) -> Uncheck
    • Window -> Preferences -> General -> Editors -> *.class without source -> Class Decompiler Viewer -> Default
    • Window -> Preferences -> General -> Editors -> *.class -> Class Decompiler Viewer -> Default
  • Make it easier to debug decompiler classes
    • Window -> Preferences -> Java -> Decompiler -> Output original line numbers as comments -> Check
    • Window -> Preferences -> Java -> Decompiler -> Align code for debugging -> Check
    • (make sure a Default Class Decompiler is selected at the top, otherwise saving the dialog might not work)
  • Import each project into a separate Working Set
    • with that it becomes easy to commit individual projects using Git Staging View by selecting the Working Sets
    • except invesdwin-oss requires each project to be selected individually since Git Submodules need to be committed separately
    • or use mr commit or direct git commands per project/repository on the console
  • You can configure IntelliJ Keymap if desired using this plugin
    • with Eclipse Keymap on macOS CTRL+SPACE might require remapping so that code completion becomes usable (macOS might occupy that shortcut): Window -> Preferences -> Keys -> Content Assist
  • Some modules do not support getting resolved from inside Eclipse, you can resolve them from the maven repository instead by closing or removing the project in eclipse. An example is the protected module invesdwin-trading-jforex-runtime-bundle. Though normally the pom.xml contains hints/tips like this for specific modules that require workarounds like this.
  • Removing JPA Change Events which can slow down the IDE: https://stackoverflow.com/questions/19649847/eclipse-jpa-project-change-event-handler-waiting
  • Disable Spring Boot validations that can slow down the IDE:
    • Window -> Preferences -> Language Servers -> Spring Language Servers -> Boot 2.x Validation -> Enablement -> Off
    • Window -> Preferences -> Language Servers -> Spring Language Servers -> Boot 3.x Validation -> Enablement -> Off
  • To prevent deadlocks when importing projects in Eclipse 2022-09 (https://bugs.eclipse.org/bugs/show_bug.cgi?id=579076):
    • Window -> Prefernences -> Maven -> Annotation Processing -> Select Annotation Processing Mode -> Do not automatically configure/execute annotation processing from pom.xml
  • To prevent the debugger always stopping on uncaught exceptions:
    • Window -> Preferences -> Java -> Debug -> Suspend execution on uncaught exceptions -> Off

Eclipse Troubleshooting

  • In 2023 eclipse-m2e had a bug where resources were not copied correctly. So if you start a process and it complains about files being missing, you might be affected by this bug. Try upgrade eclipse-m2e. Alternatively copy the resources again via maven: mvn process-resources process-test-resources -T1C
  • When eclipse is not closed properly it might crash on startup due to corrupt snap files or it might fail to find jvm internal classes because of corrupt indexes. To solve this, the workspace needs to be repaired:
cd <ECLIPSE_WORKSPACE_FOLDER>
rm -rf .metadata/.plugins/org.eclipse.jdt.core
rm -rf .metadata/.plugins/org.eclipse.core.resources/*.snap
eclipse -clean
  • In 2024 and 2025 eclipse-m2e automatically copies settings from maven-surefire-plugin (JVM arguments) and maven-enforcer-plugin (JDK version) into newly created JUnit launchers. This can currently not be disabled. A feature request has been created to be able to opt out of this behaviour. Though for the time being, launchers have to be manually edited after creating them to use "Project execution environment" for the JDK version and to remove JVM arguments copied from maven-surefire-plugin. Alternatively disable detection of JVMs in eclipse and removed the old JDK versions here: grafik

IntelliJ Tips

  • Import all projects as Maven using a parent-pom that lists projects as modules (see above for an example pom.xml)
    • IMPORANT: Make sure not to use paths that contain symlinks, as IntelliJ has issues with that which are noticeable when trying to execute tests
  • Install plugins:
    • Eclipse-Code-Formatter
      • use "Resolve project specific config" (should be equivalent to "Eclipse [built-in]")/invesdwin-maven-plugin-parent/invesdwin-maven-plugin/src/main/java/invesdwin-eclipse-settings/.settings/org.eclipse.jdt.ui.prefs)
    • Save Actions plugin and configure:
      • File -> Preferences -> Editor -> Code Style -> Java -> Imports -> Packages to Use Import with '*' -> Remove All
      • File -> Preferences -> Editor -> Code Style -> Java -> Imports -> Class count to use import with '*' -> 99
      • File -> Preferences -> Editor -> Code Style -> Java -> Imports -> Names count to use static import with '*' -> 99
      • File -> Preferences -> Other Settings -> Save Actions -> Activate save actions on save -> Check
      • File -> Preferences -> Other Settings -> Save Actions -> Optimize imports -> Check
      • File -> Preferences -> Other Settings -> Save Actions -> Reformat file -> Check
      • File -> Preferences -> Other Settings -> Save Actions -> Add final modifier to field -> Check
      • File -> Preferences -> Other Settings -> Save Actions -> Add final modifier to local variable or parameter except if it is implicit -> Check
      • File -> Preferences -> Other Settings -> Save Actions -> Add missing @Override annotations -> Check
      • File -> Preferences -> Other Settings -> Save Actions -> Add blocks to if/while/for statements -> Check
    • Spotbugs and configure
      • File -> Preferences -> Tools -> SpotBugs -> General -> Analyze affected files after compile -> Check
      • File -> Preferences -> Tools -> SpotBugs -> General -> Analyze affected files after auto make -> Check
      • File -> Preferences -> Tools -> SpotBugs -> Analysis Effort -> Minimal
    • Checkstyle and configure
      • File -> Preferences -> Tools -> Checkstyle -> Third-Party Checks -> invesdwin-checkstyle-plugin.jar
      • Download checkstyle.config.suppression.xml and checkstyle.config.xml
      • File -> Preferences -> Tools -> Checkstyle -> Configuration File -> Select the downloaded checkstyle.config.xml
      • set config_loc property to the path where checkstyle.config.suppression.xml resides
      • activate the new configuration file (checkbox column)
  • To prevent import errors for sun.misc.Unsafe
    • File -> Settings -> Build, Execution, Deployment -> Compiler -> Java Compiler -> Use '--release' option for cross compilation (Java 9 and later) -> Uncheck
  • You can configure Eclipse Keymap if desired via:
    • File -> Settings -> Keymap -> Eclipse
  • To enable automatic builds configure
    • File -> Preferences -> Build, Execution, Deployment -> Compiler -> Build project automatically -> Check
    • File -> Preferences -> Build, Execution, Deployment -> Compiler -> Compile independent modules in parallel -> Automatic
  • Some modules do not support getting resolved from inside IntelliJ. An example is the protected module invesdwin-trading-jforex-runtime-bundle. You can resolve them from the maven repository instead by ignoring the project in IntelliJ:
    • Right Click Project -> Maven -> Ignore Project -> Yes
      • then Right Click Parent Project -> Maven -> Reload Project

IntelliJ Annotation Processing Workarounds

Configure annotation processing properly:

  • Use Eclipse compiler (more robust against errors):
    • File -> Preferences -> Build, Execution, Deployment -> Compiler -> Java Compiler -> Use Compiler -> Eclipse
  • Prevent generated classes from being deleted right after getting generated:
    • File -> Preferences -> Build, Execution, Deployment -> Compiler -> Clear output directory on rebuild (otherwise generated classes from maven will be deleted) -> Uncheck
  • Make sure annotation processing generates files before trying to compile the source code:
    • File -> Preferences -> Build, Execution, Deployment -> Compiler -> Annotation Processors -> Run processors in a separate step before compiling java (-proc:only mode) -> Check
  • For more information:

Obsolete Workaround 1: If annotation processing causes errors, a workaround seems to be using maven for generating classes and disabling annotation processing completely:

  • Go to: File -> Preferences -> Build, Execution, Deployment -> Compiler -> Annotation Processors
    • Add a new profile (+ icon) with name "Disabled" and uncheck: "Enable annotation processing" then move all modules into disabled profile (-> icon).
    • OR just uncheck "Enable annotation processing" for all profiles individually.
    • Sadly this setting is not persistent in IntelliJ and needs to be reapplied after any maven related changes that cause a reload of the maven modules. This can be prevented by:
      • File -> Preferences -> Build, Execution, Deployment -> Build Tools -> Reload project after changes in build scripts -> Uncheck
  • Run mvn clean generate-sources from command line or do it in IntelliJ via:
    • Right Click Root Project -> Maven -> Generate Sources and Update Folders

Obsolete Workaround 2: Alternatively you can use Maven for building in IntelliJ by checking:

  • File -> Preferences -> Build, Execution, Deployment -> Build Tools -> Maven -> Runner -> Delegate IDE build/run actions to maven -> Check
  • File -> Preferences -> Build, Execution, Deployment -> Build Tools -> Maven -> Runner -> Skip Tests -> Check
  • Then speed up build by enabling parallel maven builds
    • File -> Preferences -> Build, Execution, Deployment -> Build Tools -> Maven -> Thread count -> 1C
      • "1C" stands for one thread per available cpu core

Visual Studio Code Tips

  • Install extensions:
  • Import all projects as Maven by opening the respective workspace root folder, then navigating to the Java Projects view and telling it to import everything as Maven (if it is confused by Gradle files)
  • Change java version and redirect JavaSE-1.8 to a reject JDK (though with a correct path to a recent JDK installation):
    • File -> Preferences -> Settings -> Extensions -> Language Support for Java(TM) by Red Hat -> Startup -> Java › Jdt › Ls › Java: Home -> Edit in settings.json -> Put "java.jdt.ls.java.home": "/usr/lib/jvm/default",
    • File -> Preferences -> Settings -> Extensions -> Language Support for Java(TM) by Red Hat -> Startup -> Java › Jdt › Ls: Vmargs -> Edit in settings.json -> Put "java.jdt.ls.vmargs": "-Xmx5g",
    • File -> Preferences -> Settings -> Extensions -> Language Support for Java(TM) by Red Hat -> Installed JDKs -> Java › Configuration: Runtimes -> Edit in settings.json -> Uncheck -> Put "java.configuration.runtimes": [ { "name": "JavaSE-1.8", "path": "/usr/lib/jvm/default" }, ],
  • In Java Projects configure (three dots)
    • Hierarchical View -> Click
  • Configure settings:
    • File -> Preferences -> Settings -> Extensions -> Language Support for Java(TM) by Red Hat -> Maven -> Java › Maven: Download Sources -> Check
    • File -> Preferences -> Settings -> Extensions -> Language Support for Java(TM) by Red Hat -> Other -> Java › Eclipse: Download Sources -> Check
    • File -> Preferences -> Settings -> Extensions -> Language Support for Java(TM) by Red Hat -> Other -> Java › Editor: Reload Changed Sources -> Auto
  • If you have Eclipse open at the same time and want Visual Studio Code to not compile for a while to prevent confusing the other instances build (since Visual Studio Code uses the Eclipse compiler as a language server):
    • File -> Preferences -> Settings -> Extensions -> Language Support for Java(TM) by Red Hat -> Build -> Java › Autobuild: Enabled -> Uncheck
  • To manually build in Visual Studio Code:
    • Terminal -> Run Build Task... Ctrl+Shift+B -> java (build): Build Workspace
{
    "workbench.colorTheme": "Default Light Modern",
    "redhat.telemetry.enabled": false,
    "java.configuration.runtimes": [ { "name": "JavaSE-1.8", "path": "/usr/lib/jvm/default" }, ],
    "workbench.startupEditor": "none",
    "java.jdt.ls.java.home": "/usr/lib/jvm/default",
    "java.maven.downloadSources": true,
    "java.eclipse.downloadSources": true,
    "java.jdt.ls.vmargs": "-Xmx5g",
    "java.autobuild.enabled": false,
}

AI Copilot/Assistant Tips

  • IMPORTANT:
    • If you use AI plugins in your IDE, make sure Optional Telemetry is disabled or Privacy Mode is enabled in your personal account to achieve Zero Data Retention (ZDR)
    • When using online/web prompts, the information is generally shared and used for training the models. So be careful to share no sensitive information
    • Be careful when using CLI/IDE AI tools that can directly read and modify files while being able to invoke arbitrary commands, code, or web requests. The AI may have access to the whole computer, or at least everything visible from within the IDE and could leak data via prompt injection. Consider using a sandbox like a virtual machine and share no sensitive information.
  • For Visual Studio Code:
  • For IntelliJ:
  • For Eclipse:

Support

If you need further assistance or have some ideas for improvements and don't want to create an issue here on github, feel free to start a discussion in our invesdwin-platform mailing list.

About

Eclipse projects get configured automatically by this maven plugin to follow invesdwin standards

Resources

Readme

License

LGPL-3.0 license
Activity
Custom properties

Stars

2 stars

Watchers

3 watching

Forks

1 fork
Report repository

Releases

14 tags

Packages

 
 
 

Contributors

Languages