Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 3.25 KB

configuration.adoc

File metadata and controls

57 lines (45 loc) · 3.25 KB
Table of Contents

Configuration

IDEasy aims to be highly configurable and flexible. The configuration of the ide command and environment variables takes place via ide.properties files. The following list shows these configuration folders in the order they are loaded so files can override configurations:

  1. build in defaults (for MAVEN_ARGS, IDE_TOOLS, etc.)

  2. ~/.ide/ - user specific global defaults (on Windows in %USERPROFILE%/.ide/)

  3. settings/ - project specific configurations from settings.

  4. workspaces/${WORKSPACE}/ - optional workspace specific configurations.

  5. conf/ - project specific user configuration such as conf/mvn/settings.xml. You may also override things like M2_REPO=~/.m2/repository in conf/ide.properties. During setup this folder is created by copying templates from settings/templates/conf/.

ide.properties

The ide.properties files allow to define environment variables in a simple and OS independent way:

  • # comments begin with a hash sign (#) and are ignored

  • variable_name=variable_value with space etc.

  • variable_name=${predefined_variable}/folder_name

    Variable values can refer to other variables that are already defined, which will be resolved to their value. You have to used ${…​} syntax to make it work on all platforms (never use %…​%, $…​, or $(…​) syntax in ide.properties files.

  • export exported_variable=this value will be exported in bash, in windows CMD the export prefix is ignored

  • variable_name=

    This will unset the specified variable

  • variable_name=~/some/path/and.file

    Tilde is resolved to your personal home directory on any OS including windows.

  • array_variable=value1,value2,value3

    See variables for candidates that support array values.

  • Please never surround values with quotes (var="value")

  • This format is similar to Java *.properties but does not support advanced features as unicode literals, multi-lined values, etc.

In order to know what to configure, have a look at the available variables.

Please only tweak configurations that you need to change and be aware:

High flexibility comes with great responsibility.

So please only configure and override what is needed and what you can manage and take responsibility for. Some users override and tweak configurations just by random trial & error experiments, then forget about it and later complain if something that they broke is not working. Use ide -d env to check your configured variables and see where they are coming from.

IDE workspace configuration

To configure your IDE (e.g. Eclipse, IntelliJ, or VSCode) workspace configuration templates are merged into your workspace by the configurator. The configuration templates are honored in the configuration order documented above except that here workspaces (4.) are not supported. For each supported location a workspace subfolder is considered and with priority also a potential «ide»/workspace folder. Almost every configuration should be done in settings. Further details can be found in configurator.