diff --git a/README.md b/README.md index 7ffef50..fb4fe65 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ SE Commons comprises the following components: * **se-commons-codestyle** * a gradle plugin `id 'de.se_rwth.codestyle'` which configures [spotless](https://github.com/diffplug/spotless) with the SE code style. +* **se-commons-catalog** + * a gradle catalog for easy dependency access to all SE libraries and plugins ## Licenses * [LGPL V3.0](https://github.com/MontiCore/monticore/tree/master/00.org/Licenses/LICENSE-LGPL.md) (for handwritten Java code) diff --git a/se-commons-catalog/README.md b/se-commons-catalog/README.md new file mode 100644 index 0000000..5b2a8f4 --- /dev/null +++ b/se-commons-catalog/README.md @@ -0,0 +1,34 @@ +# SE Catalog + +Simply add this to your `settings.gradle` file: + +```groovy +dependencyResolutionManagement { + repositories { + maven { + url "https://nexus.se.rwth-aachen.de/content/groups/public/" + } + } + versionCatalogs { + seLibs { + from("de.se_rwth.commons:se-commons-catalog:$mc_version") + } + } +} +``` + +You can then add any library or plugin using the `seLibs` variable inside your +`gradle.build`: + +```groovy +plugins { + alias(seLibs.plugins.mc.generator) +} + +dependencies { + implementation seLibs.mc.statecharts +} +``` + +Read more about version catalogs in +the [Gradle documentation](https://docs.gradle.org/current/userguide/version_catalogs.html). diff --git a/se-commons-catalog/build.gradle b/se-commons-catalog/build.gradle index 26658af..db7e02b 100644 --- a/se-commons-catalog/build.gradle +++ b/se-commons-catalog/build.gradle @@ -7,8 +7,9 @@ plugins { catalog { // declare the aliases, bundles and versions in this block versionCatalog { - library("se-logging", "de.se_rwth.commons", "se-commons-logging").version(version) - library("se-utilities", "de.se_rwth.commons", "se-commons-utilities").version(version) + library("se-commons-logging", "de.se_rwth.commons", "se-commons-logging").version(version) + library("se-commons-utilities", "de.se_rwth.commons", "se-commons-utilities").version(version) + library("se-commons-gradle", "de.se_rwth.commons", "se-commons-gradle").version(version) library("mc-lsp", "de.monticore.language-server", "monticore-language-server-runtime").version(version) library("mc-grammar", "de.monticore", "monticore-grammar").version(version) library("mc-runtime", "de.monticore", "monticore-runtime").version(version) @@ -22,8 +23,10 @@ catalog { library("mc-montifun", "de.monticore.lang", "montifun").version(version) library("mc-montiarc", "montiarc.languages", "montiarc").version(version) library("mc-montiarc-ma2jsim", "montiarc.generators", "ma2jsim").version(version) + library("mc-generator", "de.monticore.generator", "de.monticore.generator.gradle.plugin").version(version) + library("mc-language-server", "de.monticore.language-server", "de.monticore.language-server.gradle.plugin").version(version) - plugin("se-commons", "de.se_rwth.commons.se-commons-gradle").version(version) + plugin("se-commons-gradle", "de.se_rwth.commons.se-commons-gradle").version(version) plugin("mc-generator", "de.monticore.generator.de.monticore.generator.gradle.plugin").version(version) plugin("mc-language-server", "de.monticore.language-server.de.monticore.language-server.gradle.plugin").version(version) plugin("montiarc-jsim", "montiarc-jsim.gradle.plugin").version(version)