From 42c185cdb271ccbbc7a844a19e9a9c64bfafe245 Mon Sep 17 00:00:00 2001 From: Matthias Thieroff Date: Wed, 21 Jan 2026 13:36:36 +0000 Subject: [PATCH] Update IntelliJ IDEA configuration --- .../intellij-idea-configuration.md | 85 ++++++++----------- docs/en/known-issues.md | 2 +- gradle/changelog/update_intellij_config.yaml | 2 + 3 files changed, 38 insertions(+), 51 deletions(-) create mode 100644 gradle/changelog/update_intellij_config.yaml diff --git a/docs/en/development/intellij-idea-configuration.md b/docs/en/development/intellij-idea-configuration.md index 65141909a6..740d545269 100644 --- a/docs/en/development/intellij-idea-configuration.md +++ b/docs/en/development/intellij-idea-configuration.md @@ -1,73 +1,58 @@ --- -title: Intellij IDEA Configuration +title: IntelliJ IDEA Configuration --- +# Plugins + +Make sure the following plugins are installed: + +* EditorConfig +* Lombok +* MapStruct Support +* Prettier + +# Settings + ## Backend -### Plugins - -* Lombok Plugin -* MapStruct Support - -### Settings - * Build, Execution, Deployment / Compiler - * Add runtime assertions for non-null-annotated methods and parameters (must be checked) - * Configure annotation ... (of "Add runtime assertions...") - * Nullable annotations: select (✓) `jakarta.annotation.Nullable` - * NotNull annotations: select (✓) `jakarta.annotation.Nonnull` and check Instrument + * Check "Add runtime assertions for notnull-annotated methods and parameters" + * Configure annotations... + * Nullable + * Add "Nullabel annotations" (if not exist): `jakarta.annotation.Nullable` + * NotNull + * Add "NotNull annotations" (if not exist): `jakarta.annotation.Nonnull` and check "Instrument" * Editor / Code Style / Java - * Tab Imports - * Class count to use import with '*': - * Names count to use static import with '*': + * Imports + * Set "Class count to use import with '*'" to `9999` + * Set "Names count to use static import with '*'" to `9999` ## Frontend -### Plugins - -* Prettier -* File Watchers - -### Settings - -* Languages & Frameworks / Node.js and NPM - * Package Manager: yarn +* Languages & Frameworks / JavaScript Runtime + * Set "Preferred runtime" to `Node.js` + * Set "Package manager" to `yarn` * Languages & Frameworks / Javascript / Code Quality Tools / ESLint - * Enable - * ESLint package: .../node_modules/eslint - * -OR- Automatic ESLint configuration + * Enable "Automatic ESLint configuration" * Languages & Frameworks / Javascript / Prettier - * Prettier package: .../node_modules/prettier - -* Tools / File Watchers - * Add Prettier - * Deselect: Track only root files - * Scope: Current File - * Program: $ProjectFileDir$/node_modules/.bin/prettier - * Working Directory: $ProjectFileDir$ + * Enable "Automatic Prettier configuration" ## Both -### Plugins - -* EditorConfig - -### Settings - * Editor / Copyright / Copyright Profiles - * Add Profile - * Name: SCM-AGPL - * Copyright text: see https://www.gnu.org/licenses/ - * Regex: GNU Affero General Public License + * Add Profile with name `SCM-AGPL` + * Replace the text with content from `LICENSE-HEADER.txt` + * Set "Regex to detect copyright in comments" to `Copyright` * Editor / Copyright - * Default project copyright: SCM-AGPL + * Set "Default project copyright" to `SCM-AGPL` + * Add "Scopes" with "All" and "Copyright" `SCM-AGPL` * Editor / Copyright / Formatting / XML - * Use custom formatting options - * Use block comment, check prefix each line - * Select: Separator before, Length: 0 - * Separator: *space* + * Enable "Use custom formatting options" + * Enable "Use block comment" and check "Prefix each line" + * Check "Separator before" and set "Length" to `0` + * Set "Separator" to ` ` (*Space*) diff --git a/docs/en/known-issues.md b/docs/en/known-issues.md index 76c65e9987..8eff308b66 100644 --- a/docs/en/known-issues.md +++ b/docs/en/known-issues.md @@ -32,7 +32,7 @@ public class DemoHook { } ``` -This is because of the transaction management of subversion. The scm-manager subversion provider becomes a transaction id for the changes of the current push, but the transaction has finished before scm-manager can resolve the incoming commit. To solve the issue, we could use a synchronous subscription instead e.g.: +This is because of the transaction management of subversion. The scm-manager subversion provider gets a transaction id for the changes of the current push, but the transaction has finished before scm-manager can resolve the incoming commit. To solve the issue, we could use a synchronous subscription instead e.g.: ```java import com.github.legman.Subscribe; diff --git a/gradle/changelog/update_intellij_config.yaml b/gradle/changelog/update_intellij_config.yaml new file mode 100644 index 0000000000..cd919c53da --- /dev/null +++ b/gradle/changelog/update_intellij_config.yaml @@ -0,0 +1,2 @@ +- type: changed + description: Update IntelliJ IDEA configuration documentation