feat: initial working version of the plugin

.gitignore

@@ -0,0 +1,3 @@
+.gradle
+build
+.idea

README.md

@@ -0,0 +1,122 @@
+#🏗️ Auto Composite Build
+
+A Gradle plugin that can be used to prevent the paths references problem of the Gradle's composite build feature.
+Currently, composite builds works in such way that if a team uses this for a common logic project,
+all the participants' computers need to clone the common logic project & the projects that use it in the exact same way.
+
+### A demonstration for the problem of Gradle's composite build:
+Let's assume one computer #1 cloned project `common-logic` to `C:\\code\common-logic` and uses it in `C:\\code\service1`.
+```
+computer #1
+└── C:\\
+    └── code
+        ├── common-logic
+        └── service1
+```
+So `C:\\code\service1` will have the line of `include("../common-logic")` 
+or `include("C:\\code\common-logic")` on `settings.gradle`.
+<br>Another had the following hierarchy.
+```
+computer #2
+└── C:\\
+    ├── my-code
+    │   └── common-logic
+    └── service1
+```
+So `C:\\service1` will need to have the line of `include("../my-code/common-logic")` 
+or `include("C:\\my-code\common-logic")` on `settings.gradle`.
+<br>In both declarations, if the `settings.gradle` file will get uploaded to Git, the Gradle's composite build feature will break.
+
+## How Auto Composite Build solved this?
+The Auto Composite Build plugin registers `common-logic` to a global file inside the user's home. 
+Projects can query the module from the file, and it doesn't matter the structure of the projects on the developer's computer.
+```
+computer #1
+└── C:\\
+    ├── my-code
+    │   └── common-logic
+    ├── service1
+    └── Users
+        └── OurExampleUser
+            └── .auto-composite-build
+                └── git.details
+```
+
+## Usage
+
+#### Kotlin DSL
+
+`build.gradle`
+```kotlin
+plugins {
+    id ("auto-composite-build") version ("1.0-SNAPSHOT")
+}
+
+autoCompositeBuild {
+    modulesNames = listOf("my-first-app", "my-second-app")
+    dslLang = io.github.almogtavor.DslLang.KOTLIN
+}
+```
+
+In the kotlin-based `settings.gradle.kts`:
+```kotlin
+import java.io.File
+
+var compositeBuildFileName = "composite-build.gradle.kts"
+if (file(compositeBuildFileName).exists()) {
+    apply {
+        from(compositeBuildFileName)
+    }
+    if (extra.has("modulesPaths")) {
+        @Suppress("UNCHECKED_CAST")
+        for (modulePath: String in (extra["modulesPaths"] as List<String>)) {
+            if (File(modulePath).exists()) {
+                includeBuild(modulePath)
+            }
+        }
+    }
+}
+```
+
+#### Groovy DSL
+
+`build.gradle`
+```groovy
+plugins {
+    id "auto-composite-build" version "1.0.0"
+}
+
+autoCompositeBuild {
+    modulesNames = List.of('my-first-app', 'my-second-app')
+    dslLang = "groovy"
+}
+```
+
+In the groovy-based `settings.gradle`:
+```groovy
+def compositeBuildFileName = 'composite-build.gradle'
+if (file(compositeBuildFileName).exists()) {
+    apply from: compositeBuildFileName
+    if (modulesPaths != null) {
+        for (modulePath in modulesPaths) {
+            includeBuild(modulePath)
+        }
+    }
+}
+```
+
+## Available Tasks
+
+* `./gradlew addRepoToGitDetails` - Adds the current repository to the local `.gradle-auto-composite-build` folder.<br>
+    **You should run this task for every project you'd like to include as composite build.**
+* `./gradlew includeModulesAsCompositeBuilds` - This task generates the `composite-build.gradle` or `composite-build.gradle.kts`
+    that holds the paths for the modules that should be included.<br>
+    This task must run only after you've run `addRepoToGitDetails` in all the modules that you've configured to include.
+* `./gradlew deleteGitDetails` - Should not be used. This was implemented only for edge cases. 
+    This task deletes the `git-details` file.
+
+### Limitations
+
+In case of moving the path of the repository of a module that is included as a composite build, the plugin will throw an error.
+To get away with this you should rerun the `./gradlew addRepoToGitDetails` task.
+In edge cases there's `./gradlew deleteGitDetails` which will allow you to delete your local's `git.details` file.

build.gradle

@@ -0,0 +1,31 @@
+plugins {
+    id 'java-gradle-plugin'
+    id "com.gradle.plugin-publish" version "1.0.0"
+    id 'idea'
+}
+
+group = 'io.github.almogtavor'
+version = '1.0.0'
+
+
+// Specify plugin properties that apply to the whole publishing bundle (ie. all plugins in the current publication).
+pluginBundle {  // Removed in Gradle 8+
+    vcsUrl = 'https://github.com/almogtavor/auto-composite-build'
+
+    // Individual tags for published plugins; overrides bundle tags for the mentioned plugins.
+    // The keys used to specify the plugins must match the names of the blocks in 'gradlePlugin.plugins' (see below).
+    pluginTags = [
+            autoCompositeBuildPlugin: ['gradle', 'composite-build']
+    ]
+}
+
+gradlePlugin {
+    plugins {
+        autoCompositeBuildPlugin {
+            id = 'auto-composite-build'
+            implementationClass = 'io.github.almogtavor.AutoCompositeBuildPlugin'
+            displayName = 'A Gradle plugin to automate the process of working with composite builds'
+            description = 'This Gradle plugin let you easily use composite build within a team.'
+        }
+    }
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.1-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -0,0 +1,185 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed 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
+#
+#      https://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.
+#
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MSYS* | MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=`expr $i + 1`
+    done
+    case $i in
+        0) set -- ;;
+        1) set -- "$args0" ;;
+        2) set -- "$args0" "$args1" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=`save "$@"`
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+exec "$JAVACMD" "$@"