diff --git a/cli/src/main/resources/nls/Help.properties b/cli/src/main/resources/nls/Help.properties index 13c8bdbf6..cbab8e710 100644 --- a/cli/src/main/resources/nls/Help.properties +++ b/cli/src/main/resources/nls/Help.properties @@ -6,6 +6,7 @@ cmd.az=Tool commandlet for Azure CLI. cmd.az.detail=The Azure Command-Line Interface (CLI) is a tool for creating and managing Azure resources. Detailed documentation can be found at https://learn.microsoft.com/en-us/cli/azure/ cmd.build=Runs a build job with given arguments. cmd.build.val.args=Build arguments to be used when running a build job. +cmd.build.detail=The `build` commandlet is an abstraction of build systems like https://maven.apache.org/, https://gradle.org/, https://yarnpkg.com/, https://www.npmjs.com/, etc.\nIt will auto-detect your build-system (via existence of files like `pom.xml`, `package.json`, etc.). According to this detection, it will simply delegate to the according commandlet of the specific build system. If that build-system is not yet available it will be downloaded and installed automatically.\nSo `ide build` allows users to build any project without bothering about the build-system. Further specific build options can be configured per project. This makes `ide build` a universal part of every _definition of done_. Before pushing your changes, please always run the following command to verify the build:\n\n 'ide build'\n\nYou may also supply additional arguments as `ide build «args»`. This will simply delegate these arguments to the detected build command (e.g. call `mvn «args»`). cmd.cobigen=Tool commandlet for Cobigen (code-generator). cmd.cobigen.detail=TODO cobigen cmd.complete=Internal commandlet for bash auto-completion. diff --git a/cli/src/main/resources/nls/Help_de.properties b/cli/src/main/resources/nls/Help_de.properties index 006f9e320..09d5d7fe3 100644 --- a/cli/src/main/resources/nls/Help_de.properties +++ b/cli/src/main/resources/nls/Help_de.properties @@ -6,6 +6,7 @@ cmd.az=Werkzeug Kommando für Azure Kommandoschnittstelle. cmd.az.detail=Das Azure Command-Line Interface (CLI) ist ein Werkzeug zur Erstellung und Verwaltung von Azure Ressourcen. Detaillierte Dokumentation ist zu finden unter https://learn.microsoft.com/en-us/cli/azure/ cmd.build=Startet einen build Prozess mit übergebenen Argumenten. cmd.build.val.args=Argumente die bei dem build Prozess genutzt werden sollen. +cmd.build.detail=Der `build`-Befehl ist eine Abstraktion von Build-Systemen wie https://maven.apache.org/, https://gradle.org/, https://yarnpkg.com/, https://www.npmjs.com/ usw.\nEr erkennt automatisch Ihr Build-System (anhand von Dateien wie `pom.xml`, `package.json` usw.). Entsprechend dieser Erkennung delegiert er einfach an den entsprechenden Befehl des spezifischen Build-Systems. Wenn dieses Build-System noch nicht verfügbar ist, wird es automatisch heruntergeladen und installiert.\nSo ermöglicht `ide build` Benutzern, jedes Projekt zu erstellen, ohne sich um das Build-System kümmern zu müssen. Weitere spezifische Build-Optionen können pro Projekt konfiguriert werden. Dies macht `ide build` zu einem universellen Bestandteil jeder _Definition of Done_. Bevor Sie Ihre Änderungen übertragen, führen Sie bitte immer den folgenden Befehl aus, um den Build zu überprüfen:\n\n`ide build`\n\nSie können auch zusätzliche Argumente wie `ide build «args»` angeben. Diese werden einfach an den erkannten Build-Befehl weitergeleitet (z. B. Aufruf von `mvn «args»`). cmd.cobigen=Werkzeug Kommando für Cobigen. cmd.cobigen.detail=TODO DE cobigen cmd.complete=Internes Werkzeug für bash Autovervollständigung. diff --git a/documentation/build.adoc b/documentation/build.adoc deleted file mode 100644 index 0ecfa16f1..000000000 --- a/documentation/build.adoc +++ /dev/null @@ -1,12 +0,0 @@ -:toc: -toc::[] - -= build -The `build` commandlet is an abstraction of build systems like link:mvn.asciidoc[maven], link:gradle.asciidoc[gradle], link:npm.asciidoc[yarn], link:npm.asciidoc[npm], etc. -It will auto-detect your build-system (via existence of files like `pom.xml`, `package.json`, etc.). According to this detection, it will simply delegate to the according commandlet of the specific build system. If that build-system is not yet available it will be downloaded and installed automatically. - -So `ide build` allows users to build any project without bothering about the build-system. Further specific build options can be configured per project. This makes `ide build` a universal part of every _definition of done_. Before pushing your changes, please always run the following command to verify the build: - -`ide build` - -You may also supply additional arguments as `ide build «args»`. This will simply delegate these arguments to the detected build command (e.g. call `mvn «args»`). diff --git a/documentation/gradle.adoc b/documentation/gradle.adoc deleted file mode 100644 index 0fe46562b..000000000 --- a/documentation/gradle.adoc +++ /dev/null @@ -1,26 +0,0 @@ -:toc: -toc::[] - -= gradle - -The `gradle` commandlet allows to install, configure, and launch https://gradle.org/[gradle]. It is similar to https://docs.gradle.org/5.3.1/userguide/gradle_wrapper.html[gradle-wrapper]. So calling `ide gradle «args»` is more or less the same as calling `gradle «args»` but with the benefit that the version of gradle preferred by your project is used (and will be installed if not yet available). - -The arguments (`ide gradle «args»`) are explained by the following table: - -.Usage of `ide gradle` -[options="header"] -|======================= -|*Argument(s)* |*Meaning* -|`«args»` |run gradle with the given arguments (`«args»`) -|======================= - -There are link:variables.asciidoc[variables] that can be used for gradle. -These are explained by the following table: - -.Variables of IDEasy for gradle -[options="header"] -|======================= -|*Variable*|*Meaning* -|*`GRADLE_VERSION`* |The version of the tool gradle to install and use. -|*`GRADLE_BUILD_OPTS`* |The default arguments to use for the gradle build process e.g. `project1`. -|======================= diff --git a/documentation/mvn.adoc b/documentation/mvn.adoc deleted file mode 100644 index 43fa6a5a7..000000000 --- a/documentation/mvn.adoc +++ /dev/null @@ -1,27 +0,0 @@ -:toc: -toc::[] - -= mvn - -The `mvn` commandlet allows to install, configure, and launch https://maven.apache.org/[maven]. It is similar to https://github.com/takari/maven-wrapper[maven-wrapper] and https://github.com/dansomething/mdub[mdub]. So calling `ide mvn «args»` is more or less the same as calling `mvn «args»` but with the benefit that the version of maven preferred by your project is used (and will be installed if not yet available). - -The arguments (`ide mvn «args»`) are explained by the following table: - -.Usage of `ide mvn` -[options="header"] -|======================= -|*Argument(s)* |*Meaning* -| |run default build, link:configuration.asciidoc[configurable] via `MVN_BUILD_OPTS` -|`«args»` |run maven with the given arguments (`«args»`) -|======================= - -There are link:variables.asciidoc[variables] that can be used for mvn. -These are explained by the following table: - -.Variables of IDEasy for mvn -[options="header"] -|======================= -|*Variable*|*Meaning* -|*`MVN_VERSION`* |The version of the tool mvn to install and use. -|*`MVN_BUILD_OPTS`* |The default options to use for the mvn build process e.g. `clean install`. -|======================= diff --git a/documentation/npm.adoc b/documentation/npm.adoc deleted file mode 100644 index 6e51d4384..000000000 --- a/documentation/npm.adoc +++ /dev/null @@ -1,27 +0,0 @@ -:toc: -toc::[] - -= npm - -The `npm` commandlet allows to install, configure, and launch https://www.npmjs.com/[npm]. Calling `ide npm «args»` is more or less the same as calling `npm «args»` but with the benefit that the version of npm preferred by your project is used (and will be installed if not yet available). - -The arguments (`ide npm «args»`) are explained by the following table: - -.Usage of `ide npm` -[options="header"] -|======================= -|*Argument(s)* |*Meaning* -| |run default build, link:configuration.asciidoc[configurable] via `NPM_BUILD_OPTS` -|`«args»` |run NPM with the given arguments (`«args»`) -|======================= - -There are link:variables.asciidoc[variables] that can be used for npm. -These are explained by the following table: - -.Variables of IDEasy for npm -[options="header"] -|======================= -|*Variable*|*Meaning* -|*`NPM_VERSION`* |The version of the tool npm to install and use. -|*`NPM_BUILD_OPTS`* |The default options to use for the npm build process e.g. `run start`. -|======================= diff --git a/documentation/yarn.adoc b/documentation/yarn.adoc deleted file mode 100644 index f0d1bf38d..000000000 --- a/documentation/yarn.adoc +++ /dev/null @@ -1,26 +0,0 @@ -:toc: -toc::[] - -= yarn - -The `yarn` commandlet allows to install, configure, and launch https://www.npmjs.com/[npm]. Calling `ide yarn «args»` is more or less the same as calling `yarn «args»` but with the benefit that the version of npm preferred by your project is used (and will be installed if not yet available). - -The arguments (`ide yarn «args»`) are explained by the following table: - -.Usage of `ide yarn` -[options="header"] -|======================= -|*Argument(s)* |*Meaning* -|`«args»` |run yarn with the given arguments (`«args»`) -|======================= - -There are link:variables.asciidoc[variables] that can be used for yarn. -These are explained by the following table: - -.Variables of IDEasy for yarn -[options="header"] -|======================= -|*Variable*|*Meaning* -|*`YARN_VERSION`* |The version of the tool yarn to install and use. -|*`YARN_BUILD_OPTS`* |The default options to use for the yarn build process e.g. `run start`. -|=======================