kie-issues#1506: Use per-package local Maven repositories for depende…

…ncy declaration correctness on `kie-tools` (#2635)

.github/supporting-files/ci/patterns/non-source-files-patterns.txt

@@ -11,4 +11,5 @@ repo
 .vscode
 .idea
 .ci
+./_intellij-project
 .github/CODEOWNERS

.gitignore

@@ -235,6 +235,8 @@ packages/sonataflow-operator/e2e-test-report.xml
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
+/.idea
+
 # User-specific stuff
 .idea/**/workspace.xml
 .idea/**/tasks.xml
@@ -265,14 +267,14 @@ packages/sonataflow-operator/e2e-test-report.xml
 # When using Gradle or Maven with auto-import, you should exclude module files,
 # since they will be recreated, and may cause churn.  Uncomment if using
 # auto-import.
-.idea/artifacts
-.idea/compiler.xml
-.idea/jarRepositories.xml
-.idea/modules.xml
-.idea/*.iml
-.idea/modules
-*.iml
-*.ipr
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
 
 # CMake
 cmake-build-*/
@@ -340,3 +342,7 @@ packages/python-venv/venv
 # turbo
 .turbo
 turbo.json
+
+# IntelliJ projects should be on _intellij-projects folder, never on specific packages.
+packages/*/.idea
+examples/*/.idea

.prettierignore

@@ -10,3 +10,7 @@ pnpm-lock.yaml
 packages/xml-parser-ts-codegen/src/schemas/xsd/HFP.xsd
 packages/xml-parser-ts-codegen/src/schemas/xsd-incomplete--manually-written/HFP.xsd
 packages/xml-parser-ts-codegen/src/schemas/xsd-incomplete--manually-written/XSD.xsd
+
+# @prettier/parser-xml shouldn't mess with auto-generated IntelliJ files
+_intellij-project
+*.iml

_intellij-project/README.md

@@ -0,0 +1,53 @@
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+     http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+-->
+
+# KIE Tools @ IntelliJ IDEA
+
+To make it easier for developing Java-, Maven-based packages, this folder contains an IntelliJ IDEA project configured for select packages. It currently includes all Maven-based packages of KIE Tools. Two additional IntelliJ IDEA project modules are included too, given their "global" nature on the KIE Tools repository -- `scripts` and `root-env`.
+
+### Importing this project on IntelliJ IDEA
+
+After cloning `kie-tools` locally:
+1. Bootstrap the repository with `pnpm bootstrap [pnpm-filter?]` command to wire everything together and configure `.mvn/maven.config` files for all packages. You only need to do it once per clone or when you change the dependency graph on `package.json` files.
+2. Build the repository in development mode with `pnpm [pnpm-filter?] build:dev` to make sure your local Maven repository (Usually `~/.m2/repository`) is populated.
+
+It's recommended to that before opening IntelliJ IDEA to make indexing faster once you do.
+
+Once prompted by IntelliJ IDEA, select "Open" and choose this folder.
+
+<img src="docs/intellij-open.png" alt="Open" style="max-width:600px; display:block" />
+<img src="docs/intellij-select-folder.png" alt="Select folder" style="max-width:600px; display:block" />
+
+---
+
+After you're done importing the project, please also configure the code formatter (or Code Style, in IntelliJ IDEA terminology.)
+
+Apache KIE Tools uses an Eclipse Formatter XML, so please install https://plugins.jetbrains.com/plugin/6546-adapter-for-eclipse-code-formatter and configure it like in the screenshot below:
+
+<img src="docs/intellij-eclipse-formatter-config.png" alt="Configure Eclipse formatter" style="width:600px" />
+
+
+---
+
+You should now be able to develop all Java- and Maven-based projects normally.
+
+---
+
+> For more information on Maven-based packages on KIE Tools, please refere to the [KIE Tools :: Manual](../repo/docs/MANUAL.md).
+
+
+