@sap-ux/create 0.3.1 → 0.4.0

package/README.md

@@ -3,12 +3,28 @@ Module which provides command line interface to configure features for SAP UX pr
 
 To see usage, run
 
-```
+```sh
 npm init @sap-ux 
 ```
 
 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
 npx sap-ux
 ```
+
+## add
+Calling `npx sap-ux add` allows adding a feature to a project.
+
+## remove
+Calling `npx sap-ux remove` allows removing a feature to a project.
+
+## generate
+Calling `npx sap-ux generate` allows generating a new project.
+
+### adaptation-project
+Calling `npx sap-ux generate adaptation-project` allows generating a new adaptation project. Without further parameters the CLI will prompt the required parameters `id`, `reference` and `url`. To run the prompt non-interactively, it is also possible to execute
+```sh
+npx 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.

package/dist/cli/generate/adaptation-project.d.ts

@@ -0,0 +1,8 @@
+import type { Command } from 'commander';
+/**
+ * Add a new sub-command to generate SAP UI5 adaptation projects the given command.
+ *
+ * @param cmd main command that is to be enhanced
+ */
+export declare function addGenerateAdaptationProjectCommand(cmd: Command): void;
+//# sourceMappingURL=adaptation-project.d.ts.map

package/dist/cli/generate/adaptation-project.js

@@ -0,0 +1,86 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addGenerateAdaptationProjectCommand = void 0;
+const tracing_1 = require("../../tracing");
+const adp_tooling_1 = require("@sap-ux/adp-tooling");
+const common_1 = require("../../common");
+const path_1 = require("path");
+/**
+ * Add a new sub-command to generate SAP UI5 adaptation projects the given command.
+ *
+ * @param cmd main command that is to be enhanced
+ */
+function addGenerateAdaptationProjectCommand(cmd) {
+    cmd.command('adaptation-project [path]')
+        .option('-n, --skip-install', 'skip npm install step')
+        .option('-s, --simulate', 'simulate only do not write or install')
+        .option('--id [id]', 'id of the adaptation project')
+        .option('--reference [reference]', 'id of the original application')
+        .option('--url [url]', 'url pointing to the target system containing the original app')
+        .action((path, options) => __awaiter(this, void 0, void 0, function* () {
+        yield generateAdaptationProject(path, Object.assign({}, options), !!options.simulate, !!options.skipInstall);
+    }));
+}
+exports.addGenerateAdaptationProjectCommand = addGenerateAdaptationProjectCommand;
+/**
+ * Generate an SAP UI5 adaptation project based on the given parameters.
+ *
+ * @param basePath target folder of the new project
+ * @param defaults optional defaults
+ * @param defaults.id id of the new adaptation project
+ * @param defaults.reference id of the referenced original app
+ * @param defaults.url url of the target system
+ * @param simulate if set to true, then no files will be written to the filesystem
+ * @param skipInstall if set to true then `npm i` is not executed in the new project
+ */
+function generateAdaptationProject(basePath, defaults, simulate, skipInstall) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const logger = (0, tracing_1.getLogger)();
+        try {
+            logger.debug(`Called generate adaptation-project for path '${basePath}', skip install is '${skipInstall}'`);
+            let config;
+            if (defaults.id && defaults.reference && defaults.url) {
+                config = {
+                    app: {
+                        id: defaults.id,
+                        reference: defaults.reference,
+                        layer: 'CUSTOMER_BASE'
+                    },
+                    target: {
+                        url: defaults.url
+                    }
+                };
+            }
+            else {
+                config = yield (0, adp_tooling_1.promptGeneratorInput)(defaults);
+            }
+            if (!basePath) {
+                basePath = (0, path_1.join)(process.cwd(), config.app.id);
+            }
+            const fs = yield (0, adp_tooling_1.generate)(basePath, config);
+            if (!simulate) {
+                yield new Promise((resolve) => fs.commit(resolve));
+                if (!skipInstall) {
+                    (0, common_1.runNpmInstallCommand)(basePath);
+                    logger.info('Executed npm install');
+                }
+            }
+            else {
+                yield (0, tracing_1.traceChanges)(fs);
+            }
+        }
+        catch (error) {
+            logger.error(error.message);
+        }
+    });
+}
+//# sourceMappingURL=adaptation-project.js.map

package/dist/cli/generate/index.d.ts

@@ -0,0 +1,6 @@
+import { Command } from 'commander';
+/**
+ * @returns 'generate *' commands. Commands include also the handler action.
+ */
+export declare function getGenerateCommands(): Command;
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/generate/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGenerateCommands = void 0;
+const commander_1 = require("commander");
+const adaptation_project_1 = require("./adaptation-project");
+/**
+ * @returns 'generate *' commands. Commands include also the handler action.
+ */
+function getGenerateCommands() {
+    const genCommands = new commander_1.Command('generate');
+    // create-fiori generate adaptation-project
+    (0, adaptation_project_1.addGenerateAdaptationProjectCommand)(genCommands);
+    return genCommands;
+}
+exports.getGenerateCommands = getGenerateCommands;
+//# sourceMappingURL=index.js.map

package/dist/cli/index.js

@@ -7,6 +7,7 @@ const commander_1 = require("commander");
 const tracing_1 = require("../tracing");
 const add_1 = require("./add");
 const remove_1 = require("./remove");
+const generate_1 = require("./generate");
 /*
  * We've chosen 'commander' over 'minimist' and 'yargs' for this CLI implementation. Reasons:
  * (if it still up: https://npmtrends.com/commander-vs-minimist-vs-yargs)
@@ -44,6 +45,8 @@ function getCommanderProgram() {
     const version = getVersion();
     program.description(`Configure features for Fiori applications and projects. (${version})`);
     program.version(version);
+    // Handler for create-fiori generate <feature> ..
+    program.addCommand((0, generate_1.getGenerateCommands)());
     // Handler for create-fiori add <feature> ..
     program.addCommand((0, add_1.getAddCommands)());
     // Handler for create-fiori remove <feature> ..

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,7 +29,8 @@
     "commander": "9.4.0",
     "diff": "5.1.0",
     "prompts": "2.4.2",
-    "@sap-ux/app-config-writer": "0.1.1",
+    "@sap-ux/adp-tooling": "0.1.0",
+    "@sap-ux/app-config-writer": "0.1.2",
     "@sap-ux/cap-config-writer": "0.1.9",
     "@sap-ux/logger": "0.3.7",
     "@sap-ux/mockserver-config-writer": "0.1.7",