generator-easy-ui5 2.4.6 → 3.1.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 3.0.0 (2021-04-08)
+
+### New Features
+
+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.
+
+
+
+### Bug Fixes
+
+NA

package/README.md

@@ -1,191 +1,96 @@
 # Easy UI5 Generator
+
 [![NPM version][npm-image]][npm-url]
-[![Build Status][circleci-image]][circleci-url]
-[![Dependency Status][daviddm-image]][daviddm-url]
+[![Build Status][test-image]][test-url]
+[![Dependency Status][librariesio-image]][repo-url]
 [![License Status][license-image]][license-url]
-[![REUSE status](https://api.reuse.software/badge/github.com/SAP/generator-easy-ui5/)](https://api.reuse.software/info/github.com/SAP/generator-easy-ui5/)
+[![REUSE status][reuse-image]][reuse-url]
 
 ## Description
 
-Easy-ui5 is a [Yeoman](http://yeoman.io/) generator which enables you to create simple [OpenUI5](https://openui5.hana.ondemand.com/)-based web-apps within seconds.
+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.
 
-This generator has been created to simplify the creation of your OpenUI5 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.
+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 and SAP BTP 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 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).
 
+## Requirements
 
-## Target platforms
-During the prompting phase, the generator will ask on which target platform your app should run. Currently, the following options are available:
+- Get [Node.js](https://nodejs.org/en/download/)  (**version 12 or higher** ⚠️)
 
-### Static webserver
-This is the most basic option. Choose this option if you want to deploy the web app in your custom environment or host it on an arbitrary server.
-### Application Router @ Cloud Foundry
-This is the most basic way to deploy the web app in Cloud Foundry-based environments. Besides the basic UI5 project, the generator will add an [Approuter](https://github.com/gregorwolf/SAP-NPM-API-collection/tree/master/apis/approuter) node.js-module that serves the web app.
-### Application Router @ SAP HANA XS Advanced
-This is the standard way to deploy the web app in SAP HANA XSA-based environments. Besides the basic UI5 project, the generator will add an [Approuter](https://github.com/gregorwolf/SAP-NPM-API-collection/tree/master/apis/approuter) node.js-module that serves the web app.
-### SAP HTML5 Application Repository service for SAP BTP
-This option is a more sophisticate way to serve the web app from Cloud Foundry-based environments. The generator will include all modules that are included in the **Application Router @ Cloud Foundry** and, additionally, install a module to upload the web app to the HTML5 application repository during deploy-time. You can watch [this presentation](https://www.youtube.com/watch?v=emnl-y9btdU&list=PLVf0R17F93RXT2tzhHzAr-iiYTmc9KngS&index=11&t=0s) to learn more about the benefits of using the HTML5 application repository.
-### SAP Launchpad service
-Use this option if you would like to develop a Fiori Launchpad application that should run on Cloud Foundry. The generator will include all modules that are included in the **SAP HTML5 Application Repository service for SAP BTP** and, additionally, install a module that adds Fiori Launchpad resources to the HTML5 application repository.
-### SAP NetWeaver
-Use this option if you want to deploy your application(s) to the SAP NetWeaver ABAP Repository.
-
-## Installation
-
-1. Get [Node.js](https://nodejs.org/en/download/) (version 8.5 or higher)
-2. Install the generator
-    ```sh
-    npm install -g yo generator-easy-ui5
-    ```
-3. Verify your installation to see if Yeoman has been installed correctly
-    ```sh
-    yo
-    ```
-  Make sure you see the `easy-ui5` generator listed.
+## Download and Installation
 
+1. Install the generator
+   ```sh
+   npm install -g yo generator-easy-ui5
+   ```
+2. Verify your installation to see if Yeoman has been installed correctly
+   ```sh
+   yo
+   ```
+   Make sure you see the `easy-ui5` generator listed.
 
 ## Bootstrapping a new UI5 project
-> Create your first OpenUI5 App within a few seconds!
-
-1. Scaffold your OpenUI5 project
-    ```
-    yo easy-ui5
-    ```
-2. Answer the prompts to create your OpenUI5 project
-3. Run it locally
-    ```
-    cd <your project name>
-    npm start
-    ```
-
 
+> Create your first UI5 App within a few seconds!
 
-## Sub-generators to avoid recurring tasks
-
-### Add a new view
-This sub-generator will create a new view (of the same type you specified during the creating of your project) and a new controller and route. If you have OPA5 tests, you can add a corresponding page object now or later with another sub-generator.
-```
-yo easy-ui5:newview
-```
-
-### Create a custom control
-Run the following command from your project's root to scaffold a custom control.
-```
-yo easy-ui5:newcontrol
-```
+1. Scaffold your UI5 project
+   ```
+   yo easy-ui5 project
+   ```
+2. Answer the prompts to create your new project
+3. Run it locally
+   ```
+   cd <your project directory>
+   npm start # or "yarn start"
+   ```
 
-### Add a new model
-This sub-generator will create a new model in your manifest.  Currently, [JSON](https://sapui5.hana.ondemand.com/#/api/sap.ui.model.json.JSONModel) and [OData v2](https://sapui5.hana.ondemand.com/#/api/sap.ui.model.odata.v2.ODataModel) models are supported with various configuration options.
-```
-yo easy-ui5:newmodel
-```
+## Target platforms
 
-### Add a new component usage
-This sub-generator will add a new component usage for component reuse to your manifest.
-```
-yo easy-ui5:newcomponentusage
-```
+During the prompting phase, the generator will ask on which target platform your app should run. Currently, the following options are available:
 
-### UIVeri5 tests
-This sub-generator will add a basic [UIVeri5](https://github.com/SAP/ui5-uiveri5) test. It will ask you for test configuration and names of the suite and spec. You can add page objects now or later with another sub-generator.
-```
-yo easy-ui5:uiveri5
-```
-This sub-generator will create a UIVeri5 page object and a new test that shows how to use the page object:
-```
-yo easy-ui5:newuiveri5po
-```
-This sub-generator will create a UIVeri5 spec file:
-```
-yo easy-ui5:newuiveri5spec
-```
+- Static webserver
+- SAP BTP
+- SAP HANA XS Advanced
+- SAP NetWeaver
 
-### OPA5 tests
-This sub-generator will add a basic [OPA5](https://openui5.hana.ondemand.com/topic/2696ab50faad458f9b4027ec2f9b884d) test setup. You can add page objects now or later with another sub-generator.
-```
-yo easy-ui5:opa5
-```
-This sub-generator will create an OPA5 page object and add it to your journeys:
-```
-yo easy-ui5:newopa5po
-```
-This sub-generator will create an OPA5 journey and add it to your test page:
-```
-yo easy-ui5:newopa5journey
-```
+> Have a look at [this plugin project](https://github.com/ui5-community/generator-ui5-project/) for more usage instruction and information about the available subcommands.
 
-### `wdi5` test framework
 
-There's a sub-generator available to add
+## More generators
 
-- `wdi5` as the test framework
-- a basic `wdi5` config and
-- a sample test file
+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.
 
-to the UI5 application by `easy-ui5`.
+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:
+- Create new UI5 libraries [[ui5-community/generator-ui5-library]](https://github.com/ui5-community/generator-ui5-library)
+- More are coming!
+<!-- - Create new UI5 custom controls
+- Create middlewares for the UI5 tooling
+- Create tasks for the UI5 tooling
+- Create a WDI5 test suite -->
 
-```bash
-$> cd yourEasyUI5-project
-$> yo easy-ui5:wdi5
+To download and use any of the plugins above, run the following command
+```sh
+yo easy-ui5 [project|library] # this is the name of the repositorty without the "generator-ui5-" prefix
 ```
 
-## Deployment
-Depending on your target platform you'll need to install additional tools:
-
-### Cloud Foundry
-#### Required tools
-1. [Create a free account](https://developers.sap.com/mena/tutorials/hcp-create-trial-account.html) on SAP BTP Trial
-2. [Install](https://developers.sap.com/tutorials/cp-cf-download-cli.html) the Cloud Foundry Command Line Interface
-    ```sh
-    cf login
-    ```
-3. [Install](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin) the MultiApps CF CLI Plugin
-
-
-#### Deploy
-Call this command from the root directory to deploy the application to Cloud Foundry
-```
-npm run deploy
-```
+<!-- Are you missing a generator in this list and are you willing to provide one to the entire UI5 community? Great! [This blog posts](TODO INSERT LINK HERE) contains everything you need to know to get started!  -->
 
+## Calling generators
 
-> #### Optional: When using the HTML5 Applications Repository
-> [Install](https://sap.github.io/cf-html5-apps-repo-cli-plugin/) the HTML5 Applications Repository CF CLI Plugin:
->
-> `cf install-plugin -r CF-Community "html5-plugin"`
->
-> With this tool you can update your web app without the need to deploy a new cloud application:
->
-> `cf html5-push -n html5_repo_host .`
-
-### SAP HANA XSA
-#### Required tools
-1. SAP HANA or [create a free](https://developers.sap.com/group.hxe-install-binary.html) SAP HANA Express system
-2. [Install](https://developers.sap.com/tutorials/hxe-ua-install-xs-xli-client.html) the XS CLI Client
-    ```sh
-    xs login
-    ```
-
-#### Deploy
-Call this command from the root directory to deploy the application to HANA XSA
-```
-npm run deploy
+Run the following command to see all subgenerators of a given plugin
+```sh
+yo easy-ui5 [project|library] --list
 ```
+Once you decided on the subgenerator, run:
 
-### SAP NetWeaver
-#### Deploy
-Update the ui5.yaml file with your system settings (user, password & server) and ABAP repository settings (package, BSP Container & Transport).
-Run following command to deploy the application to SAP NetWeaver
-```
-npm run deploy
+Run the following command to see all subgenerators of a given plugin
+```sh
+yo easy-ui5 [project|library] <sub-generator-id>
 ```
 
-## Embedded Technologies
-This project leverages (among others) the following Open Source projects:
-* [UI5 Build and Development Tooling](https://github.com/SAP/ui5-tooling)
-* [OpenUI5. Build Once. Run on any device.](https://github.com/SAP/openui5)
-
-## Support
+## How to obtain support
 
 Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.
 
@@ -195,20 +100,13 @@ We welcome any type of contribution (code contributions, pull requests, issues)
 
 Please follow our instructions if you would like to [contribute](https://github.com/SAP/generator-easy-ui5/blob/master/CONTRIBUTING.md).
 
-## To-Do
-
-The following aspects/features are not yet implemented:
-* Decouple the sub-generators from the main flow. E.g. so that app router modules can be added after the generation of the UI5 web app.
-
-Contributions are very much appreciated.
-
-
-
 [npm-image]: https://img.shields.io/npm/v/generator-easy-ui5.svg
 [npm-url]: https://www.npmjs.com/package/generator-easy-ui5
-[circleci-image]: https://img.shields.io/circleci/project/github/SAP/generator-easy-ui5.svg
-[circleci-url]: https://circleci.com/gh/SAP/generator-easy-ui5
-[daviddm-image]: https://img.shields.io/david/SAP/generator-easy-ui5.svg
-[daviddm-url]: https://david-dm.org/SAP/generator-easy-ui5
+[test-image]: https://github.com/SAP/generator-easy-ui5/actions/workflows/main.yml/badge.svg
+[test-url]: https://github.com/SAP/generator-easy-ui5/actions/workflows/main.yml
+[librariesio-image]: https://img.shields.io/librariesio/github/SAP/generator-easy-ui5
+[repo-url]: https://github.com/SAP/generator-easy-ui5
 [license-image]: https://img.shields.io/npm/l/generator-easy-ui5.svg
 [license-url]: https://github.com/SAP/generator-easy-ui5/blob/master/LICENSE
+[reuse-image]: https://api.reuse.software/badge/github.com/SAP/generator-easy-ui5/
+[reuse-url]: https://api.reuse.software/info/github.com/SAP/generator-easy-ui5/