ui5-community · petermuessig · Jul 31, 2023 · Jul 30, 2023
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,6 +11,10 @@ A sub-package **may** have an additional CONTRIBUTING.md file if needed.
 - A [Long-Term Support version](https://nodejs.org/en/about/releases/) of Node.js
 - (optional) [commitizen](https://github.com/commitizen/cz-cli#installing-the-command-line-tool) for managing commit messages.
 
+### Branches
+
+The development branch is the `main` branch. It only supports tooling extensions for UI5 Tooling **V3**. The tooling extensions which also support the older versions of the UI5 Tooling can be found in the [**V2** branch](https://github.com/ui5-community/ui5-ecosystem-showcase/tree/v2).
+
 ### Initial Setup
 
 The initial setup is trivial:

diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # ui5-ecosystem-showcase
 
-A repository showcasing the UI5 Tooling ecosystem idea.
+The repository showcasing the UI5 Tooling ecosystem possibilites. 
+
+> :warning: All tooling extensions only support UI5 Tooling **V3** only! The support for UI5 Tooling **V2** has been removed. All tooling extensions with **V3** support have the major version `3.x.x`, for the **V2** support please use the previous versions of the tooling extensions.
 
 [![OpenUI5 Community Slack (#tooling channel)](https://img.shields.io/badge/slack-join-44cc11.svg)](https://join-ui5-slack.herokuapp.com)
 

diff --git a/packages/cds-plugin-ui5/README.md b/packages/cds-plugin-ui5/README.md
@@ -1,10 +1,16 @@
 # cds-plugin-ui5
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 The `cds-plugin-ui5` is a CAP server `cds-plugin` which enables the integration of UI5 tooling based (UI5 freestyle or Fiori elements) projects into the CAP server via the UI5 tooling express middlewares. The UI5 or Fiori elements projects just need to be located in the `app` folder of the CAP server or be dependency of the CAP server.
 
 > :construction: **Note**
 > This cds-plugin is still work in progress and not final yet!
 
+## Prerequisites
+
+The plugin requires [`@sap/cds`](https://www.npmjs.com/package/@sap/cds) `>=6.8.2`.
+
 ## Usage
 
 Add a `devDependency` to the `cds-plugin-ui5` to your CAP server project:

diff --git a/packages/karma-ui5-transpile/README.md b/packages/karma-ui5-transpile/README.md
@@ -1,10 +1,16 @@
 # karma-ui5-transpile
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 The `karma-ui5-transpile` preprocessor transpiles code of UI5 projects having a `ui5.yaml` using `ui5-tooling-transpile` tooling extension. This preprocesser is usable for [Karma](https://karma-runner.github.io/) testing to transpile your resources before testing (i.e. TypeScript compilation for later usage of the [`karma-coverage`](https://www.npmjs.com/package/karma-coverage) plugin).
 
+## Prerequisites
+
+The plugin requires [`karma`](https://www.npmjs.com/package/karma) `>=6.4.1`, and [ui5-tooling-transpile](https://www.npmjs.com/package/ui5-tooling-transpile) `>=3.0.0`.
+
 ## Installation
 
-The plugin requires [`karma`](https://www.npmjs.com/package/karma) `>=6.4.1`, and [ui5-tooling-transpile](https://www.npmjs.com/package/ui5-tooling-transpile) `>=0.7.0`. You can install the required dependencies with the following command:
+You can install the required dependencies with the following command:
 
 ```sh
 npm install --save-dev karma karma-coverage ui5-tooling-transpile karma-ui5 karma-ui5-transpile

diff --git a/packages/ui5-middleware-cap/README.md b/packages/ui5-middleware-cap/README.md
@@ -1,10 +1,19 @@
 # ui5-middleware-cap
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 The `ui5-middleware-cap` is a UI5 tooling middleware which enables the integration of a CAP server into the UI5 development server via the CAP server express middlewares. In addition to the middleware the CAP server project needs to be added as dependency so that the server is detected and attached properly. The pre-defined routes in the CAP server are reused.
 
 > :construction: **Note**
 > This middleware is still work in progress and not final yet!
 
+## Prerequisites
+
+- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30))
+
+> :warning: **UI5 Tooling Compatibility**
+> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3!
+
 ## Usage
 
 Add a `devDependency` to the `ui5-middleware-cap`:

diff --git a/packages/ui5-middleware-cfdestination/README.md b/packages/ui5-middleware-cfdestination/README.md
@@ -1,7 +1,16 @@
 # UI5 middleware for CF destinations
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 Middleware for [ui5-server](https://github.com/SAP/ui5-server), making `destinations` configured in SAP CF available for local development.
 
+## Prerequisites
+
+- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30))
+
+> :warning: **UI5 Tooling Compatibility**
+> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3!
+
 ## Install
 
 ```bash
@@ -62,18 +71,9 @@ This sets the body size limit. If the body size is larger than the specified (or
  // ...
  "ui5-middleware-cfdestination": "*"
  // ...
-},
-"ui5": {
- "dependencies": [
- // ...
- "ui5-middleware-cfdestination",
- // ...
- ]
 }
 ```
 
-> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.
-
 2. configure it in `$yourapp/ui5.yaml`:
 
 ```yaml

diff --git a/packages/ui5-middleware-iasync/README.md b/packages/ui5-middleware-iasync/README.md
@@ -1,7 +1,16 @@
 # UI5 middleware for syncing interactions across browsers
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 Middleware for [ui5-server](https://github.com/SAP/ui5-server), syncing interactions between different browsers, hopefully somewhat easing manual testing :) 
 
+## Prerequisites
+
+- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30))
+
+> :warning: **UI5 Tooling Compatibility**
+> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3!
+
 ## Install
 
 ```bash
@@ -30,18 +39,9 @@ show connected browsers
  // ...
  "ui5-middleware-iasync": "*"
  // ...
-},
-"ui5": {
- "dependencies": [
- // ...
- "ui5-middleware-iasync",
- // ...
- ]
 }
 ```
 
-> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.
-
 2. configure it in `$yourapp/ui5.yaml`:
 
 ```yaml

diff --git a/packages/ui5-middleware-index/README.md b/packages/ui5-middleware-index/README.md
@@ -1,7 +1,16 @@
 # UI5 middleware for delivering a welcome/start/'index' page to the client
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 Middleware for [ui5-server](https://github.com/SAP/ui5-server), delivering the `$index.html` of choice (instead of the directory listing).
 
+## Prerequisites
+
+- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30))
+
+> :warning: **UI5 Tooling Compatibility**
+> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3!
+
 ## Install
 
 ```bash
@@ -23,18 +32,9 @@ npm install ui5-middleware-index --save-dev
  // ...
  "ui5-middleware-index": "*"
  // ...
-},
-"ui5": {
- "dependencies": [
- // ...
- "ui5-middleware-index",
- // ...
- ]
 }
 ```
 
-> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.
-
 2. configure it in `$yourapp/ui5.yaml`:
 
 ```yaml

diff --git a/packages/ui5-middleware-livecompileless/README.md b/packages/ui5-middleware-livecompileless/README.md
@@ -1,7 +1,16 @@
 # UI5 middleware for live compiling less files
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 Middleware for [ui5-server](https://github.com/SAP/ui5-server), live compiling less files.
 
+## Prerequisites
+
+- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30))
+
+> :warning: **UI5 Tooling Compatibility**
+> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3!
+
 ## Install
 
 ```bash
@@ -22,18 +31,9 @@ npm install ui5-middleware-livecompileless --save-dev
  // ...
  "ui5-middleware-livecompileless": "*"
  // ...
-},
-"ui5": {
- "dependencies": [
- // ...
- "ui5-middleware-livecompileless",
- // ...
- ]
 }
 ```
 
-> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.
-
 2. configure it in `$yourapp/ui5.yaml`:
 
 ```yaml

diff --git a/packages/ui5-middleware-livereload/README.md b/packages/ui5-middleware-livereload/README.md
@@ -1,7 +1,16 @@
 # UI5 middleware for live reloading `webapp` sources on change
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 Middleware for [ui5-server](https://github.com/SAP/ui5-server), doing a live reload when files inside `$yourapp` change, e.g. on save.
 
+## Prerequisites
+
+- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30))
+
+> :warning: **UI5 Tooling Compatibility**
+> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3!
+
 ## Install
 
 ```bash
@@ -33,18 +42,9 @@ npm install ui5-middleware-livereload --save-dev
  // ...
  "ui5-middleware-livereload": "*"
  // ...
-},
-"ui5": {
- "dependencies": [
- // ...
- "ui5-middleware-livereload",
- // ...
- ]
 }
 ```
 
-> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.
-
 2. configure it in `$yourapp/ui5.yaml`:
 
 ```yaml

diff --git a/packages/ui5-middleware-onelogin/README.md b/packages/ui5-middleware-onelogin/README.md
@@ -1,5 +1,7 @@
 # UI5 onelogin middleware
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 Middleware for [ui5-server](https://github.com/SAP/ui5-server), enabling a generic login support.
 
 The middleware will on first request try to login with the provided credentials and save the cookie for further requests. This uses playwright in a headless mode to run the login process.
@@ -9,6 +11,13 @@ This has been tested with Azure AD, Google, OpenAM and the SAP Gateway login pag
 
 Merge requests with other login handlers are more than welcome via pull request.
 
+## Prerequisites
+
+- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30))
+
+> :warning: **UI5 Tooling Compatibility**
+> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3!
+
 ## Install
 
 ```bash
@@ -50,18 +59,9 @@ You can choose to just add the url and let the rest be prompted in the terminal
  // ...
  "ui5-middleware-onelogin": "*"
  // ...
-},
-"ui5": {
- "dependencies": [
- // ...
- "ui5-middleware-onelogin",
- // ...
- ]
 }
 ```
 
-> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.
-
 2. configure it in `$yourapp/ui5.yaml`:
 
 ```yaml
@@ -79,4 +79,4 @@ server:
 
 ## License
 
-MIT
+This work is [dual-licensed](../../LICENSE) under Apache 2.0 and the Derived Beer-ware License. The official license will be Apache 2.0 but finally you can choose between one of them if you use this work.
diff --git a/packages/ui5-middleware-servestatic/README.md b/packages/ui5-middleware-servestatic/README.md
@@ -1,7 +1,16 @@
 # UI5 serve static middleware
 
+> :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
+
 Middleware for [ui5-server](https://github.com/SAP/ui5-server), enabling to serve static resources.
 
+## Prerequisites
+
+- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30))
+
+> :warning: **UI5 Tooling Compatibility**
+> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3!
+
 ## Install
 
 ```bash
@@ -22,18 +31,9 @@ npm install ui5-middleware-servestatic --save-dev
  // ...
  "ui5-middleware-servestatic": "*"
  // ...
-},
-"ui5": {
- "dependencies": [
- // ...
- "ui5-middleware-servestatic",
- // ...
- ]
 }
 ```
 
-> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.
-
 2. configure it in `$yourapp/ui5.yaml`: 
 
 ```yaml

diff --git a/packages/ui5-middleware-simpleproxy/README.md b/packages/ui5-middleware-simpleproxy/README.md
@@ -2,6 +2,13 @@
 
 Middleware for [ui5-server](https://github.com/SAP/ui5-server), enabling proxy support.
 
+## Prerequisites
+
+- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30))
+
+> :warning: **UI5 Tooling Compatibility**
+> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3!
+
 ## Install
 
 ```bash
@@ -44,18 +51,9 @@ In general, use of environment variables or values set in a `.env` file will ove
  // ...
  "ui5-middleware-simpleproxy": "*"
  // ...
-},
-"ui5": {
- "dependencies": [
- // ...
- "ui5-middleware-simpleproxy",
- // ...
- ]
 }
 ```
 
-> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.
-
 2. configure it in `$yourapp/ui5.yaml`:
 
 ```yaml