generator-easy-ui5 3.5.2 → 3.6.0

package/CHANGELOG.md

@@ -1,13 +1,14 @@
-## [3.5.1](https://github.com/SAP/generator-easy-ui5/compare/v3.2.0...v3.5.1) (2022-09-10)
+## [3.5.2](https://github.com/SAP/generator-easy-ui5/compare/v3.5.1...v3.5.2) (2023-06-09)
 
 ### Bug Fixes
 
-- enable for Yeoman UI usage ([03c2e38](https://github.com/SAP/generator-easy-ui5/commit/03c2e38af4eebe108d6076710b74d8aaf7c31d8d))
+- sort subgen list, remove threshold, fix permission issues ([#123](https://github.com/SAP/generator-easy-ui5/issues/123)) ([c5dd321](https://github.com/SAP/generator-easy-ui5/commit/c5dd3218a26870a61722a9675a81831cc8af50e5)), closes [#122](https://github.com/SAP/generator-easy-ui5/issues/122) [#118](https://github.com/SAP/generator-easy-ui5/issues/118) [#117](https://github.com/SAP/generator-easy-ui5/issues/117) [#111](https://github.com/SAP/generator-easy-ui5/issues/111)
 
-## [3.5.0](https://github.com/SAP/generator-easy-ui5/compare/v3.2.0...v3.5.0) (2022-07-26)
+## [3.5.1](https://github.com/SAP/generator-easy-ui5/compare/v3.2.0...v3.5.1) (2022-09-10)
 
 ### Bug Fixes
 
+- enable for Yeoman UI usage ([03c2e38](https://github.com/SAP/generator-easy-ui5/commit/03c2e38af4eebe108d6076710b74d8aaf7c31d8d))
 - **postinstall:** allow usage of NPM config for ghAuthToken to avoid rate limit ([#104](https://github.com/SAP/generator-easy-ui5/issues/104)) ([371d7fb](https://github.com/SAP/generator-easy-ui5/commit/371d7fbc82b8a59cef896197b99239b505b3cd90)), closes [#100](https://github.com/SAP/generator-easy-ui5/issues/100)
 - **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))

package/README.md

@@ -8,15 +8,15 @@
 
 ## Description
 
-Easy-ui5 💙 is a [Yeoman](http://yeoman.io/) generator which enables you to create simple [SAPUI5](https://sapui5.hana.ondemand.com/)/[OpenUI5](https://openui5.hana.ondemand.com/)-based web-apps and other UI5-related projects within seconds.
+Easy UI5 (`easy-ui5`) 💙 is a [Yeoman](http://yeoman.io/) generator which enables you to create simple [SAPUI5](https://ui5.sap.com)/[OpenUI5](https://sdk.openui5.org)-based web-apps and other UI5-related projects within seconds.
 
 This generator has been created to simplify the creation of your UI5 prototypes. Now you can scaffold simple UI5 projects from the shell/terminal of your choice. The current best practices (such as [async](https://blogs.sap.com/2018/12/18/ui5ers-buzz-41-best-practices-for-async-loading-in-ui5/)) are already baked into our templates so you don't have to worry about the definition of the metadata files.
 
-The purpose of this generator is to guide you on your first steps with [SAPUI5](https://sapui5.hana.ondemand.com/) and [SAP BTP](https://www.sap.com/products/business-technology-platform.html) deployments. Once you are familiar with those technologies, you might want to tweak the projects to adapt them for productive use-cases (such as continuous deployment pipelines and full i18n).
+The purpose of the `project` subgenerator is to guide you on your first steps with [SAPUI5](https://sapui5.hana.ondemand.com/) and [SAP BTP](https://www.sap.com/products/business-technology-platform.html) deployments. Once you are familiar with those technologies, you might want to tweak the projects to adapt them for productive use-cases (such as continuous deployment pipelines and full i18n).
 
-> :warning: Starting with easy-ui5 v3, all templates will be outsource to repositories in the [UI5 Community](https://github.com/ui5-community/). This project is from now on a shell that will offer all generators hosted on that GitHub org. Easy-ui5 will download and install these repositories when needed.
+> :warning: Starting with Easy UI5 v3, all templates will be outsource to repositories in the [UI5 Community](https://github.com/ui5-community/). This project is from now on a shell that will offer all generators hosted on that GitHub org. Easy UI5 will download and install these repositories when needed.
 >
-> By default, it will download the repository [generator-ui5-project](https://github.com/ui5-community/generator-ui5-project/) which contains the templates that were previously integrated in easy-ui5 < 3.
+> By default, it will download the repository [generator-ui5-project](https://github.com/ui5-community/generator-ui5-project/) which contains the templates that were previously integrated in Easy UI5 < 3.
 
 ## Requirements
 
@@ -63,7 +63,8 @@ During the prompting phase, the generator will ask on which target platform your
 ## More generators
 
 And this is just the start!
-We made easy-ui5 extensible, so that the entire [UI5 Community](https://github.com/ui5-community/) can build additional plugins to scaffold any UI5-related development activity.
+
+We made Easy UI5 extensible, so that the entire [UI5 Community](https://github.com/ui5-community/) can build additional plugins to scaffold any UI5-related development activity.
 
 By default, this generator comes with the [project-creation-plugin](https://github.com/ui5-community/generator-ui5-project) but there are many others as well:
 
@@ -98,6 +99,14 @@ Run the following command to see all subgenerators of a given plugin
 yo easy-ui5 [project|library] <sub-generator-id>
 ```
 
+## Proxy settings
+
+If you are running Easy UI5 behind a coporate proxy, just use the default proxy environment variables for Node.js to configure your corporate proxy:
+
+- `HTTP_PROXY`: Specify the value to use as the HTTP proxy for all connections, e.g., `HTTP_PROXY="http://proxy.mycompany.com:8080/"`.
+- `HTTPS_PROXY`: Specify the value to use as the HTTPS proxy for all connections, e.g., `HTTPS_PROXY="https://proxy.mycompany.com:8080/"`.
+- `NO_PROXY`: Define the hosts that should bypass the proxy, e.g., `NO_PROXY="localhost,.mycompany.com,192.168.6.254:80"`.
+
 ## How to obtain support
 
 Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.

package/generators/app/index.js

@@ -1,20 +1,33 @@
-"use strict";
-const Generator = require("yeoman-generator");
-const chalk = require("chalk");
-const yosay = require("yosay");
-const spawn = require("cross-spawn");
-const { hasYarn } = require("yarn-or-npm");
-
-const path = require("path");
-const fs = require("fs");
-const { rm } = require("fs").promises;
-const glob = require("glob");
-
-const { request } = require("@octokit/request");
-const { Octokit } = require("@octokit/rest");
-const { throttling } = require("@octokit/plugin-throttling");
+import Generator from "yeoman-generator";
+
+import path from "path";
+import fs from "fs";
+import os from "os";
+import url from "url";
+
+import { glob } from "glob";
+import chalk from "chalk";
+import yosay from "yosay";
+import libnpmconfig from "libnpmconfig";
+import yarnOrNpm from "yarn-or-npm";
+const { hasYarn } = yarnOrNpm;
+import AdmZip from "adm-zip";
+import { request } from "@octokit/request";
+import { Octokit } from "@octokit/rest";
+import { throttling } from "@octokit/plugin-throttling";
 const MyOctokit = Octokit.plugin(throttling);
-const AdmZip = require("adm-zip");
+import spawn from "cross-spawn";
+
+const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
+
+// apply proxy settings to GLOBAL_AGENT to support the proxy configuration
+// provided via the standard Node.js environment varibales (used for fetch API)
+let HTTP_PROXY, HTTPS_PROXY, NO_PROXY;
+if (global?.GLOBAL_AGENT) {
+	HTTP_PROXY = global.GLOBAL_AGENT.HTTP_PROXY = process.env.HTTP_PROXY || process.env.http_proxy;
+	HTTPS_PROXY = global.GLOBAL_AGENT.HTTPS_PROXY = process.env.HTTPS_PROXY || process.env.https_proxy;
+	NO_PROXY = global.GLOBAL_AGENT.NO_PROXY = process.env.NO_PROXY || process.env.no_proxy;
+}
 
 // helper to retrieve config entries from npm
 //   --> npm config set easy-ui5_addGhOrg XYZ
@@ -22,13 +35,31 @@ const NPM_CONFIG_PREFIX = "easy-ui5_";
 let npmConfig;
 const getNPMConfig = (configName) => {
 	if (!npmConfig) {
-		npmConfig = require("libnpmconfig").read();
+		npmConfig = libnpmconfig.read();
 	}
 	return npmConfig && npmConfig[`${NPM_CONFIG_PREFIX}${configName}`];
 };
 
 // the command line options of the generator
 const generatorOptions = {
+	pluginsHome: {
+		type: String,
+		description: "Home directory of the plugin generators",
+		default: path.join(os.homedir(), ".npm", "_generator-easy-ui5", "plugin-generators"),
+		hide: true, // shouldn't be needed
+		npmConfig: true,
+	},
+	plugins: {
+		type: Boolean,
+		alias: "p",
+		description: "List detailed information about installed plugin generators",
+	},
+	ghBaseUrl: {
+		type: String,
+		description: "Base URL for the Octokit API (defaults to https://api.github.com if undefined)",
+		hide: true, // shouldn't be needed
+		npmConfig: true,
+	},
 	ghAuthToken: {
 		type: String,
 		description: "GitHub authToken to optionally access private generator repositories",
@@ -51,6 +82,12 @@ const generatorOptions = {
 		default: "generator-ui5-",
 		hide: true, // we don't want to recommend to use this option
 	},
+	addGhBaseUrl: {
+		type: String,
+		description: "Base URL for the Octokit API for the additional generators (defaults to https://api.github.com if undefined)",
+		hide: true, // shouldn't be needed
+		npmConfig: true,
+	},
 	addGhOrg: {
 		type: String,
 		description: "GitHub organization to lookup for additional available generators",
@@ -64,13 +101,6 @@ const generatorOptions = {
 		hide: true, // we don't want to recommend to use this option
 		npmConfig: true,
 	},
-	pluginsHome: {
-		type: String,
-		description: "Home directory of the plugin generators",
-		default: path.join(require("os").homedir(), ".npm", "_generator-easy-ui5", "plugin-generators"),
-		hide: true, // shouldn't be needed
-		npmConfig: true,
-	},
 	embed: {
 		type: Boolean,
 		description: "Embeds the selected plugin generator",
@@ -97,14 +127,9 @@ const generatorOptions = {
 		type: Boolean,
 		description: "Enable detailed logging",
 	},
-	plugins: {
-		type: Boolean,
-		alias: "p",
-		description: "Get detailed version information",
-	},
 	next: {
 		type: Boolean,
-		description: "Preview the next mode to consume templates from bestofui5.org",
+		description: "Preview the next mode to consume subgenerators from bestofui5.org",
 	},
 };
 
@@ -112,16 +137,16 @@ 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 ${chalk.yellow("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 ${chalk.yellow("generator:")} prefix)`,
 	},
 };
 
-module.exports = class extends Generator {
+export default class extends Generator {
 	constructor(args, opts) {
 		super(args, opts, {
 			// disable the Yeoman 5 package-manager logic (auto install)!
@@ -189,7 +214,8 @@ module.exports = class extends Generator {
 		);
 	}
 
-	_unzip(zip, targetPath, zipInternalPath /* used for plugin generators from GitHub (e.g. TS tutorial) */) {
+	_unzip(pathOrBuffer, targetPath, zipInternalPath /* used for plugin generators from GitHub (e.g. TS tutorial) */) {
+		const zip = new AdmZip(pathOrBuffer);
 		const zipEntries = zip.getEntries();
 		zipEntries.forEach((entry) => {
 			const match = !entry.isDirectory && entry.entryName.match(/[^\/]+(\/.+)/);
@@ -205,9 +231,13 @@ module.exports = class extends Generator {
 		});
 	}
 
+	determineAppname() {
+		return "Easy UI5";
+	}
+
 	async prompting() {
 		const home = path.join(__dirname, "..", "..");
-		const pkgJson = require(path.join(home, "package.json"));
+		const pkgJson = JSON.parse(fs.readFileSync(path.join(home, "package.json"), "utf8"));
 
 		// Have Yeoman greet the user.
 		if (!this.options.embedded) {
@@ -218,13 +248,25 @@ module.exports = class extends Generator {
 		// %user_dir%/.npm/_generator-easy-ui5/plugin-generators
 		let pluginsHome = this.options.pluginsHome;
 		if (this.options.verbose) {
-			console.error(`Plugin directory: ${chalk.green(pluginsHome)}`);
-			console.error(chalk.red(e.message));
+			console.info("  Context:");
+			console.info(`    - sourceRoot = ${chalk.green(this.sourceRoot())}`);
+			console.info(`    - destinationRoot = ${chalk.green(this.destinationRoot())}`);
+			console.info("  Options:");
+			Object.keys(generatorOptions).forEach((option) => {
+				console.info(`    - ${option} = ${chalk.green(this.options[option])}`);
+			});
+			console.info("  Proxy:");
+			console.info(`    - HTTP_PROXY = ${chalk.green(HTTP_PROXY)}`);
+			console.info(`    - HTTPS_PROXY = ${chalk.green(HTTPS_PROXY)}`);
+			console.info(`    - NO_PROXY = ${chalk.green(NO_PROXY)}`);
 		}
 		fs.mkdirSync(pluginsHome, { recursive: true });
 
 		// log the plugins and configuration
 		if (this.options.plugins) {
+			const { createRequire } = await import("node:module");
+			const require = createRequire(import.meta.url);
+
 			const yeoman = require("yeoman-environment/package.json");
 
 			const components = {
@@ -255,9 +297,11 @@ module.exports = class extends Generator {
 		if (this.options.offline) {
 			this.log(`Running in ${chalk.yellow("offline")} mode!`);
 		} else {
-			octokit = new MyOctokit({
+			// define the options for the Octokit API
+			const octokitOptions = {
 				userAgent: `${this.rootGeneratorName()}:${this.rootGeneratorVersion()}`,
 				auth: this.options.ghAuthToken,
+				baseUrl: this.options.ghBaseUrl,
 				throttle: {
 					onRateLimit: (retryAfter, options) => {
 						this.log(`${chalk.yellow("Hit the GitHub API limit!")} Request quota exhausted for this request.`);
@@ -269,12 +313,14 @@ module.exports = class extends Generator {
 							return true;
 						}
 					},
-					onAbuseLimit: () => {
+					onSecondaryRateLimit: () => {
 						// 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\` `);
 					},
 				},
-			});
+			};
+			// create the octokit instance
+			octokit = new MyOctokit(octokitOptions);
 		}
 
 		// helper for filtering repos with corresponding subGenerator prefix
@@ -299,6 +345,7 @@ module.exports = class extends Generator {
 			const response = await octokit.repos.listForOrg({
 				org: ghOrg,
 				sort: "name",
+				// eslint-disable-next-line camelcase
 				per_page: threshold,
 			});
 			return filterReposWithSubGeneratorPrefix(response?.data, subGeneratorPrefix);
@@ -309,6 +356,7 @@ module.exports = class extends Generator {
 			const response = await octokit.repos.listForUser({
 				username: ghUser,
 				sort: "name",
+				// eslint-disable-next-line camelcase
 				per_page: threshold,
 			});
 			return filterReposWithSubGeneratorPrefix(response?.data, subGeneratorPrefix);
@@ -356,19 +404,18 @@ module.exports = class extends Generator {
 					const generatorPath = path.join(pluginsHome, generatorName);
 					return {
 						file,
+						generatorName,
 						generatorPath,
 					};
 				})
 				.filter(({ generatorPath }) => !fs.existsSync(generatorPath));
-			// install the missing embedded generator(s)
+			// install (unzip) the missing embedded generator(s)
 			if (generatorsToBeInstalled.length > 0) {
-				this._showBusy(`Installing embedded generators of ${chalk.red("easy-ui5")}...`);
-				await Promise.all(
-					generatorsToBeInstalled.map(({ file, generatorPath }) => {
-						this._unzip(new AdmZip(file), generatorPath);
-						return this._npmInstall(generatorPath);
-					})
-				);
+				this._showBusy("  Installing embedded subgenerators...");
+				generatorsToBeInstalled.map(({ file, generatorName, generatorPath }) => {
+					this._showBusy(`  Installing embedded subgenerator ${chalk.yellow(generatorName)}...`);
+					this._unzip(file, generatorPath);
+				});
 				this._clearBusy(true);
 			}
 			// offline mode means local generators only versus only mode
@@ -504,10 +551,10 @@ module.exports = class extends Generator {
 					branch: generator.branch,
 				});
 				commitSHA = reqBranch.data.commit.sha;
-			} catch (e) {
+			} catch (ex) {
 				console.error(chalk.red(`Failed to retrieve the branch "${generator.branch}" for repository "${generator.name}" for "${generator.org}" organization! Run with --verbose for details!`));
 				if (this.options.verbose) {
-					console.error(chalk.red(e.message));
+					console.error(chalk.red(ex.message));
 				}
 				return;
 			}
@@ -524,7 +571,7 @@ module.exports = class extends Generator {
 						this.log(`Generator ${chalk.yellow(generator.name)} in "${generatorPath}" is outdated!`);
 					}
 					// remove if the SHA marker doesn't exist => outdated!
-					this._showBusy(`  Removing old ${chalk.yellow(generator.name)} templates...`);
+					this._showBusy(`  Deleting subgenerator ${chalk.yellow(generator.name)}...`);
 					await rm(generatorPath, { recursive: true });
 				}
 			}
@@ -535,30 +582,26 @@ module.exports = class extends Generator {
 				if (this.options.verbose) {
 					this.log(`Extracting ZIP to "${generatorPath}"...`);
 				}
-				this._showBusy(`  Downloading ${chalk.yellow(generator.name)} templates...`);
+				this._showBusy(`  Downloading subgenerator ${chalk.yellow(generator.name)}...`);
 				const reqZIPArchive = await octokit.repos.downloadZipballArchive({
 					owner: generator.org,
 					repo: generator.name,
 					ref: commitSHA,
 				});
 
-				this._showBusy(`  Extracting ${chalk.yellow(generator.name)} templates...`);
+				this._showBusy(`  Extracting subgenerator ${chalk.yellow(generator.name)}...`);
 				const buffer = Buffer.from(new Uint8Array(reqZIPArchive.data));
-				const zip = new AdmZip(buffer);
-				this._unzip(zip, generatorPath, generator.dir);
+				this._unzip(buffer, generatorPath, generator.dir);
 
 				// write the sha marker
 				fs.writeFileSync(shaMarker, commitSHA);
-
-				// run yarn/npm install
-				if (this.options.verbose) {
-					this.log("Installing the plugin dependencies...");
-				}
-				this._showBusy(`  Preparing ${chalk.yellow(generator.name)}...`);
-				await this._npmInstall(generatorPath);
 			}
 
-			this._clearBusy(true);
+			// only when embedding we clear the busy state as otherwise
+			// the npm install will immediately again show the busy state
+			if (this.options.embed) {
+				this._clearBusy(true);
+			}
 		}
 
 		// do not execute the plugin generator during the setup/embed mode
@@ -566,6 +609,14 @@ module.exports = class extends Generator {
 			// filter the local options and the help command
 			const opts = Object.keys(this._options).filter((optionName) => !(generatorOptions.hasOwnProperty(optionName) || optionName === "help"));
 
+			// run yarn/npm install (always for self-healing!)
+			if (this.options.verbose) {
+				this.log("Installing the subgenerator dependencies...");
+			}
+			this._showBusy(`  Preparing ${chalk.yellow(generator.name)}...`);
+			await this._npmInstall(generatorPath);
+			this._clearBusy(true);
+
 			// create the env for the plugin generator
 			let env = this.env; // in case of Yeoman UI the env is injected!
 			if (!env) {
@@ -706,4 +757,4 @@ module.exports = class extends Generator {
 			}
 		}
 	}
-};
+}

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "generator-easy-ui5",
-  "version": "3.5.2",
+  "version": "3.6.0",
   "description": "Generator for UI5-based project",
   "main": "generators/app/index.js",
+  "type": "module",
   "files": [
-    "generators"
+    "generators",
+    "plugins"
   ],
   "engines": {
     "node": ">=14.0.0"
@@ -46,33 +48,33 @@
   },
   "homepage": "https://github.com/SAP/generator-easy-ui5#readme",
   "dependencies": {
-    "@octokit/plugin-throttling": "^4.2.0",
-    "@octokit/rest": "^19.0.4",
-    "adm-zip": "^0.5.9",
-    "chalk": "^4.1.2",
-    "colors": "1.4.0",
-    "glob": "^7.2.0",
+    "@octokit/plugin-throttling": "^5.2.3",
+    "@octokit/rest": "^19.0.11",
+    "adm-zip": "^0.5.10",
+    "chalk": "^5.2.0",
+    "colors": "^1.4.0",
+    "glob": "^10.2.7",
     "libnpmconfig": "^1.2.1",
-    "rimraf": "^3.0.2",
+    "rimraf": "^5.0.1",
     "yarn-or-npm": "^3.0.1",
-    "yeoman-environment": "^3.10.0",
-    "yeoman-generator": "^5.7.0",
+    "yeoman-environment": "^3.19.3",
+    "yeoman-generator": "^5.9.0",
     "yosay": "^2.0.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.0.3",
-    "@commitlint/config-conventional": "17.0.3",
-    "conventional-changelog-cli": "^2.2.2",
-    "cz-conventional-changelog": "3.3.0",
-    "eslint": "^8.18.0",
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.3",
-    "mocha": "^10.0.0",
+    "@commitlint/cli": "^17.6.5",
+    "@commitlint/config-conventional": "^17.6.5",
+    "conventional-changelog-cli": "^3.0.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.42.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.2.2",
+    "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "2.7.1",
+    "prettier": "^2.8.8",
     "pretty-quick": "^3.1.3",
     "yeoman-assert": "^3.1.1",
-    "yeoman-test": "^6.3.0"
+    "yeoman-test": "^7.4.0"
   },
   "config": {
     "commitizen": {
@@ -85,6 +87,7 @@
     ]
   },
   "overrides": {
+    "http-cache-semantics": "^4.1.1",
     "minimist": "^1.2.6"
   }
 }