generator-easy-ui5 3.1.2 → 3.2.0

package/generators/app/index.js

@@ -10,36 +10,69 @@ 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");
 
+// 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}`]
+}
+
+// the command line options of the generator
 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
+    hide: true // we don't want to recommend to use this option
+  },
+  subGeneratorPrefix: {
+    type: String,
+    description: "Prefix used for the lookup of the available generators",
+    default: "generator-ui5-",
+    hide: true // we don't want to recommend to use this option
+  },
+  addGhOrg: {
+    type: String,
+    description: `GitHub organization to lookup for additional available generators`,
+    hide: true, // we don't want to recommend to use this option
+    npmConfig: true
+  },
+  addSubGeneratorPrefix: {
+    type: String,
+    description: `Prefix used for the lookup of the additional available generators`,
+    default: "generator-",
+    hide: true, // we don't want to recommend to use this option
+    npmConfig: true
   },
   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 +80,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
@@ -66,19 +102,21 @@ module.exports = class extends Generator {
     });
 
     Object.keys(generatorOptions).forEach((optionName) => {
-      if (!generatorOptions[optionName].hidden) {
-        // register the option for being displayed in the help
-        this.option(optionName, generatorOptions[optionName]);
-      } else {
-        // apply the default value for hidden options if needed
-        this.options[optionName] = this.options[optionName] || generatorOptions[optionName].default;
+      const initialValue = this.options[optionName];
+      // register the option for being displayed in the help
+      this.option(optionName, generatorOptions[optionName]);
+      const defaultedValue = this.options[optionName];
+      if (generatorOptions[optionName].npmConfig) {
+        // if a value is set, use the set value (parameter has higher precedence than npm config)
+        // => this.option(...) applies the default value to this.options[...] used as last resort
+        this.options[optionName] = initialValue || getNPMConfig(optionName) || defaultedValue;
       }
     });
   }
 
   _showBusy(statusText) {
     this._clearBusy();
-    const progressChars = ['\\', '|', '/', '-'];
+    const progressChars = ["\\", "|", "/", "-"];
     let i = 0;
     process.stdout.write(`\r${statusText}  `);
     this._busy = {
@@ -93,56 +131,146 @@ 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;
     }
   }
 
   async prompting() {
 
+    this.log(yosay(`Welcome to the ${chalk.red("easy-ui5")} generator!`));
+
+    const home = path.join(__dirname, "..", "..");
+
+    // check the permissions to Easy UI5s plugin directory which must
+    // allow read/write to install additional plugin generators
+    let pluginsHome = path.join(home, "plugin-generators");
+    try {
+      fs.accessSync(pluginsHome, fs.constants.R_OK | fs.constants.W_OK);
+    } catch (e) {
+      pluginsHome = path.join(require("os").homedir(), ".npm", "_generator-easy-ui5", "plugin-generators");
+      if (this.options.verbose) {
+        console.error(`Plugin directory: ${chalk.green(pluginsHome)}`);
+        console.error(chalk.red(e.message));
+      }
+      fs.mkdirSync(pluginsHome, { recursive: true });
+    }
+
+    // log the plugins and configuration
     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': home,
-        "yeoman-environment": yeoman.version
+        "Node.js": process.version,
+        "yeoman-environment": yeoman.version,
+        "generator-easy-ui5": require(path.join(home, "package.json")).version,
+        "home": home,
+        "pluginsHome": pluginsHome,
       };
-      glob.sync(path.join(home, "plugin-generators/*/package.json")).forEach(function (plugin) {
-        const name = plugin.match(/plugin-generators\/(.+)\/package\.json/)[1];
+
+      Object.keys(components).forEach((component) => {
+        this.log(`${chalk.green(component)}: ${components[component]}`);
+      });
+
+      this.log(chalk.green("\nAvailable generators:"));
+      glob.sync(`${pluginsHome}/*/package.json`).forEach((plugin) => {
+        const name = plugin.match(/.*\/(.+)\/package\.json/)[1];
         const lib = require(plugin);
-        components[name] = lib.version;
+        this.log(`  - ${chalk.green(name)}: ${lib.version}`);
       });
 
-      const log = this.log;
-      return Object.keys(components).forEach(function (component) {
-        log(`${chalk.green(component)}: ${components[component]}`);
-      })
+      return;
     }
 
-    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\` `
+          );
+
+        },
+      }
     });
 
+    // helper for filtering repos with corresponding subGenerator prefix
+    const filterReposWithSubGeneratorPrefix = (repos, subGeneratorPrefix) => {
+      if (!Array.isArray(repos)) {
+        return [];
+      }
+      return repos.filter((repo) =>
+        repo.name.startsWith(`${subGeneratorPrefix}`)
+      ).map((repo) => {
+        return {
+          org: repo.owner?.login,
+          name: repo.name,
+          branch: repo.default_branch,
+          subGeneratorName: repo.name.substring(subGeneratorPrefix.length),
+        };
+      });
+    }
+
+    // helper to retrieve the available repositories for a GH org
+    const listGeneratorsForOrg = async (ghOrg, subGeneratorPrefix) => {
+      const response = await octokit.repos.listForOrg({
+        org: ghOrg,
+      });
+      return filterReposWithSubGeneratorPrefix(response?.data, subGeneratorPrefix);
+    }
+
+    // helper to retrieve the available repositories for a GH user
+    const listGeneratorsForUser = async (ghUser, subGeneratorPrefix) => {
+      const response = await octokit.repos.listForUser({
+        username: ghUser,
+      });
+      return filterReposWithSubGeneratorPrefix(response?.data, subGeneratorPrefix);
+    }
+
     // retrieve the available repositories
-    let reqRepos;
+    let availGenerators;
     try {
-      reqRepos = await octokit.repos.listForOrg({
-        org: this.options.ghOrg,
-      });
+      availGenerators = await listGeneratorsForOrg(this.options.ghOrg, this.options.subGeneratorPrefix);
     } catch (e) {
-      console.error(`Failed to connect to GitHub to retrieve available repository for "${this.options.ghOrg}" organization! Run with --verbose for details!`);
+      console.error(`Failed to connect to GitHub to retrieve available generators for "${this.options.ghOrg}" organization! Run with --verbose for details!`);
       if (this.options.verbose) {
         console.error(e);
       }
       return;
     }
+    try {
+      if (this.options.addGhOrg && this.options.addSubGeneratorPrefix) {
+        availGenerators = availGenerators.concat(await listGeneratorsForOrg(this.options.addGhOrg, this.options.addSubGeneratorPrefix));
+      }
+    } catch (e) {
+      if (this.options.verbose) {
+        this.log(`Failed to connect to GitHub retrieve additional generators for "${this.options.addGhOrg}" organization! Try to retrieve for user...`);
+      }
+      try {
+        availGenerators = availGenerators.concat(await listGeneratorsForUser(this.options.addGhOrg, this.options.addSubGeneratorPrefix));
+      } catch (e) {
+        console.error(`Failed to connect to GitHub to retrieve additional generators for organization or user "${this.options.addGhOrg}"! Run with --verbose for details!`);
+        if (this.options.verbose) {
+          console.error(e);
+        }
+        return;
+      }
+    }
 
     // download the generator from GH (or the test generator)
     let generatorPath;
@@ -154,11 +282,9 @@ module.exports = class extends Generator {
     } else {
 
       // check for provided generator being available on GH
-      let generator =
-        this.options.generator &&
-        reqRepos.data.find(
-          (repo) => repo.name === `generator-ui5-${this.options.generator}`
-        );
+      let generator = this.options.generator && availGenerators.find((repo) => 
+        repo.subGeneratorName === this.options.generator
+      );
 
       // if no generator is provided and doesn't exist, ask for generator name
       if (!generator) {
@@ -169,37 +295,35 @@ module.exports = class extends Generator {
             )} was not found. Please select an existing generator!`
           );
         }
-        const generatorRepos = reqRepos.data.filter((repo) =>
-          /^generator-ui5-.+/.test(repo.name)
-        );
+
         const generatorIdx = (
           await this.prompt([
             {
               type: "list",
               name: "generator",
               message: "Select your generator?",
-              choices: generatorRepos.map((repo, idx) => ({
-                name: repo.name,
+              choices: availGenerators.map((availGenerator, idx) => ({
+                name: `${availGenerator.subGeneratorName}${this.options.addGhOrg ? ` [${availGenerator.org}]` : ""}`,
                 value: idx,
               })),
             },
           ])
         ).generator;
-        generator = generatorRepos[generatorIdx];
+        generator = availGenerators[generatorIdx];
       }
 
       // fetch the available branches to retrieve the latest commit SHA
       let reqBranch;
       try {
         reqBranch = await octokit.repos.getBranch({
-          owner: this.options.ghOrg,
+          owner: generator.org,
           repo: generator.name,
-          branch: generator.default_branch,
+          branch: generator.branch,
         });
       } catch (e) {
-        console.error(`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 "${this.options.ghOrg}" organization! Run with --verbose for details!`));
         if (this.options.verbose) {
-          console.error(e);
+          console.error(chalk.red(e.message));
         }
         return;
       }
@@ -211,14 +335,10 @@ module.exports = class extends Generator {
           `Using commit ${commitSHA} from @${this.options.ghOrg}/${generator.name}#${generator.default_branch}...`
         );
       }
-      generatorPath = path.join(
-        __dirname,
-        "../../plugin-generators",
-        generator.name
-      );
+      generatorPath = path.join(pluginsHome, generator.name);
       const shaMarker = path.join(generatorPath, `.${commitSHA}`);
 
-      if (fs.existsSync(generatorPath) && this.options.skipUpdate) {
+      if (fs.existsSync(generatorPath) && !this.options.skipUpdate) {
         // check if the SHA marker exists to know whether the generator is up-to-date or not
         if (!fs.existsSync(shaMarker)) {
           if (this.options.verbose) {
@@ -272,9 +392,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));
@@ -349,7 +469,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.2",
+  "version": "3.2.0",
   "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,21 +36,23 @@
   },
   "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",
-    "colors": "^1.4.0",
+    "colors": "1.4.0",
     "glob": "^7.2.0",
-    "mocha": "^9.1.3",
+    "libnpmconfig": "^1.2.1",
+    "mocha": "^9.2.0",
     "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",
+    "yeoman-environment": "^3.9.1",
+    "yeoman-generator": "^5.6.1",
+    "yeoman-test": "^6.3.0",
     "yosay": "^2.0.2"
   },
   "devDependencies": {
-    "prettier": "2.4.1"
+    "prettier": "2.5.1"
   }
 }