generator-easy-ui5 2.4.6 → 3.1.0

package/generators/app/postinstall.js

@@ -0,0 +1,121 @@
+"use strict";
+const spawn = require("cross-spawn");
+const fs = require("fs");
+const { rmdir } = require("fs").promises;
+const path = require("path");
+const { hasYarn } = require("yarn-or-npm");
+const { Octokit } = require("@octokit/rest");
+const AdmZip = require("adm-zip");
+
+const ghOrg = "ui5-community",
+  repoName = "generator-ui5-project",
+  branch = "main";
+
+(async () => {
+
+  let _busy;
+
+  function showBusy(statusText) {
+    clearBusy();
+    const progressChars = ['\\', '|', '/', '-'];
+    let i = 0;
+    process.stdout.write(`\r${statusText}  `);
+    _busy = {
+      text: statusText,
+      timer: setInterval(() => {
+        process.stdout.write(`\r${statusText} ${progressChars[i++]}`);
+        i %= progressChars.length;
+      }, 250),
+    };
+  }
+
+  function clearBusy(newLine) {
+    if (_busy) {
+      clearInterval(_busy.timer);
+      process.stdout.write(`\r`.padEnd(_busy.text.length + 3) + (newLine ? "\n" : ""));
+      _busy = null;
+    }
+  }
+
+  const octokit = new Octokit({
+    userAgent: "generator-easy-ui5",
+  });
+
+  const reqBranch = await octokit.repos.getBranch({
+    owner: ghOrg,
+    repo: repoName,
+    branch,
+  });
+
+  const commitSHA = reqBranch.data.commit.sha;
+
+  // eslint-disable-next-line
+  console.log(
+    `Fetching ZIP for commit ${commitSHA} from @${ghOrg}/${repoName}#${branch}...`
+  );
+  const generatorPath = path.join(
+    __dirname,
+    "../../plugin-generators",
+    repoName
+  );
+  const shaMarker = path.join(generatorPath, `.${commitSHA}`);
+
+  if (fs.existsSync(generatorPath)) {
+    // check if the SHA marker exists to know whether the generator is up-to-date or not
+    if (!fs.existsSync(shaMarker)) {
+      console.log(`The default generator is outdated...`);
+      // remove if the SHA marker doesn't exist => outdated!
+      showBusy(`  Removing old default templates`);
+      await rmdir(generatorPath, { recursive: true });
+    }
+  }
+
+
+  // re-fetch the generator and extract into local plugin folder
+  if (!fs.existsSync(generatorPath)) {
+    console.log(`Extracting default templates...`);
+    showBusy(`  Downloading and extracting default templates`);
+    const reqZIPArchive = await octokit.repos.downloadZipballArchive({
+      owner: ghOrg,
+      repo: repoName,
+      ref: commitSHA,
+    });
+    const buffer = Buffer.from(new Uint8Array(reqZIPArchive.data));
+    const zip = new AdmZip(buffer);
+    const zipEntries = zip.getEntries();
+    zipEntries.forEach((entry) => {
+      const match =
+        !entry.isDirectory && entry.entryName.match(/[^\/]+\/(.+)/);
+      if (match) {
+        const entryPath = match[1].slice(0, entry.name.length * -1);
+        zip.extractEntryTo(
+          entry,
+          path.join(generatorPath, entryPath),
+          false,
+          true
+        );
+      }
+    });
+    fs.writeFileSync(shaMarker, commitSHA);
+
+    // run yarn/npm install
+    console.log("Installing the plugin dependencies...");
+    showBusy(`  Preparing the default templates`);
+    await new Promise(function (resolve, reject) {
+      spawn((hasYarn() ? "yarn" : "npm"), ["install", "--no-progress"], {
+        stdio: "inherit",
+        cwd: generatorPath,
+        env: {
+          ...process.env,
+          "NO_UPDATE_NOTIFIER": true
+        }
+      }).on('exit', function (code) {
+        resolve(code);
+      }).on('error', function (err) {
+        reject(err);
+      });
+    }.bind(this));
+  }
+
+  clearBusy(true);
+})();

package/package.json

@@ -1,16 +1,19 @@
 {
   "name": "generator-easy-ui5",
-  "version": "2.4.6",
-  "description": "Generator for OpenUI5-based web-apps which use the official UI5 tooling and support deployment targets such as SAP BTP",
+  "version": "3.1.0",
+  "description": "Generator for UI5-based project",
   "main": "generators/app/index.js",
   "files": [
-    "generators",
-    "helpers"
+    "generators"
   ],
   "scripts": {
     "test": "mocha",
+    "postinstall": "node generators/app/postinstall",
     "lint": "eslint .",
-    "circleci": "circleci local execute",
+    "prettier": "prettier --write .",
+    "start": "yo easy-ui5 project",
+    "listSubGen": "yo easy-ui5 project --list",
+    "startSubGen": "yo easy-ui5 project app",
     "workaround": "find . -name '.DS_Store' -delete"
   },
   "repository": {
@@ -22,8 +25,7 @@
     "sap",
     "sapui5",
     "openui5",
-    "sapcloudplatform",
-    "cloudplatform",
+    "sapbtp",
     "generator",
     "scaffold"
   ],
@@ -34,18 +36,21 @@
   },
   "homepage": "https://github.com/SAP/generator-easy-ui5#readme",
   "dependencies": {
-    "glob": "^7.1.6",
-    "object-assign-deep": "^0.4.0",
-    "valid-filename": "^3.1.0",
-    "valid-url": "^1.0.9",
-    "yaml": "^1.10.0",
-    "yeoman-generator": "^4.12.0"
+    "@octokit/rest": "^18.12.0",
+    "adm-zip": "^0.5.9",
+    "chalk": "^4.1.2",
+    "colors": "^1.4.0",
+    "glob": "^7.2.0",
+    "mocha": "^9.1.3",
+    "rimraf": "^3.0.2",
+    "yarn-or-npm": "^3.0.1",
+    "yeoman-assert": "^3.1.1",
+    "yeoman-environment": "^3.8.0",
+    "yeoman-generator": "^5.4.2",
+    "yeoman-test": "^6.2.0",
+    "yosay": "^2.0.2"
   },
   "devDependencies": {
-    "eslint": "^7.15.0",
-    "execa": "^5.0.0",
-    "mocha": "^8.2.1",
-    "yeoman-assert": "^3.1.1",
-    "yeoman-test": "^3.0.0"
+    "prettier": "2.4.1"
   }
 }

package/generators/additionalmodules/index.js

@@ -1,222 +0,0 @@
-const Generator = require("yeoman-generator"),
-  fileaccess = require("../../helpers/fileaccess"),
-  path = require("path"),
-  glob = require("glob");
-
-module.exports = class extends Generator {
-
-  prompting() {
-    if (this.options.isSubgeneratorCall) {
-      this.destinationRoot(this.options.cwd);
-      this.options.oneTimeConfig = this.config.getAll();
-      this.options.oneTimeConfig.modulename = this.options.modulename;
-      return;
-    }
-    throw ("This subgenerator is only intended for internal use. Please don\"t call it directly.");
-  }
-
-  async writing() {
-    this.sourceRoot(path.join(__dirname, "templates"));
-
-    const oConfig = this.options.oneTimeConfig;
-    const platformIsAppRouter = this.options.oneTimeConfig.platform.includes("Application Router"); // aka no destination service etc needed
-
-    // Copy approuter module
-    if (oConfig.platform !== "SAP Launchpad service") {
-      glob.sync("**", {
-        cwd: this.sourceRoot() + "/approuter",
-        nodir: true
-      }).forEach(file => {
-        this.fs.copyTpl(this.templatePath("approuter/" + file), this.destinationPath("approuter/" + file.replace(/^_/, "").replace(/\/_/, "/")), oConfig);
-      });
-
-      const welcomeRoute = platformIsAppRouter ? "uimodule/index.html" : (oConfig.namespace + oConfig.projectname + "/").replace(/\./g, "");
-
-      await fileaccess.manipulateJSON.call(this, "/approuter/xs-app.json", {
-        "welcomeFile": welcomeRoute,
-        "authenticationMethod": "none",
-        "logout": {
-          "logoutEndpoint": "/do/logout"
-        },
-        "routes": []
-      });
-    }
-
-    if (oConfig.platform !== "Application Router @ SAP HANA XS Advanced") {
-      // Copy deployer module
-      glob.sync("**", {
-        cwd: this.sourceRoot() + "/deployer",
-        nodir: true
-      }).forEach(file => {
-        this.fs.copyTpl(this.templatePath("deployer/" + file), this.destinationPath("deployer/" + file.replace(/^_/, "").replace(/\/_/, "/")), oConfig);
-      });
-    }
-  }
-
-  async addMTA() {
-    const oConfig = this.config.getAll();
-
-    let mta = {
-      "ID": oConfig.projectname,
-      "_schema-version": "3.2.0",
-      "version": "0.0.1",
-      "parameters": {
-        "enable-parallel-deployments": true
-      },
-      "modules": [],
-      "resources": []
-    };
-
-    let approuter;
-    if (oConfig.platform !== "SAP Launchpad service") {
-      approuter = {
-        "name": oConfig.projectname,
-        "type": "nodejs",
-        "path": "approuter",
-        "parameters": {
-          "disk-quota": "512M",
-          "memory": "512M"
-        },
-        "requires": []
-      };
-      mta.modules.push(approuter);
-
-      if (oConfig.platform.includes("Application Router")) {
-        approuter["build-parameters"] = {
-          builder: "custom",
-          commands: ["npm install", "npm run build:ui --prefix .."]
-        };
-      }
-    }
-
-    if (oConfig.platform !== "Application Router @ SAP HANA XS Advanced") {
-      mta.resources.push({
-        "name": oConfig.projectname + "_destination",
-        "type": "org.cloudfoundry.managed-service",
-        "parameters": {
-          "service-plan": "lite",
-          "service": "destination"
-        }
-      });
-      if (approuter) {
-        approuter.requires.push({ name: oConfig.projectname + "_destination" });
-      }
-
-      if (oConfig.platform === "SAP HTML5 Application Repository service for SAP BTP" || oConfig.platform === "SAP Launchpad service") {
-
-
-        mta.modules.push({
-          "name": "webapp_deployer",
-          "type": "com.sap.application.content",
-          "path": "deployer",
-          "requires": [{
-            "name": oConfig.projectname + "_html5_repo_host",
-            "parameters": {
-              "content-target": true
-            }
-          }],
-          "build-parameters": {
-            ["build-result"]: "resources",
-            ["requires"]: []
-          }
-        });
-
-        mta.resources.push({
-          "name": oConfig.projectname + "_html5_repo_host",
-          "type": "org.cloudfoundry.managed-service",
-          "parameters": {
-            "service-plan": "app-host",
-            "service": "html5-apps-repo",
-            "config": {
-              "sizeLimit": oConfig.ui5libs.indexOf("Local resources") >= 0 ? 100 : 2
-            }
-          }
-        });
-
-        if (approuter) {
-          mta.resources.push({
-            "name": oConfig.projectname + "_html5_repo_runtime",
-            "type": "org.cloudfoundry.managed-service",
-            "parameters": {
-              "service-plan": "app-runtime",
-              "service": "html5-apps-repo"
-            }
-          });
-          approuter.requires.push({ name: oConfig.projectname + "_html5_repo_runtime" });
-        }
-
-        mta.resources.push({
-          "name": oConfig.projectname + "_uaa",
-          "type": "org.cloudfoundry.managed-service",
-          "parameters": {
-            "path": "./xs-security.json",
-            "service-plan": "application",
-            "service": "xsuaa"
-          }
-        });
-        this.fs.copyTpl(this.templatePath("xs-security.json"), this.destinationPath("xs-security.json"), oConfig);
-        if (approuter) {
-          approuter.requires.push({ name: oConfig.projectname + "_uaa" });
-        }
-
-        if (oConfig.platform === "SAP Launchpad service") {
-          mta.modules.push({
-            "name": oConfig.projectname + "destination-content",
-            "type": "com.sap.application.content",
-            "build-parameters": {
-              "no-source": true
-            },
-            "requires": [
-              {
-                "name": oConfig.projectname + "_uaa",
-                "parameters": {
-                  "service-key": {
-                    "name": oConfig.projectname + "_uaa-key"
-                  }
-                }
-              },
-              {
-                "name": oConfig.projectname + "_html5_repo_host",
-                "parameters": {
-                  "service-key": {
-                    "name": oConfig.projectname + "_html5_repo_host-key"
-                  }
-                }
-              },
-              {
-                "name": oConfig.projectname + "_destination",
-                "parameters": {
-                  "content-target": true
-                }
-              }
-            ],
-            "parameters": {
-              "content": {
-                "subaccount": {
-                  "existing_destinations_policy": "update",
-                  "destinations": [
-                    {
-                      "Name": oConfig.projectname + "_html5_repo_host",
-                      "ServiceInstanceName": oConfig.projectname + "_html5_repo_host",
-                      "ServiceKeyName": oConfig.projectname + "_html5_repo_host-key",
-                      "sap.cloud.service": oConfig.projectname + ".service"
-                    },
-                    {
-                      "Name": oConfig.projectname + "_uaa",
-                      "Authentication": "OAuth2UserTokenExchange",
-                      "ServiceInstanceName": oConfig.projectname + "_uaa",
-                      "ServiceKeyName": oConfig.projectname + "_uaa-key",
-                      "sap.cloud.service": oConfig.projectname + ".service"
-                    }
-                  ]
-                }
-              }
-            }
-          });
-        }
-      }
-    }
-
-    await fileaccess.writeYAML.call(this, "/mta.yaml", mta);
-  }
-};

package/generators/additionalmodules/templates/approuter/package.json

@@ -1,13 +0,0 @@
-{
-  "name": "<%= projectname %>",
-  "version": "0.0.1",
-  "engines": {
-    "node": "12.X"
-  },
-  "scripts": {
-    "start": "node node_modules/@sap/approuter/approuter.js"
-  },
-  "dependencies": {
-    "@sap/approuter": "^9.0.0"
-  }
-}

package/generators/additionalmodules/templates/deployer/readme.md

@@ -1,3 +0,0 @@
-# Deployer module
-
-The build process will move the zipped web apps in here.

package/generators/additionalmodules/templates/xs-security.json

@@ -1,20 +0,0 @@
-{
-  "xsappname": "<%= projectname %>",
-  "tenant-mode": "dedicated",
-  "description": "Security profile of called application",
-  "scopes": [
-    {
-      "name": "uaa.user",
-      "description": "UAA"
-    }
-  ],
-  "role-templates": [
-    {
-      "name": "Token_Exchange",
-      "description": "UAA",
-      "scope-references": [
-        "uaa.user"
-      ]
-    }
-  ]
-}

package/generators/app/templates/_.editorconfig

@@ -1,8 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-charset = utf-8
-# editorconfig-tools is unable to ignore longs strings or urls
-max_line_length = off

package/generators/app/templates/_.eslintignore

@@ -1,4 +0,0 @@
-templates/
-deployer/resources/
-node_modules/
-approuter/webapp/

package/generators/app/templates/_.eslintrc

@@ -1,48 +0,0 @@
-{
-	"env": {
-		"browser": true
-	},
-	"parserOptions": {
-		"ecmaVersion": 2019
-	},
-	"globals": {
-		"sap": true,
-		"jQuery": true
-	},
-	"rules": {
-		"block-scoped-var": 1,
-		"keyword-spacing": 2,
-		"space-unary-ops": 2,
-		"camelcase": 1,
-		"consistent-return": 1,
-		"no-warning-comments": 1,
-		"default-case": 1,
-		"no-console": 2,
-		"no-unused-vars": 2,
-		"no-trailing-spaces": 2,
-		"no-debugger": 2,
-		"semi": [
-			1,
-			"always"
-		],
-		"quotes": [
-			1,
-			"double"
-		],
-		"key-spacing": [
-			1,
-			{
-				"beforeColon": false
-			}
-		],
-		"comma-spacing": [
-			1,
-			{
-				"before": false,
-				"after": true
-			}
-		],
-		"no-shadow": 2,
-		"no-irregular-whitespace": 2
-	}
-}

package/generators/app/templates/_.gitignore

@@ -1,11 +0,0 @@
-node_modules/
-.idea/
-.mta/
-*.mtar
-dist/
-package-lock.json
-mta_archives/
-deployer/resources/
-Makefile*
-mta-*
-approuter/*/webapp/

package/generators/app/templates/karma-ci.conf.js

@@ -1,21 +0,0 @@
-module.exports = function (config) {
-  "use strict";
-
-  require("./karma.conf")(config);
-  config.set({
-
-    // test results reporter to use
-    // possible values: "dots", "progress", "coverage"
-    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
-    reporters: ["progress"],
-
-    // start these browsers
-    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
-    browsers: ["ChromeHeadless"],
-
-    // Continuous Integration mode
-    // if true, Karma captures browsers, runs the tests and exits
-    singleRun: true
-
-  });
-};

package/generators/app/templates/karma.conf.js

@@ -1,17 +0,0 @@
-module.exports = function (config) {
-  "use strict";
-
-  config.set({
-    frameworks: ["ui5"], ui5: {
-      type: "application",
-      configPath: "uimodule/ui5.yaml",
-      paths: {
-        webapp: "uimodule/webapp"
-      }
-    },
-    browsers: ["Chrome"],
-    browserConsoleLogOptions: {
-      level: "error"
-    }
-  });
-};

package/generators/app/templates/readme.md

@@ -1,6 +0,0 @@
-# <%= projectname %>
-Insert the purpose of this project and some interesting infos here
-
-
-## Credits
-This project has been generated with 💙 and [easy-ui5](https://github.com/SAP)

package/generators/newcomponent/index.js

@@ -1,82 +0,0 @@
-const Generator = require("yeoman-generator"),
-fileaccess = require("../../helpers/fileaccess");
-
-module.exports = class extends Generator {
-
-  prompting() {
-    const modules = this.config.get("uimodules");
-    var aPrompt = [{
-      type: "list",
-      name: "modulename",
-      message: "To which module do you want to add a component?",
-      choices: modules || [],
-      when: modules && modules.length > 1
-    }, {
-      type: "input",
-      name: "usagesName",
-      message: "What is the name of your usage?",
-      validate: (s) => {
-        if (/^\d*[a-zA-Z][a-zA-Z0-9]*$/g.test(s)) {
-          return true;
-        }
-        return "Please use alpha numeric characters only for the view name.";
-      }
-    },
-    {
-      type: "input",
-      name: "componentName",
-      message: "What is the name of the component you want to reference?",
-      validate: (s) => {
-        if (/^\d*[a-zA-Z][a-zA-Z0-9]*$/g.test(s)) {
-          return true;
-        }
-        return "Please use alpha numeric characters only for the view name.";
-      }
-    },
-    {
-      type: "input",
-      name: "componentData",
-      message: "Write your component data as a json object"
-
-    }, {
-      type: "confirm",
-      name: "lazy",
-      message: "Should the component be lazy loaded?"
-    }];
-
-    return this.prompt(aPrompt).then((answers) => {
-      this.options.oneTimeConfig = this.config.getAll();
-      this.options.oneTimeConfig.usagesName = answers.usagesName;
-      this.options.oneTimeConfig.componentName = answers.componentName;
-      this.options.oneTimeConfig.componentData = answers.componentData;
-      this.options.oneTimeConfig.lazy = answers.lazy;
-      this.options.oneTimeConfig.modulename = answers.modulename || modules[0];
-
-    });
-  }
-
-  async writing() {
-    const sUsageName = this.options.oneTimeConfig.usagesName;
-    const sComponentName = this.options.oneTimeConfig.componentName;
-    const sComponentData = this.options.oneTimeConfig.componentData || {};
-    const sLazy = this.options.oneTimeConfig.lazy;
-    const sModuleName = this.options.oneTimeConfig.modulename;
-
-    await fileaccess.manipulateJSON.call(this, "/" + sModuleName + "/webapp/manifest.json", {
-      sap: {
-        ui5: {
-          componentUsages: {
-            [sUsageName]: {
-              name: sComponentName,
-              settings: {},
-              componentData: (sComponentData.length > 0) ? JSON.parse(sComponentData) : {},
-              lazy: sLazy
-            }
-          }
-        }
-      }
-    });
-
-    this.log("Add the new usage in your view with the following code: \n '<core:ComponentContainer width='100%' usage='" + sUsageName + "' propagateModel='true' lifecycle='Container'></core:ComponentContainer>'");
-  }
-};