[FIX] Update help description for "use" and "--framework-version"

Updates according to new features via SAP/ui5-project#649 JIRA: CPOUI5FOUNDATION-722
SAP · Sep 5, 2023 · b042542 · b042542
1 parent 99a23f2
commit b042542
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 4 deletions.
diff --git a/lib/cli/commands/build.js b/lib/cli/commands/build.js
@@ -101,7 +101,8 @@ build.builder = function(cli) {
  array: true
  })
  .option("framework-version", {
- describe: "Overrides the framework version defined by the project",
+ describe: "Overrides the framework version defined by the project. " +
+ "Takes the same value as the version part of \"ui5 use\"",
  type: "string"
  })
  .option("cache-mode", {

diff --git a/lib/cli/commands/serve.js b/lib/cli/commands/serve.js
@@ -62,7 +62,8 @@ serve.builder = function(cli) {
  type: "boolean"
  })
  .option("framework-version", {
- describe: "Overrides the framework version defined by the project",
+ describe: "Overrides the framework version defined by the project. " +
+ "Takes the same value as the version part of \"ui5 use\"",
  type: "string"
  })
  .option("cache-mode", {

diff --git a/lib/cli/commands/tree.js b/lib/cli/commands/tree.js
@@ -24,7 +24,8 @@ tree.builder = function(cli) {
  })
  .option("framework-version", {
  describe:
- "Overrides the framework version defined by the project",
+ "Overrides the framework version defined by the project. " +
+ "Takes the same value as the version part of \"ui5 use\"",
  type: "string"
  })
  .option("cache-mode", {

diff --git a/lib/cli/commands/use.js b/lib/cli/commands/use.js
@@ -12,7 +12,11 @@ useCommand.builder = function(cli) {
  .positional("framework-info", {
  describe: "Framework name, version or both (name@version).\n" +
  "Name can be \"SAPUI5\" or \"OpenUI5\" (case-insensitive).\n" +
- "Version can be \"latest\" (default), \"1.xx\" or \"1.xx.x\".",
+ "Version can be \"latest\" (default), a version or range according to the Semantic Versioning specification (https://semver.org/), " +
+ "or a tag available in the npm registry.\n" +
+ "For SAP-internal usage the version can also be \"latest-snapshot\", " +
+ "a version or range ending with -SNAPSHOT, " +
+ "or a simplified range such as \"1-SNAPSHOT\", \"1.x-SNAPSHOT\" or \"1.108-SNAPSHOT\".",
  type: "string"
  })
  .example("$0 use sapui5@latest", "Use SAPUI5 in the latest available version")