@sap-ux/create 0.8.49 → 0.8.50

package/README.md

@@ -1,14 +1,13 @@
 # @sap-ux/create
 Module which provides command line interface to configure features for SAP UX projects or applications.
 
-To see usage, run
+## Installation
 
 ```sh
-npm init @sap-ux@latest 
+npm init @sap-ux@latest
 # or
 npx @sap-ux/create@latest
 ```
-
 To avoid downloading and installing the module every time it is used, you might consider installing it globally or add it as `devDependency` to a project. Once installed, you can run it using
 
 ```sh
@@ -17,58 +16,144 @@ sap-ux
 # locally
 npx sap-ux
 ```
+## Basic usage
 
-## add
-Calling `sap-ux add` allows adding a feature to a project.
-
-### html
-Calling `sap-ux add html` will add html files for local preview and testing to the project. It will use the configuration from the `ui5.yaml` as default, as provided by the `fiori-tools-preview` or `preview-middleware` e.g.:
 ```sh
-sap-ux change add html ui5-test.yaml
+npx sap-ux [command] [sub-command] /path/to/project
+```
+`Note:` If the project path is not provided, the current working directory will be used.
+
+Options:
+  - `-v | --version` output the module version number
+  - `-h | --help` display help and options for module
+
+### Command Options
+
+To use a option for a specific command run:
+```sh 
+npx sap-ux [command] [sub-command] [options]
 ```
+To see options for a specific command run: `npx sap-ux [command] [sub-command] -h`
+
+Common Options:
+- `-h | --help` display help and options for command
+- `-v | --verbose` show verbose information
+- `-s | --simulate` simulate only do not write config; sets also --verbose
+
+## Command Overview
+The `@sap-ux/create` modules provides commands for the following cases:
+- `sap-ux add` - allows adding a feature
+- `sap-ux change` allows changing a feature
+- `sap-ux remove` allows removing a feature
+- `sap-ux generate` allows generating a new project
+
+
+## sap-ux add
+Calling `sap-ux add` allows adding a feature to a project.
+
+
 ### annotations
 Calling `sap-ux add annotations` allows adding an annotation to the OData Source of the base application in an adaptation project.
 ```sh
-sap-ux add annotations /path/to/adaptation-project
+sap-ux add annotations [path]
+```
+- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5.yaml`
+
+
+### cards-editor
+Calling `sap-ux add cards-editor` adds a cards editor configuration to a project. To prevent overwriting, existing inbounds will be checked.
+```sh
+sap-ux add cards-editor [path]
+```
+- `-n | --skip-install` skip npm install step
+
+### component-usages
+Calling `sap-ux add component-usages` adds the component usages to an adaptation project.
+```sh
+sap-ux add component-usages [path]
+```
+
+
+### cds-plugin-ui5
+Calling `sap-ux add cds-plugin-ui5` adds the cds-plugin-ui5 and all prerequisites to a CAP project.
+```sh
+sap-ux add cds-plugin-ui5 [path]
 ```
+- `-n | --skip-install` skip npm install step
+
+
 ### deploy-config
-Calling `sap-ux add deploy-config` will prompt for ABAP deployment configuration details and add/update the project files accordingly
+Calling `sap-ux add deploy-config` will prompt for ABAP deployment configuration details and add/update the project files accordingly.
+```sh
+sap-ux add deploy-config [path]
+```
+- `-t | --target` target for deployment; ABAP or Cloud Foundry (not yet implemented)
+- `-b | --base-file` the base file config file of the project; default: ui5.yaml
+- `-d | --deploy-file` the name of the deploy config file to be written; default: ui5-deploy.yaml
+
+
+### html
+Calling `sap-ux add html` will add html files for local preview and testing to the project. It will use the configuration from the `ui5.yaml` as default, as provided by the `fiori-tools-preview` or `preview-middleware`.
 ```sh
-sap-ux add deploy-config /path/to/project
+sap-ux add html [path]
 ```
-#### deploy-config options: 
-`--target` abap | cf (cf deploy config inquirer not yet implemented)\
-`--base-file` e.g ui5.yaml\
-`--deploy-file` e.g. ui5-deploy.yaml
+- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5.yaml`
 
 ### model
-Calling `sap-ux add model` allows to add new OData Service and SAPUI5 Model to an existing adaptation project.  
+Calling `sap-ux add model` allows to add new OData Service and SAPUI5 Model to an existing adaptation project.
 ```sh
-sap-ux add model /path/to/adaptation-project
+sap-ux add model [path]
 ```
-If the project path is not provided, the current working directory will be used.
 
-## change
+### mockserver-config
+Calling `sap-ux add mockserver-config` adds the necessary configuration for mockserver module @sap-ux/ui5-middleware-fe-mockserver. 
+```sh
+sap-ux add mockserver-config [path]
+```
+- `-i | --interactive` ask for config options, otherwise use defaults'
+- `-n | --skip-install` skip npm install step
+
+### smartlinks-config
+Calling `sap-ux add smartlinks-config` adds a smartLinks configuration to a project 
+```sh
+sap-ux add smartlinks-config [path]
+```
+
+### variants-config
+Calling `sap-ux add variants-config` will add the necessary configuration to existing yaml files and the script to package.json for variants management. It will use the configuration from the `ui5.yaml` as default, as provided by the `fiori-tools-preview` or `preview-middleware`.
+```sh
+sap-ux add variants-config [path]
+```
+- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5.yaml`
+
+## sap-ux change
 Calling `sap-ux change` allows changing a feature of a project.
 
 ### data-source
 Calling `sap-ux change data-source` allows replacing the OData Source of the base application in an adaptation project.  
 ```sh
-sap-ux change data-source /path/to/adaptation-project
+sap-ux change data-source [path]
 ```
-If the project path is not provided, the current working directory will be used.
+- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5.yaml`
 
 ### inbound
 Calling `sap-ux change inbound` allows replacing the Inbound FLP configurations of the base application in an adaptation project.  
 ```sh
-sap-ux change inbound /path/to/adaptation-project
+sap-ux change inbound [path]
 ```
-If the project path is not provided, the current working directory will be used.
 
-## remove
+## sap-ux remove
 Calling `sap-ux remove` allows removing a feature to a project.
 
-## generate
+### mockserver-config
+Calling `sap-ux remove mockserver-config` removes the configuration for mockserver module @sap-ux/ui5-middleware-fe-mockserver. 
+```sh
+sap-ux remove mockserver-config [path]
+```
+- `-f | --force` do not ask for confirmation when deleting files
+
+
+## sap-ux generate
 Calling `sap-ux generate` allows generating a new project.
 
 ### adaptation-project
@@ -76,4 +161,12 @@ Calling `sap-ux generate adaptation-project` allows generating a new adaptation
 ```sh
 sap-ux generate adaptation-project --id my.adp --reference the.original.app --url http://my.sapsystem.example
 ```
-Additional options are `--skip-install` to skip running `npm install` after the project generation and `--simulate` to only simulate the files that would be generated instead of writing them to the file system.
+- `-n | --skip-install` skip npm install step
+- `-y | --yes` use default values for all prompts
+- `--id [id]` id of the adaptation project
+- `--reference [reference]` id of the original application
+- `--url [url]` url pointing to the target system containing the original app
+- `--ignoreCertErrors` ignore certificate errors when connecting to the target system
+- `--ft` enable the Fiori tools for the generated project
+- `--package [package]` ABAP package to be used for deployments
+- `--transport [transport]` ABAP transport to be used for deployments

package/dist/cli/add/cards-editor.js

@@ -26,7 +26,7 @@ function addCardsEditorConfigCommand(cmd) {
  * Adds an cards editor config to an app. To prevent overwriting existing inbounds will be checked.
  *
  * @param basePath - path to application root
- * @param simulate - if true, do not write but just show what would be change; otherwise write
+ * @param simulate - if true, do not write but just show what would be changed; otherwise write
  * @param skipInstall - if true, do not run npm install
  */
 async function addCardsEditorConfig(basePath, simulate, skipInstall) {

package/dist/cli/add/cds-plugin-ui.js

@@ -26,7 +26,7 @@ function addAddCdsPluginUi5Command(cmd) {
  * Add cds-plugin-ui5 and all prerequisites to a CAP project.
  *
  * @param basePath - CAP project root
- * @param simulate - if true, do not write but just show what would be change; otherwise write
+ * @param simulate - if true, do not write but just show what would be changed; otherwise write
  * @param skipInstall - if true, skip execution of npm install
  */
 async function addCdsPluginUi5(basePath, simulate, skipInstall) {

package/dist/cli/add/html.js

@@ -29,7 +29,7 @@ function addAddHtmlFilesCmd(cmd) {
  * Adds the virtual html files hosted by the preview middleware to the file system.
  *
  * @param basePath - path to application root
- * @param simulate - if true, do not write but just show what would be change; otherwise write
+ * @param simulate - if true, do not write but just show what would be changed; otherwise write
  * @param yamlPath - path to the ui5*.yaml file
  */
 async function addHtmlFiles(basePath, simulate, yamlPath) {

package/dist/cli/add/index.js

@@ -12,6 +12,7 @@ const annotations_to_odata_1 = require("./annotations-to-odata");
 const html_1 = require("./html");
 const component_usages_1 = require("./component-usages");
 const deploy_config_1 = require("./deploy-config");
+const variants_config_1 = require("./variants-config");
 /**
  * Return 'create-fiori add *' commands. Commands include also the handler action.
  *
@@ -39,6 +40,8 @@ function getAddCommands() {
     (0, component_usages_1.addComponentUsagesCommand)(addCommands);
     // create-fiori add deploy-config
     (0, deploy_config_1.addDeployConfigCommand)(addCommands);
+    // create-fiori add variants-config
+    (0, variants_config_1.addAddVariantsConfigCommand)(addCommands);
     return addCommands;
 }
 //# sourceMappingURL=index.js.map

package/dist/cli/add/mockserver-config.js

@@ -30,7 +30,7 @@ function addAddMockserverConfigCommand(cmd) {
  * Adds a mockserver config to an app or project.
  *
  * @param basePath - path to application root
- * @param simulate - if true, do not write but just show what would be change; otherwise write
+ * @param simulate - if true, do not write but just show what would be changed; otherwise write
  * @param skipInstall - if true, skip execution of npm install
  * @param interactive - if true, prompt user for config options, otherwise use defaults
  */

package/dist/cli/add/navigation-config.js

@@ -24,7 +24,7 @@ function addInboundNavigationConfigCommand(cmd) {
  * Adds an inbound navigation config to an app. To prevent overwriting existing inbounds will be checked.
  *
  * @param basePath - path to application root
- * @param simulate - if true, do not write but just show what would be change; otherwise write
+ * @param simulate - if true, do not write but just show what would be changed; otherwise write
  */
 async function addInboundNavigationConfig(basePath, simulate) {
     const logger = (0, tracing_1.getLogger)();

package/dist/cli/add/smartlinks-config.js

@@ -24,7 +24,7 @@ function addAddSmartLinksConfigCommand(cmd) {
  * Adds a smartLinks config to an app or project.
  *
  * @param basePath - path to application root
- * @param simulate - if true, do not write but just show what would be change; otherwise write
+ * @param simulate - if true, do not write but just show what would be changed; otherwise write
  */
 async function addSmartLinksConfig(basePath, simulate) {
     const logger = (0, tracing_1.getLogger)();

package/dist/cli/add/variants-config.d.ts

@@ -0,0 +1,8 @@
+import type { Command } from 'commander';
+/**
+ * Add the "add variants config" command to a passed command.
+ *
+ * @param cmd - commander command for adding variants config command
+ */
+export declare function addAddVariantsConfigCommand(cmd: Command): void;
+//# sourceMappingURL=variants-config.d.ts.map

package/dist/cli/add/variants-config.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addAddVariantsConfigCommand = addAddVariantsConfigCommand;
+const tracing_1 = require("../../tracing");
+const validation_1 = require("../../validation");
+const app_config_writer_1 = require("@sap-ux/app-config-writer");
+const path_1 = require("path");
+/**
+ * Add the "add variants config" command to a passed command.
+ *
+ * @param cmd - commander command for adding variants config command
+ */
+function addAddVariantsConfigCommand(cmd) {
+    cmd.command('variants-config [path]')
+        .option('-c, --config <string>', 'Path to project configuration file in YAML format', 'ui5.yaml')
+        .option('-s, --simulate', 'simulate only do not write config; sets also --verbose')
+        .option('-v, --verbose', 'show verbose information')
+        .action(async (path, options) => {
+        if (options.verbose === true || options.simulate) {
+            (0, tracing_1.setLogLevelVerbose)();
+        }
+        await addVariantsConfig(path || process.cwd(), !!options.simulate, options.config);
+    });
+}
+/**
+ * Adds a variants config to an app or project.
+ *
+ * @param basePath - the base path where the package.json and ui5.yaml is
+ * @param simulate - if true, do not write but just show what would be changed; otherwise write
+ * @param yamlPath - path to the ui5*.yaml file
+ */
+async function addVariantsConfig(basePath, simulate, yamlPath) {
+    const logger = (0, tracing_1.getLogger)();
+    try {
+        logger.debug(`Called add variants-config for path '${basePath}', simulate is '${simulate}'`);
+        const ui5ConfigPath = (0, path_1.isAbsolute)(yamlPath) ? yamlPath : (0, path_1.join)(basePath, yamlPath);
+        await (0, validation_1.validateBasePath)(basePath, ui5ConfigPath);
+        const fs = await (0, app_config_writer_1.generateVariantsConfig)(basePath, ui5ConfigPath, logger);
+        if (!simulate) {
+            fs.commit(() => logger.info(`Variants configuration written.`));
+        }
+        else {
+            await (0, tracing_1.traceChanges)(fs);
+        }
+    }
+    catch (error) {
+        logger.error(`Error while executing add variants-config: ${error.message}`);
+        logger.debug(error);
+    }
+}
+//# sourceMappingURL=variants-config.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.8.49",
+  "version": "0.8.50",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -33,7 +33,7 @@
     "@sap-ux/abap-deploy-config-inquirer": "1.0.7",
     "@sap-ux/abap-deploy-config-writer": "0.0.51",
     "@sap-ux/adp-tooling": "0.12.62",
-    "@sap-ux/app-config-writer": "0.4.43",
+    "@sap-ux/app-config-writer": "0.4.44",
     "@sap-ux/cap-config-writer": "0.7.49",
     "@sap-ux/cards-editor-config-writer": "0.4.5",
     "@sap-ux/inquirer-common": "0.4.8",