Skip to content

Latest commit

 

History

History
85 lines (70 loc) · 6.32 KB

settings.adoc

File metadata and controls

85 lines (70 loc) · 6.32 KB
Table of Contents

settings

IDEasy requires settings with configuration templates for the arbitrary tools.

To get an initial set of these settings we provide the default ide-settings as an initial package. These are also released so you can download the latest stable or any history version at maven central.

To test IDEasy or for very small projects you can also use these the latest default settings (just hit return when setup is asking for the Settings URL). However, for collaborative projects we provide two approaches to distribute and maintain the settings:

  • Via a dedicated and project specific git repository (recommended approach). This gives you the freedom to control and manage the tools with their versions and configurations during the project lifecycle. Therefore simply follow the admin usage guide.

  • Via your code repository by including the settings folder directly in your project. This allows you to keep settings changes in sync with code changes and manage them in the same pull requests. To use this approach:

    • Create a settings folder in your repository root following the structure described below

    • Use ide create --code <code-repo-url> to create your project. IDEasy will clone your repository and create a symlink to the settings folder. Changes to settings can then be committed alongside code changes.

Structure

The settings folder (see SETTINGS_PATH) has to follow this file structure:

File structure of settings
/settings
├──/ templates
│  ├──/ conf
│  │  ├──/ mvn
│  │  │  ├── settings.xml
│  │  │  └── settings-security.xml
│  │  ├──/ npm
│  │  │  └── .npmrc
│  │  └── ide.properties
├──/ eclipse
│  ├──/ workspace
│  │  ├──/ setup
│  │  └──/ update
│  ├── lifecycle-mapping-metadata.xml
│  └── project.dictionary
├──/ intellij
│  └──/ workspace
│     ├──/ setup
│     └──/ update
├──/ vscode
│  └──/ workspace
│     ├──/ setup
│     └──/ update
├──/ repositories
│  ├──/ ...
│  └──/ README.adoc
├──/ ...
└── ide.properties

As you can see, the settings folder contains various configurations to customize IDEasy to your project needs. The key configuration is the top-level ide.properties file. The template folder contains templates that will be applied to $IDE_HOME and therefore allow to define the initial content of the conf folder with the defaults for the developer specific configuration (e.g. settings.xml and ide.properties). Further, for the IDEs such as Eclipse, VSCode, or IntelliJ the according folders contain the templates to manage the workspace via our configurator.

Configuration Philosophy

Different tools and configuration files require a different handling:

  • Where suitable, we directly use these configurations from your settings (e.g. for eclipse/lifecycle-mapping-metadata.xml, or eclipse/project.dictionary).

  • The template folder in settings contains templates for configuration files. They are copied to the IDEasy installation during setup (if no such file already exists). In this way the settings repository can provide reasonable defaults but allows the user to take over control and customize to his personal needs (e.g. .m2/settings.xml).

  • For tools with complex configuration structures like Eclipse, IntelliJ, or VScode we provide a smart mechanism via our configurator.

Customize Settings

You can easily customize these settings for the requirements of your project. We suggest that one team member is responsible to ensure that everything stays consistent and works. However, every team member can contribute changes as pull-/merge-requests.

You may also create new sub-folders in settings and put individual items according to your needs. E.g. you could add scripts for greasemonkey or tampermonkey, as well as scripts for your database or whatever may be useful and worth to share in your team. However, to share and maintain knowledge we recommend to use a wiki.