generator-easy-ui5 3.8.1 → 3.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +40 -34
  2. package/package.json +12 -11
  3. package/plugins/generator-ui5-project.zip +0 -0
package/README.md CHANGED
@@ -12,23 +12,25 @@ Easy UI5 (`easy-ui5`) 💙 is a [Yeoman](http://yeoman.io/) generator which enab
12
12
 
13
13
  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.
14
14
 
15
- 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).
15
+ The purpose of the (preinstalled) `project 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).
16
16
 
17
- > :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.
17
+ > :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.
18
18
  >
19
- > 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.
19
+ > 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.
20
20
 
21
21
  ## Requirements
22
22
 
23
- - Get [Node.js](https://nodejs.org/en/download/) (:warning: **version 18 or higher**)
23
+ - Get [Node.js](https://nodejs.org/en/download/) (:warning: **version 20 or higher**).
24
24
 
25
25
  ## Download and Installation
26
26
 
27
- 1. Install the generator
27
+ 1. Install the generator:
28
+
28
29
  ```sh
29
30
  npm install -g yo generator-easy-ui5
30
31
  ```
31
- 2. Verify your installation to see if Yeoman has been installed correctly
32
+
33
+ 2. Verify your installation to see if Yeoman has been installed correctly:
32
34
  ```sh
33
35
  yo
34
36
  ```
@@ -38,12 +40,15 @@ The purpose of the `project` subgenerator is to guide you on your first steps wi
38
40
 
39
41
  > Create your first UI5 App within a few seconds!
40
42
 
41
- 1. Scaffold your UI5 project
43
+ 1. Scaffold your UI5 project:
44
+
42
45
  ```
43
46
  yo easy-ui5 project
44
47
  ```
45
- 2. Answer the prompts to create your new project
46
- 3. Run it locally
48
+
49
+ 2. Answer the prompts to create your new project.
50
+
51
+ 3. Run it locally:
47
52
  ```
48
53
  cd <your project directory>
49
54
  npm start # or "yarn start"
@@ -51,63 +56,64 @@ The purpose of the `project` subgenerator is to guide you on your first steps wi
51
56
 
52
57
  ## Target platforms
53
58
 
54
- During the prompting phase, the generator will ask on which target platform your app should run. Currently, the following options are available:
59
+ During the prompting phase, the project generator will ask on which target platform your app should run. Currently, the following options are available:
55
60
 
56
61
  - Static webserver
57
- - SAP BTP
58
- - SAP HANA XS Advanced
62
+ - Application Router
63
+ - Application Frontend Service
64
+ - SAP HTML5 Application Repository
65
+ - SAP Build Work Zone, standard edition
59
66
  - SAP NetWeaver
60
67
 
61
- > 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.
68
+ > Have a look at the [project generator](https://github.com/ui5-community/generator-ui5-project/) for more usage instruction and information about its available subgenerators.
62
69
 
63
70
  ## More generators
64
71
 
65
72
  And this is just the start!
66
73
 
67
- 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.
74
+ 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.
68
75
 
69
- 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:
76
+ By default, this generator comes with the [project generator](https://github.com/ui5-community/generator-ui5-project) but there are many others as well:
70
77
 
71
- - Create new UI5 libraries [[ui5-community/generator-ui5-library]](https://github.com/ui5-community/generator-ui5-library)
72
- - More are coming!
73
- <!-- - Create new UI5 custom controls
74
- - Create middlewares for the UI5 tooling
75
- - Create tasks for the UI5 tooling
76
- - Create a WDI5 test suite -->
78
+ - [[ui5-community/generator-ui5-ts-app]](https://github.com/ui5-community/generator-ui5-ts-app)
79
+ - [[ui5-community/generator-ui5-ts-app-fcl]](https://github.com/ui5-community/generator-ui5-ts-app-fcl)
80
+ - [[ui5-community/generator-ui5-app]](https://github.com/ui5-community/generator-ui5-app)
81
+ - [[ui5-community/generator-ui5-flp-plugin]](https://github.com/ui5-community/generator-ui5-flp-plugin)
82
+ - [[ui5-community/generator-ui5-library]](https://github.com/ui5-community/generator-ui5-library)
83
+ - [[ui5-community/generator-ui5-ts-library]](https://github.com/ui5-community/generator-ui5-ts-library)
84
+ - [[ui5-community/generator-ui5-wdi5]](https://github.com/ui5-community/generator-ui5-wdi5)
85
+ - [[ui5-community/generator-ui5-add-extension]](https://github.com/ui5-community/generator-ui5-add-extension)
86
+ - [[ui5-community/generator-ui5-library-webc]](https://github.com/ui5-community/generator-ui5-library-webc)
77
87
 
78
- To download and use any of the plugins above, run the following command
88
+ To download and use any of the plugins above, run the following command:
79
89
 
80
90
  ```sh
81
- yo easy-ui5 [project|library] # this is the name of the repositorty without the "generator-ui5-" prefix
91
+ yo easy-ui5 [project|ts-app|...] # this is the name of the repository without the "generator-ui5-" prefix
82
92
  ```
83
93
 
84
- <!-- 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! -->
85
-
86
94
  ## Calling generators
87
95
 
88
- Run the following command to see all subgenerators of a given plugin
96
+ Run the following command to see all subgenerators of a given generator:
89
97
 
90
98
  ```sh
91
- yo easy-ui5 [project|library] --list
99
+ yo easy-ui5 [project|ts-app|...] --list
92
100
  ```
93
101
 
94
- Once you decided on the subgenerator, run:
95
-
96
- Run the following command to see all subgenerators of a given plugin
102
+ Once you decided on the generator, run:
97
103
 
98
104
  ```sh
99
- yo easy-ui5 [project|library] <sub-generator-id>
105
+ yo easy-ui5 [project|ts-app|...]
100
106
  ```
101
107
 
102
108
  ## Proxy settings
103
109
 
104
- 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:
110
+ 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:
105
111
 
106
112
  - `HTTP_PROXY`: Specify the value to use as the HTTP proxy for all connections, e.g., `HTTP_PROXY="http://proxy.mycompany.com:8080/"`.
107
113
  - `HTTPS_PROXY`: Specify the value to use as the HTTPS proxy for all connections, e.g., `HTTPS_PROXY="http://proxy.mycompany.com:8080/"`.
108
114
  - `NO_PROXY`: Define the hosts that should bypass the proxy, e.g., `NO_PROXY="localhost,.mycompany.com,192.168.6.254:80"`.
109
115
 
110
- In addition, Easy UI5 also supports proxy configuration from the `.npmrc` configuration:
116
+ In addition, easy-ui5 also supports proxy configuration from the `.npmrc` configuration:
111
117
 
112
118
  ```text
113
119
  http-proxy=http://proxy.mycompany.com:8080/
@@ -131,7 +137,7 @@ Please use the GitHub bug tracking system to post questions, bug reports or to c
131
137
 
132
138
  ## Contributing
133
139
 
134
- We welcome any type of contribution (code contributions, pull requests, issues) to this easy-ui5 generator equally.
140
+ We welcome any type of contribution (code contributions, pull requests, issues) to this project equally.
135
141
 
136
142
  Please follow our instructions if you would like to [contribute](https://github.com/SAP/generator-easy-ui5/blob/master/CONTRIBUTING.md).
137
143
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "generator-easy-ui5",
3
- "version": "3.8.1",
3
+ "version": "3.8.2",
4
4
  "description": "Generator for UI5-based project",
5
5
  "main": "generators/app/index.js",
6
6
  "type": "module",
@@ -9,10 +9,10 @@
9
9
  "plugins"
10
10
  ],
11
11
  "engines": {
12
- "node": ">=18"
12
+ "node": ">=20"
13
13
  },
14
14
  "scripts": {
15
- "prepublishOnly": "npx yo@4.3.1 ./ project --embed",
15
+ "prepublishOnly": "npx yo@5.1.0 ./generators/app/index.js project --embed",
16
16
  "start": "yo easy-ui5 project",
17
17
  "test": "mocha",
18
18
  "test:subgen:list": "yo easy-ui5 project --list",
@@ -48,17 +48,17 @@
48
48
  },
49
49
  "homepage": "https://github.com/SAP/generator-easy-ui5#readme",
50
50
  "dependencies": {
51
- "@octokit/plugin-throttling": "^8.1.3",
52
- "@octokit/rest": "^20.0.2",
53
- "adm-zip": "^0.5.10",
54
- "chalk": "^5.3.0",
51
+ "@octokit/plugin-throttling": "^11.0.1",
52
+ "@octokit/rest": "^22.0.0",
53
+ "adm-zip": "^0.5.16",
54
+ "chalk": "^5.4.1",
55
55
  "colors": "^1.4.0",
56
- "glob": "^10.3.10",
56
+ "glob": "^11.0.3",
57
57
  "libnpmconfig": "^1.2.1",
58
58
  "node-fetch": "^3.3.2",
59
59
  "rimraf": "^5.0.5",
60
- "yeoman-environment": "^3.19.3",
61
- "yeoman-generator": "^5.10.0",
60
+ "yeoman-environment": "^4.4.3",
61
+ "yeoman-generator": "^7.5.1",
62
62
  "yosay": "^2.0.2"
63
63
  },
64
64
  "devDependencies": {
@@ -67,6 +67,7 @@
67
67
  "conventional-changelog-cli": "^4.1.0",
68
68
  "cz-conventional-changelog": "^3.3.0",
69
69
  "eslint": "^8.54.0",
70
+ "fs-extra": "^11.3.0",
70
71
  "husky": "^8.0.3",
71
72
  "lint-staged": "^15.1.0",
72
73
  "mocha": "^10.2.0",
@@ -74,7 +75,7 @@
74
75
  "prettier": "^2.8.8",
75
76
  "pretty-quick": "^3.1.3",
76
77
  "yeoman-assert": "^3.1.1",
77
- "yeoman-test": "^7.4.0"
78
+ "yeoman-test": "^10.1.1"
78
79
  },
79
80
  "config": {
80
81
  "commitizen": {
package/plugins/generator-ui5-project.zip CHANGED
Binary file