generator-easy-ui5 3.2.1 → 3.4.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [3.3.0](https://github.com/SAP/generator-easy-ui5/compare/v3.2.0...v3.3.0) (2022-02-21)
+
+
+### Bug Fixes
+
+* **postinstall:** avoid non-existing node_modules ([#98](https://github.com/SAP/generator-easy-ui5/issues/98)) ([f93c7c9](https://github.com/SAP/generator-easy-ui5/commit/f93c7c99b9e5df7af801a085afe72be85e462007))
+* usage of proper gh org for logging and download ([#94](https://github.com/SAP/generator-easy-ui5/issues/94)) ([a88d4db](https://github.com/SAP/generator-easy-ui5/commit/a88d4dbb0a1f5ed3cf60f7ed0297c651222a83fb))
+* use the org name of the selected generator for downloading the corresponding repo ([d9ca4dc](https://github.com/SAP/generator-easy-ui5/commit/d9ca4dc3170e0507199799d2e14db327cba4d871))
+
+
+### Features
+
+* allow to run easy-ui5 embedded ([#99](https://github.com/SAP/generator-easy-ui5/issues/99)) ([f4952c4](https://github.com/SAP/generator-easy-ui5/commit/f4952c442c9563a51c48b8edc25843f097fce4c4))
+
+
+
 # [3.2.0](https://github.com/SAP/generator-easy-ui5/compare/v3.1.5...v3.2.0) (2022-02-03)
 
 

package/README.md

@@ -20,7 +20,7 @@ The purpose of this generator is to guide you on your first steps with [SAPUI5](
 
 ## Requirements
 
-- Get [Node.js](https://nodejs.org/en/download/)  (**version 12 or higher** ⚠️)
+- Get [Node.js](https://nodejs.org/en/download/)  (**version 14 or higher** ⚠️)
 
 ## Download and Installation
 

package/generators/app/index.js

@@ -7,7 +7,7 @@ const { hasYarn } = require("yarn-or-npm");
 
 const path = require("path");
 const fs = require("fs");
-const { rmdir } = require("fs").promises;
+const { rm } = require("fs").promises;
 
 const { Octokit } = require("@octokit/rest");
 const { throttling } = require("@octokit/plugin-throttling");
@@ -31,6 +31,7 @@ const generatorOptions = {
     type: String,
     description:
       "GitHub authToken to optionally access private generator repositories",
+    npmConfig: true
   },
   ghOrg: {
     type: String,
@@ -138,7 +139,10 @@ module.exports = class extends Generator {
 
   async prompting() {
 
-    this.log(yosay(`Welcome to the ${chalk.red("easy-ui5")} generator!`));
+    // Have Yeoman greet the user.
+    if (!this.options.embedded) {
+      this.log(yosay(`Welcome to the ${chalk.red("easy-ui5")} generator!`));
+    }
 
     const home = path.join(__dirname, "..", "..");
 
@@ -321,7 +325,7 @@ module.exports = class extends Generator {
           branch: generator.branch,
         });
       } catch (e) {
-        console.error(chalk.red(`Failed to retrieve the default branch for repository "${generator.name}" for "${this.options.ghOrg}" organization! Run with --verbose for details!`));
+        console.error(chalk.red(`Failed to retrieve the default branch for repository "${generator.name}" for "${generator.org}" organization! Run with --verbose for details!`));
         if (this.options.verbose) {
           console.error(chalk.red(e.message));
         }
@@ -332,7 +336,7 @@ module.exports = class extends Generator {
 
       if (this.options.verbose) {
         this.log(
-          `Using commit ${commitSHA} from @${this.options.ghOrg}/${generator.name}#${generator.default_branch}...`
+          `Using commit ${commitSHA} from @${generator.org}/${generator.name}#${generator.default_branch}...`
         );
       }
       generatorPath = path.join(pluginsHome, generator.name);
@@ -346,7 +350,7 @@ module.exports = class extends Generator {
           }
           // remove if the SHA marker doesn't exist => outdated!
           this._showBusy(`  Removing old "${generator.name}" templates`);
-          await rmdir(generatorPath, { recursive: true });
+          await rm(generatorPath, { recursive: true });
         }
       }
 
@@ -385,7 +389,7 @@ module.exports = class extends Generator {
         }
         this._showBusy(`  Preparing "${generator.name}"`);
         await new Promise(function (resolve, reject) {
-          spawn((hasYarn() ? "yarn" : "npm"), ["install", "--no-progress"], {
+          spawn((hasYarn() ? "yarn" : "npm"), ["install", "--no-progress", "--ignore-engines"], {
             stdio: this.config.verbose ? "inherit" : "ignore",
             cwd: generatorPath,
             env: {

package/generators/app/postinstall.js

@@ -1,15 +1,29 @@
 "use strict";
 const spawn = require("cross-spawn");
 const fs = require("fs");
-const { rmdir } = require("fs").promises;
+const { rm } = require("fs").promises;
 const path = require("path");
 const { hasYarn } = require("yarn-or-npm");
 const { Octokit } = require("@octokit/rest");
+const { throttling } = require("@octokit/plugin-throttling");
+const MyOctokit = Octokit.plugin(throttling);
 const AdmZip = require("adm-zip");
 
+// helper to retrieve config entries from npm
+//   --> npm config set easy-ui5_addGhOrg XYZ
+const NPM_CONFIG_PREFIX = "easy-ui5_";
+let npmConfig;
+const getNPMConfig = (configName) => {
+  if (!npmConfig) {
+    npmConfig = require("libnpmconfig").read();
+  }
+  return npmConfig && npmConfig[`${NPM_CONFIG_PREFIX}${configName}`]
+}
+
 const ghOrg = "ui5-community",
   repoName = "generator-ui5-project",
-  branch = "main";
+  branch = "main",
+  ghAuthToken = getNPMConfig("ghAuthToken");
 
 (async () => {
 
@@ -37,8 +51,25 @@ const ghOrg = "ui5-community",
     }
   }
 
-  const octokit = new Octokit({
-    userAgent: "generator-easy-ui5",
+  const pkg = require(path.join(__dirname, "../../package.json"));
+  console.log(`${pkg.name}:${pkg.version} - ${ghAuthToken}`);
+  const octokit = new MyOctokit({
+    userAgent: `${pkg.name}:${pkg.version}`,
+    auth: ghAuthToken,
+    throttle: {
+      onRateLimit: (retryAfter, options) => {
+        console.log(`Hit the GitHub API limit! Request quota exhausted for this request.`);
+        if (options.request.retryCount === 0) {
+          // only retries once
+          this.log(`Retrying after ${retryAfter} seconds. Alternatively, you can cancel this operation and supply an auth token with "npm config set easy-ui5_ghAuthToken ghp_xxxx".`);
+          return true;
+        }
+      },
+      onAbuseLimit: () => {
+        // does not retry, only logs a warning
+        console.error(`Hit the GitHub API limit again! Please supply an auth token with with "npm config set easy-ui5_ghAuthToken ghp_xxxx".`);
+      },
+    }
   });
 
   const reqBranch = await octokit.repos.getBranch({
@@ -51,7 +82,7 @@ const ghOrg = "ui5-community",
 
   // eslint-disable-next-line
   console.log(
-    `Fetching ZIP for commit ${commitSHA} from @${ghOrg}/${repoName}#${branch}...`
+    `Using commit ${commitSHA} from @${ghOrg}/${repoName}#${branch}...`
   );
   const generatorPath = path.join(
     __dirname,
@@ -63,10 +94,13 @@ const ghOrg = "ui5-community",
   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...");
+      // eslint-disable-next-line
+      console.log(
+        `Fetching new ZIP as the default generator is outdated...`
+      );
       // remove if the SHA marker doesn't exist => outdated!
       showBusy("  Removing old default templates");
-      await rmdir(generatorPath, { recursive: true });
+      await rm(generatorPath, { recursive: true });
     }
   }
 
@@ -102,7 +136,7 @@ const ghOrg = "ui5-community",
     console.log("Installing the plugin dependencies...");
     showBusy("  Preparing the default templates");
     await new Promise(function (resolve, reject) {
-      spawn((hasYarn() ? "yarn" : "npm"), ["install", "--no-progress"], {
+      spawn((hasYarn() ? "yarn" : "npm"), ["install", "--no-progress", "--ignore-engines"], {
         stdio: "inherit",
         cwd: generatorPath,
         env: {

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "generator-easy-ui5",
-  "version": "3.2.1",
+  "version": "3.4.0",
   "description": "Generator for UI5-based project",
   "main": "generators/app/index.js",
   "files": [
     "generators"
   ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "scripts": {
     "test": "mocha",
     "postinstall": "node generators/app/postinstall",