mps-gradle-plugin 2.0.0-pre1

Author: sergej-koscejev

subprojects/mps-gradle-plugin/CHANGELOG.md

@@ -5,6 +5,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.0.0-pre1
+
+Breaking changes are to be expected until the final 2.0.0 release.
+
+### Added
+
+- Path variables can be specified in `mpsDefaults` and will be passed to both MPS and Ant tasks.
+- Support for multiple build scripts, including test build scripts.
+
+### 🚨 Changed
+
+- Automatic build script detection was removed, build scripts now have to be explicitly added to the `mpsBuilds`
+  container.
+- The plugin now applies the `jbr-toolchain` plugin and uses the runtime specified by the `jbr` configuration to run
+  Ant and MPS.
+- `stubs` renamed to `bundledDependencies`
+- 🚨 `com.specificlanguages.RunAntScript` replaced with `com.specificlanguages.mps.RunAnt` which uses modern Gradle
+  features: lazy properties and `JavaLauncher` for specifying the JVM to use.
+- 🚨 The `com.specificlanguages.mps` plugin no longer applies the `java-base` plugin.
+
+### 🚨 Removed
+
+- `mpsDefaults.javaExecutable` (previously deprecated in favor of `mpsDefaults.javaLauncher`).
+
 ## 1.9.0
 
 ### Added

subprojects/mps-gradle-plugin/README.md

@@ -1,39 +1,34 @@
-# MPS Gradle Plugin
+# MPS Gradle plugin
 
-A Gradle plugin to package and publish MPS plugins. Use it if you have developed a language in MPS and you want to make
-it easy for other developers to use your language in their projects.
+A Gradle plugin to package and publish MPS libraries. Use it if you have developed a library of plugins in MPS and you
+want to make it easy for other developers to use your language in their projects.
 
-Publishing MPS-based IDEs (rich client platforms) is out of scope for this plugin.
+Publishing MPS-based IDEs (RCPs, or rich client platforms) is out of scope for this plugin.
 
 This plugin also does not cover publishing to the JetBrains Plugins Repository.
 
 ## Compatibility
 
-This plugin has been tested with the following combinations of Gradle and MPS:
+This plugin has been tested with Gradle 8.13.
 
-* Gradle 7.1 or above is required since version 1.2.0.
-* Gradle 7.2 and MPS 2020.3.5 (version 1.1.0),
-* Gradle 5.6.2 and MPS 2019.2.4 (version 1.0.0),
-* Gradle 5.6.2 and MPS 2019.1.5 (version 0.0.2).
+> [!CAUTION]
+> The content below this point is outdated and will be rewritten.
 
-## Conventions and Assumptions
+## Conventions and assumptions
 
 To simplify the configuration the plugin makes certain assumptions and therefore your project must follow certain
 conventions.
 
 The following assumptions will hold if you let the MPS wizard generate your build solution and script:
 
 * The MPS project directory is assumed to coincide with the Gradle project directory.
-* The MPS project must contain a build model that is either named `build.mps` or matches `*.build.mps`. The build model
-  must use default persistence and not file-per-root persistence.
-* The build model must generate a `build.xml` file in the project's root directory.
 * The variable that specifies the location of MPS in the build script is called `mps_home`.
 
-The following conventions are different from the defaults and require manual adjustment of the generated build script:
+The following conventions are different from the defaults and you will have to adjust the generated build script to
+accomodate them:
 
 * The default layout should also include the build solution.
-* Instead of creating a .zip of all modules or plugins the default layout should just collect them in the top-level
-  folder:
+* Instead of creating a .zip of all modules or plugins the default layout should collect them in the top-level folder:
   ```
   default layout:
     module com.mbeddr.mpsutil.common 
@@ -45,8 +40,8 @@ The following conventions are different from the defaults and require manual adj
     plugin com.mbeddr.mpsutil.common [auto packaging]
       <empty>
   ```
-* Any dependencies will be put under `build/dependencies` folder and can be referenced from the project's base directory
-  (without using any path variables).
+* Any external dependencies will be put under `build/dependencies` folder and can be referenced from the project's base
+  directory (without using any path variables).
 
 ### Customizing Conventions
 
@@ -57,17 +52,16 @@ mpsDefaults {
     // Custom MPS home directory
     mpsHome.set(File("/my/mps/home"))
 
-    // Custom location and name of the build script
-    buildScript.set(file("build/build.xml"))
-    
     // Custom dependencies directory
     dependenciesDirectory.set("build/project-libraries")
 }
 ```
 
-## Sample Project
+## Sample project
 
-A sample project using the plugin can be found here: https://github.com/specificlanguages/mps-gradle-plugin-sample.
+A couple of small projects using the plugin can be found here:
+* [mps-json](https://github.com/specificlanguages/mps-json)
+* [mps-to-json-exporter](https://github.com/specificlanguages/mps-to-json-exporter), using mps-json as a dependency.
 
 ## Configuration
 
@@ -78,7 +72,7 @@ All code snippets below use Kotlin syntax for Gradle.
     ```kotlin
    // build.gradle.kts
     plugins {
-        id("com.specificlanguages.mps") version "1.8.0"
+        id("com.specificlanguages.mps") version "2.0.0-pre1"
     }
     ```
 
@@ -88,16 +82,16 @@ All code snippets below use Kotlin syntax for Gradle.
    // settings.gradle.kts
    pluginManagement {
        repositories {
-           maven(url = "https://artifacts.itemis.cloud/repository/maven-mps")
+           maven("https://artifacts.itemis.cloud/repository/maven-mps")
 
            // Gradle plugin portal must be added explicitly when using non-default repositories
            gradlePluginPortal()
        }
    }
    ```
 
-   This repository is used to
-   download [mps-build-backends Gradle MPS launcher](https://github.com/mbeddr/mps-build-backends/tree/main/launcher)
+   This repository is used to download
+   [mps-build-backends Gradle MPS launcher](https://github.com/mbeddr/mps-build-backends/tree/main/launcher)
    that is used to provide proper command line arguments to the backend in the next step, depending on the MPS version
    being run.
 
@@ -106,7 +100,7 @@ All code snippets below use Kotlin syntax for Gradle.
    ```kotlin
    // build.gradle.kts
    repositories {
-       maven(url = "https://artifacts.itemis.cloud/repository/maven-mps")
+       maven("https://artifacts.itemis.cloud/repository/maven-mps")
        mavenCentral()
    }
    ```
@@ -120,7 +114,7 @@ All code snippets below use Kotlin syntax for Gradle.
    ```kotlin
    // build.gradle.kts
    dependencies {
-       "mps"("com.jetbrains:mps:2021.1.4")
+       mps("com.jetbrains:mps:2024.3.1")
    }
    ```
 
@@ -129,16 +123,16 @@ All code snippets below use Kotlin syntax for Gradle.
     ```kotlin
    // build.gradle.kts
     dependencies {
-        "generation"("de.itemis.mps:extensions:2021.1.+")
+        generation("de.itemis.mps:extensions:2024.3.+")
     }
     ```
 
 6. Specify JAR dependencies that are used as stubs and where they should be placed:
 
     ```kotlin
    // build.gradle.kts
-    stubs {
-        register("stubs") {
+    bundledDependencies {
+        create("commonsLang") {
             destinationDir("solutions/my.stubs/lib")
             dependency("org.apache.commons:commons-lang3:3.12.0")
             ...
@@ -160,15 +154,15 @@ All code snippets below use Kotlin syntax for Gradle.
        publications {
            register<MavenPublication>("mpsPlugin") {
                from(components["mps"])
-   
+
                // Put resolved versions of dependencies into POM files
                versionMapping { usage("java-runtime") { fromResolutionOf("generation") } }
            }
        }
    }
    ```
 
-## Effects of Applying the Plugin
+## Effects of applying the plugin
 
 The plugin applies the [Gradle Base plugin](https://docs.gradle.org/current/userguide/base_plugin.html) which creates a
 set of _lifecycle tasks_ such as `clean`, `assemble`, `check`, or `build`.
@@ -178,16 +172,12 @@ The plugin creates the following tasks:
 * `setup`: unpacks all dependencies of the `generation` configuration into `build/dependencies`. Since 1.2.0 it also
   triggers the individual tasks to unpack stubs, see below. Executing the `setup` task is required before the project
   can be opened in MPS.
-* ~~`resolveMpsForGeneration`: downloads the MPS artifact specified by the `mps` configuration and unpacks it into
-  `build/mps`.~~ (Removed in 1.4.0.)
-* `resolve<StubName>`: a [Sync](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Sync.html) task created
-  for each stub block (`<StubName>` is the name of the stub entry, capitalized). The task resolves the dependencies
-  configured in the stub block and copies them into the specified destination directory of the stub, deleting any other
+* `resolve<Name>`: a [Sync](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Sync.html) task created
+  for each 'bundled dependency' object (`<Name>` is the name of the object, capitalized). The task resolves
+  the dependencies configured in the object and copies them into the specified destination directory, deleting any other
   files present in that directory. When copying the dependencies their version numbers are stripped. This makes it
   possible to upgrade dependency versions in the Gradle build script without also reconfiguring the MPS stub solutions.
-* `generateBuildscript`: generates the build script using MPS. The build model location is detected automatically. 
-  Since 1.2.2 the task specifies all module files (`*.msd`, `*.mpl`, `*.devkit`) as its inputs since build scripts 
-  check their contents against the modules.
+* `generateBuildscripts`: generates the build scripts using MPS. The build model location is detected automatically.
 * `assembleMps`: runs `generate` and `assemble` targets of the generated Ant script. The `assemble` lifecycle task is
   set to depend on `assembleMps`. Since 1.1.1 the version of the project is passed to Ant via `-Dversion=${project.
   version}`. Since 1.2.2 the task specifies all `*.mps` files in all directories as its inputs.
@@ -199,23 +189,11 @@ The plugin creates the following tasks:
 The plugin creates a software component named `mps` to represent the published code and adds the `default` configuration
 to it.
 
-The plugin modifies the `clean` task to delete MPS-generated directories: `source_gen`, `source_gen.caches`,
-`classes_gen`, `tests_gen`, and `tests_gen.caches`. This is in addition to the default operation of `clean` task which
-deletes the project's build directory (`build`).
-
-## Downloading and Unzipping MPS
-
-Before version 1.4.0 the plugin declared a task, `resolveMpsForGeneration`, to download and unzip the MPS distribution
-under `build/mps`. In 1.4.0 and above this is handled via Gradle artifact transforms. This should enable sharing the
-MPS distributions between projects that use the same MPS version (for example, among subprojects of a large project).
-
-The task is left empty in 1.4.0 for backwards compatibility purposes.
-
-## Task Dependency Graph
+## Task dependency graph
 
 ```mermaid
 flowchart RL
-  setup --> resolveStub["resolve{STUB1,...,STUBn}"]
+  setup --> resolveBundledDependencies["resolve{BD1,...,BDn}"]
   setup --> resolveGenerationDependencies
   
   assemble --> assembleMps

subprojects/mps-gradle-plugin/api/mps-gradle-plugin.api

@@ -1,43 +1,77 @@
-public abstract interface class com/specificlanguages/MpsDefaultsExtension {
-	public abstract fun getBuildScript ()Lorg/gradle/api/file/RegularFileProperty;
+public abstract class com/specificlanguages/mps/BundledDependency : org/gradle/api/Named {
+	public fun <init> (Ljava/lang/String;)V
+	public abstract fun getConfiguration ()Lorg/gradle/api/provider/Property;
+	public final fun getConfigurationName ()Ljava/lang/String;
+	public abstract fun getDependency ()Lorg/gradle/api/artifacts/dsl/DependencyCollector;
+	public abstract fun getDestinationDir ()Lorg/gradle/api/file/DirectoryProperty;
+	public fun getName ()Ljava/lang/String;
+	public abstract fun getSyncTask ()Lorg/gradle/api/provider/Property;
+}
+
+public abstract class com/specificlanguages/mps/GenerateBuildScripts : org/gradle/api/DefaultTask {
+	public fun <init> ()V
+	public abstract fun getBuildSolutionDescriptors ()Lorg/gradle/api/file/ConfigurableFileCollection;
+	protected abstract fun getExecOperations ()Lorg/gradle/process/ExecOperations;
+	public abstract fun getGenerateBackendClasspath ()Lorg/gradle/api/file/ConfigurableFileCollection;
+	public abstract fun getJavaLauncher ()Lorg/gradle/api/provider/Property;
+	public abstract fun getMpsHome ()Lorg/gradle/api/file/DirectoryProperty;
+	protected abstract fun getObjects ()Lorg/gradle/api/model/ObjectFactory;
+	public abstract fun getPathVariables ()Lorg/gradle/api/provider/MapProperty;
+	public abstract fun getProjectDirectory ()Lorg/gradle/api/file/DirectoryProperty;
+	public final fun make ()V
+}
+
+public abstract class com/specificlanguages/mps/MainBuild : com/specificlanguages/mps/MpsBuild {
+	public fun <init> (Ljava/lang/String;)V
+	public abstract fun getAssembleTask ()Lorg/gradle/api/provider/Property;
+	public abstract fun getPackageTask ()Lorg/gradle/api/provider/Property;
+}
+
+public abstract class com/specificlanguages/mps/MpsBuild : org/gradle/api/Named {
+	public fun <init> (Ljava/lang/String;)V
+	public final fun dependsOn ([Lcom/specificlanguages/mps/MainBuild;)V
+	public abstract fun getArtifactsDirectory ()Lorg/gradle/api/file/DirectoryProperty;
+	public abstract fun getBuildFile ()Lorg/gradle/api/file/RegularFileProperty;
+	public abstract fun getBuildProjectName ()Lorg/gradle/api/provider/Property;
+	public abstract fun getBuildSolutionDescriptor ()Lorg/gradle/api/file/RegularFileProperty;
+	public abstract fun getDependencies ()Lorg/gradle/api/provider/SetProperty;
+	public abstract fun getGenerateTask ()Lorg/gradle/api/provider/Property;
+	public fun getName ()Ljava/lang/String;
+}
+
+public abstract interface class com/specificlanguages/mps/MpsDefaultsExtension {
+	public abstract fun getAntClasspath ()Lorg/gradle/api/file/ConfigurableFileCollection;
 	public abstract fun getDependenciesDirectory ()Lorg/gradle/api/file/DirectoryProperty;
-	public abstract fun getJavaExecutable ()Lorg/gradle/api/file/RegularFileProperty;
 	public abstract fun getJavaLauncher ()Lorg/gradle/api/provider/Property;
 	public abstract fun getMpsHome ()Lorg/gradle/api/file/DirectoryProperty;
+	public abstract fun getPathVariables ()Lorg/gradle/api/provider/MapProperty;
 }
 
-public class com/specificlanguages/MpsPlugin : org/gradle/api/Plugin {
+public class com/specificlanguages/mps/MpsPlugin : org/gradle/api/Plugin {
 	public fun <init> (Lorg/gradle/api/component/SoftwareComponentFactory;Lorg/gradle/jvm/toolchain/JavaToolchainService;)V
 	public synthetic fun apply (Ljava/lang/Object;)V
 	public fun apply (Lorg/gradle/api/Project;)V
 }
 
-public abstract class com/specificlanguages/RunAntScript : org/gradle/api/DefaultTask {
+public abstract class com/specificlanguages/mps/RunAnt : org/gradle/api/DefaultTask {
 	public fun <init> ()V
-	public fun build ()V
-	public final fun configureJavaExec (Lorg/gradle/api/Action;)V
-	public abstract fun getAdditionalConfigurationActions ()Lorg/gradle/api/provider/ListProperty;
-	public abstract fun getAntProperties ()Lorg/gradle/api/provider/MapProperty;
-	public abstract fun getBuildScript ()Lorg/gradle/api/file/RegularFileProperty;
-	public abstract fun getClasspath ()Lorg/gradle/api/provider/Property;
+	public final fun build ()V
+	public abstract fun getBuildFile ()Lorg/gradle/api/file/RegularFileProperty;
+	public abstract fun getClasspath ()Lorg/gradle/api/file/ConfigurableFileCollection;
+	public abstract fun getEnvironment ()Lorg/gradle/api/provider/MapProperty;
 	protected abstract fun getExecOperations ()Lorg/gradle/process/ExecOperations;
-	public abstract fun getJavaExecutable ()Lorg/gradle/api/file/RegularFileProperty;
-	public abstract fun getScriptArgs ()Lorg/gradle/api/provider/ListProperty;
+	public abstract fun getJavaLauncher ()Lorg/gradle/api/provider/Property;
+	public abstract fun getJvmArguments ()Lorg/gradle/api/provider/ListProperty;
+	public abstract fun getOptions ()Lorg/gradle/api/provider/ListProperty;
+	public abstract fun getPathProperties ()Lorg/gradle/api/provider/MapProperty;
 	public abstract fun getTargets ()Lorg/gradle/api/provider/ListProperty;
+	protected abstract fun getToolchains ()Lorg/gradle/jvm/toolchain/JavaToolchainService;
+	public abstract fun getValueProperties ()Lorg/gradle/api/provider/MapProperty;
+	public abstract fun getWorkingDirectory ()Lorg/gradle/api/file/DirectoryProperty;
 }
 
-public abstract class com/specificlanguages/StubConfiguration : org/gradle/api/Named {
-	public fun <init> (Lorg/gradle/api/Project;Ljava/lang/String;)V
-	public final fun dependency (Ljava/lang/Object;)Lorg/gradle/api/artifacts/Dependency;
-	public final fun dependency (Ljava/lang/Object;Lgroovy/lang/Closure;)Lorg/gradle/api/artifacts/Dependency;
-	public final fun dependency (Ljava/lang/String;Lkotlin/jvm/functions/Function1;)Lorg/gradle/api/artifacts/ExternalModuleDependency;
-	public final fun dependency (Lorg/gradle/api/artifacts/ModuleDependency;Lkotlin/jvm/functions/Function1;)Lorg/gradle/api/artifacts/ModuleDependency;
-	public final fun destinationDir (Ljava/lang/Object;)V
-	public final fun getConfiguration ()Lorg/gradle/api/NamedDomainObjectProvider;
-	public abstract fun getDestinationDir ()Lorg/gradle/api/file/DirectoryProperty;
-	public fun getName ()Ljava/lang/String;
-	public final fun project (Ljava/lang/String;Ljava/lang/String;)Lorg/gradle/api/artifacts/ProjectDependency;
-	public final fun project (Ljava/util/Map;)Lorg/gradle/api/artifacts/Dependency;
-	public static synthetic fun project$default (Lcom/specificlanguages/StubConfiguration;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Lorg/gradle/api/artifacts/ProjectDependency;
+public abstract class com/specificlanguages/mps/TestBuild : com/specificlanguages/mps/MpsBuild {
+	public fun <init> (Ljava/lang/String;)V
+	public abstract fun getAssembleAndCheckTask ()Lorg/gradle/api/provider/Property;
 }
 

subprojects/mps-gradle-plugin/build.gradle.kts

@@ -9,17 +9,26 @@ repositories {
 dependencies {
     implementation(kotlin("stdlib-jdk8"))
     implementation(project(":artifact-transforms"))
+    implementation(project(":jbr-toolchain"))
     implementation("de.itemis.mps.build-backends:launcher:2.5.2.120.c791da5")
+
+    testImplementation("org.hamcrest:hamcrest:3.0")
+    testImplementation("org.junit.jupiter:junit-jupiter:5.12.0")
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
 }
 
 gradlePlugin {
     plugins {
         register("mps") {
             id = "com.specificlanguages.mps"
-            implementationClass = "com.specificlanguages.MpsPlugin"
+            implementationClass = "com.specificlanguages.mps.MpsPlugin"
             displayName = "MPS Build Plugin"
-            description = "Builds JetBrains MPS projects using a simple declarative configuration model"
+            description = "Build JetBrains MPS projects using a simple declarative configuration model"
             tags.set(listOf("jetbrainsMps"))
         }
     }
 }
+
+tasks.test {
+    useJUnitPlatform()
+}

subprojects/mps-gradle-plugin/gradle.properties

@@ -1 +1 @@
-version=1.9.0
+version=2.0.0-pre1