generator-easy-ui5 3.1.0 → 3.1.4

package/generators/app/index.js

@@ -10,36 +10,38 @@ const fs = require("fs");
 const { rmdir } = require("fs").promises;
 
 const { Octokit } = require("@octokit/rest");
+const { throttling } = require("@octokit/plugin-throttling");
+const MyOctokit = Octokit.plugin(throttling);
 const AdmZip = require("adm-zip");
 
 const generatorOptions = {
   ghAuthToken: {
     type: String,
     description:
-      `GitHub authToken to optionally access private generator repositories`,
+      "GitHub authToken to optionally access private generator repositories",
   },
   ghOrg: {
     type: String,
-    description: `GitHub organization to lookup for available generators`,
+    description: "GitHub organization to lookup for available generators",
     default: "ui5-community",
     hidden: true // we don't want to recommend to use this option
   },
   list: {
     type: Boolean,
-    description: `List the available subcommands of the generator`,
+    description: "List the available subcommands of the generator",
   },
   verbose: {
     type: Boolean,
-    description: `Enable detailed logging`,
+    description: "Enable detailed logging",
   },
   skipUpdate: {
     type: Boolean,
-    description: `Skip the update of the plugin generators`,
+    description: "Skip the update of the plugin generators",
   },
   plugins: {
     type: Boolean,
     alias: "p",
-    description: `Get detailed version information`,
+    description: "Get detailed version information",
   }
 };
 
@@ -47,18 +49,21 @@ const generatorArgs = {
   generator: {
     type: String,
     required: false,
-    description: `Name of the generator to invoke (without the "generator-ui5-" prefix)`,
+    description: "Name of the generator to invoke (without the \"generator-ui5-\" prefix)",
   },
   subcommand: {
     type: String,
     required: false,
-    description: `Name of the subcommand to invoke (without the "generator:" prefix)`,
+    description: "Name of the subcommand to invoke (without the \"generator:\" prefix)",
   },
 };
 
 module.exports = class extends Generator {
   constructor(args, opts) {
-    super(args, opts);
+    super(args, opts, {
+      // disable the Yeoman 5 package-manager logic (auto install)!
+      customInstallTask: "disabled"
+    });
 
     Object.keys(generatorArgs).forEach((argName) => {
       // register the argument for being displayed in the help
@@ -78,7 +83,7 @@ module.exports = class extends Generator {
 
   _showBusy(statusText) {
     this._clearBusy();
-    const progressChars = ['\\', '|', '/', '-'];
+    const progressChars = ["\\", "|", "/", "-"];
     let i = 0;
     process.stdout.write(`\r${statusText}  `);
     this._busy = {
@@ -93,7 +98,7 @@ module.exports = class extends Generator {
   _clearBusy(newLine) {
     if (this._busy) {
       clearInterval(this._busy.timer);
-      process.stdout.write(`\r`.padEnd(this._busy.text.length + 3) + (newLine ? "\n" : ""));
+      process.stdout.write("\r".padEnd(this._busy.text.length + 3) + (newLine ? "\n" : ""));
       delete this._busy;
     }
   }
@@ -103,30 +108,52 @@ module.exports = class extends Generator {
     if (this.options.plugins) {
       const glob = require("glob");
       const yeoman = require("yeoman-environment/package.json");
+      const home = __dirname.slice(0, -14);
 
       const components = {
-        'Node.js': process.version,
-        'home': __dirname.slice(0, -4),
+        "Node.js": process.version,
+        "home": home,
         "yeoman-environment": yeoman.version
       };
-      glob.sync("./plugin-generators/*/package.json").forEach(function (plugin) {
-        const name = plugin.replace("./plugin-generators/", "").replace("/package.json", "");
-        const lib = require(path.join("../../", plugin));
+      glob.sync(path.join(home, "plugin-generators/*/package.json")).forEach(function (plugin) {
+        const name = plugin.match(/plugin-generators\/(.+)\/package\.json/)[1];
+        const lib = require(plugin);
         components[name] = lib.version;
       });
 
       const log = this.log;
       return Object.keys(components).forEach(function (component) {
         log(`${chalk.green(component)}: ${components[component]}`);
-      })
+      });
+      ;
     }
 
     this.log(yosay(`Welcome to the ${chalk.red("easy-ui5")} generator!`));
 
     // create the octokit client to retrieve the generators from GH org
-    const octokit = new Octokit({
+    const octokit = new MyOctokit({
       userAgent: `${this.rootGeneratorName()}:${this.rootGeneratorVersion()}`,
       auth: this.options.ghAuthToken,
+      throttle: {
+        onRateLimit: (retryAfter, options) => {
+          this.log(
+            `${chalk.yellow("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 the \`--ghAuthToken\` option. For more details, run \`yo easy-ui5 --help\`. `);
+            return true;
+          }
+        },
+        onAbuseLimit: () => {
+          // does not retry, only logs a warning
+          this.log(
+            `${chalk.red("Hit the GitHub API limit again!")} Please supply an auth token with the \`--ghAuthToken\` option. For more details, run \`yo easy-ui5 --help\` `
+          );
+
+        },
+      }
     });
 
     // retrieve the available repositories
@@ -271,9 +298,9 @@ module.exports = class extends Generator {
               ...process.env,
               "NO_UPDATE_NOTIFIER": true
             }
-          }).on('exit', function (code) {
+          }).on("exit", function (code) {
             resolve(code);
-          }).on('error', function (err) {
+          }).on("error", function (err) {
             reject(err);
           });
         }.bind(this));
@@ -348,7 +375,7 @@ module.exports = class extends Generator {
       }
     }
 
-    // transform the list of the subgenerators and identify the 
+    // transform the list of the subgenerators and identify the
     // default subgenerator for the default selection
     let defaultSubGenerator;
     let maxLength = 0;

package/generators/app/postinstall.js

@@ -17,7 +17,7 @@ const ghOrg = "ui5-community",
 
   function showBusy(statusText) {
     clearBusy();
-    const progressChars = ['\\', '|', '/', '-'];
+    const progressChars = ["\\", "|", "/", "-"];
     let i = 0;
     process.stdout.write(`\r${statusText}  `);
     _busy = {
@@ -32,7 +32,7 @@ const ghOrg = "ui5-community",
   function clearBusy(newLine) {
     if (_busy) {
       clearInterval(_busy.timer);
-      process.stdout.write(`\r`.padEnd(_busy.text.length + 3) + (newLine ? "\n" : ""));
+      process.stdout.write("\r".padEnd(_busy.text.length + 3) + (newLine ? "\n" : ""));
       _busy = null;
     }
   }
@@ -63,9 +63,9 @@ 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...`);
+      console.log("The default generator is outdated...");
       // remove if the SHA marker doesn't exist => outdated!
-      showBusy(`  Removing old default templates`);
+      showBusy("  Removing old default templates");
       await rmdir(generatorPath, { recursive: true });
     }
   }
@@ -73,8 +73,8 @@ const ghOrg = "ui5-community",
 
   // 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`);
+    console.log("Extracting default templates...");
+    showBusy("  Downloading and extracting default templates");
     const reqZIPArchive = await octokit.repos.downloadZipballArchive({
       owner: ghOrg,
       repo: repoName,
@@ -100,7 +100,7 @@ const ghOrg = "ui5-community",
 
     // run yarn/npm install
     console.log("Installing the plugin dependencies...");
-    showBusy(`  Preparing the default templates`);
+    showBusy("  Preparing the default templates");
     await new Promise(function (resolve, reject) {
       spawn((hasYarn() ? "yarn" : "npm"), ["install", "--no-progress"], {
         stdio: "inherit",
@@ -109,9 +109,9 @@ const ghOrg = "ui5-community",
           ...process.env,
           "NO_UPDATE_NOTIFIER": true
         }
-      }).on('exit', function (code) {
+      }).on("exit", function (code) {
         resolve(code);
-      }).on('error', function (err) {
+      }).on("error", function (err) {
         reject(err);
       });
     }.bind(this));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-easy-ui5",
-  "version": "3.1.0",
+  "version": "3.1.4",
   "description": "Generator for UI5-based project",
   "main": "generators/app/index.js",
   "files": [
@@ -9,7 +9,7 @@
   "scripts": {
     "test": "mocha",
     "postinstall": "node generators/app/postinstall",
-    "lint": "eslint .",
+    "lint": "eslint . --fix",
     "prettier": "prettier --write .",
     "start": "yo easy-ui5 project",
     "listSubGen": "yo easy-ui5 project --list",
@@ -36,6 +36,7 @@
   },
   "homepage": "https://github.com/SAP/generator-easy-ui5#readme",
   "dependencies": {
+    "@octokit/plugin-throttling": "^3.5.2",
     "@octokit/rest": "^18.12.0",
     "adm-zip": "^0.5.9",
     "chalk": "^4.1.2",