From 002a8429698542e1523dafacc312b6381cdf5e0e Mon Sep 17 00:00:00 2001 From: Peter Muessig Date: Sun, 30 Jul 2023 19:58:25 +0200 Subject: [PATCH] docs: updated README.md for UI5 Tooling V3 release --- CONTRIBUTING.md | 4 + README.md | 4 +- packages/cds-plugin-ui5/README.md | 6 + packages/karma-ui5-transpile/README.md | 8 +- packages/ui5-middleware-cap/README.md | 9 + .../ui5-middleware-cfdestination/README.md | 18 +- packages/ui5-middleware-iasync/README.md | 18 +- packages/ui5-middleware-index/README.md | 18 +- .../ui5-middleware-livecompileless/README.md | 18 +- packages/ui5-middleware-livereload/README.md | 18 +- packages/ui5-middleware-onelogin/README.md | 20 +- packages/ui5-middleware-servestatic/README.md | 18 +- packages/ui5-middleware-simpleproxy/README.md | 16 +- packages/ui5-middleware-webjars/README.md | 18 +- packages/ui5-task-cachebuster/README.md | 196 +++++++++--------- packages/ui5-task-compileless/README.md | 18 +- packages/ui5-task-flatten-library/README.md | 16 +- packages/ui5-task-i18ncheck/README.md | 20 +- packages/ui5-task-minify-xml/README.md | 18 +- packages/ui5-task-pwa-enabler/README.md | 18 +- packages/ui5-task-zipper/README.md | 35 +--- packages/ui5-task-zipper/test/zipper.test.js | 22 +- packages/ui5-tooling-modules/README.md | 18 +- packages/ui5-tooling-stringreplace/README.md | 20 +- packages/ui5-tooling-transpile/README.md | 20 +- packages/ui5-tooling-transpile/package.json | 2 +- 26 files changed, 290 insertions(+), 306 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12ab1da9e..e15de455e 100644 --- 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 index a927eb99b..dd646c204 100644 --- 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 index c47a0f1fd..3b9bee162 100644 --- 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 index 96ec36e55..93a745ba2 100644 --- 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 index 7ccbb56e9..1bc825062 100644 --- 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/cli@3.0.0`](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 index 0ba7744f8..4dc8e7212 100644 --- 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/cli@3.0.0`](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 index c3523746f..bd88cab3f 100644 --- 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/cli@3.0.0`](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 index 39a64f873..930d31551 100644 --- 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/cli@3.0.0`](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 index fd4667d75..082518cf1 100644 --- 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/cli@3.0.0`](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 index ac904598f..57530996a 100644 --- 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/cli@3.0.0`](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 index 9193b255f..f22cba22a 100644 --- 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/cli@3.0.0`](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 index e0b0453b0..0c8117034 100644 --- 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/cli@3.0.0`](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 index 0a99a29ff..669e922be 100644 --- 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/cli@3.0.0`](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 diff --git a/packages/ui5-middleware-webjars/README.md b/packages/ui5-middleware-webjars/README.md index 6fa535da1..295e73f5a 100644 --- a/packages/ui5-middleware-webjars/README.md +++ b/packages/ui5-middleware-webjars/README.md @@ -1,7 +1,16 @@ # UI5 middleware for delivering content from JAR 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), delivering the content of JAR files. +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 @@ -35,18 +44,9 @@ npm install ui5-middleware-webjars --save-dev // ... "ui5-middleware-webjars": "*" // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-middleware-webjars", - // ... - ] } ``` -> 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-task-cachebuster/README.md b/packages/ui5-task-cachebuster/README.md index f84e77223..d8309cfe5 100644 --- a/packages/ui5-task-cachebuster/README.md +++ b/packages/ui5-task-cachebuster/README.md @@ -1,98 +1,98 @@ -## This task is only relevant for standalone applications! - -Task for [ui5-builder](https://github.com/SAP/ui5-builder), enabling cachebusting for standalone applications. - -## Install - -```bash -npm install ui5-task-cachebuster --save-dev -``` - -## Configuration options (in `$yourapp/ui5.yaml`) - -- debug: `true|false`\ -Verbose logging -- moveResouces: `true|false`\ -default true: moves all the files in the build to a subfolder named `/~timestamp~/`\ -false: no files are moved and no subfolder created -- excludeFromMove : eg. `["index.html", "logout.html"]`\ -only relevant if moveResources is `true`\ -default `["index.html"]`: the files which should not be moved into the timestamp subfolder - -## Usage - -1. Define the dependency in `$yourapp/package.json`: - -```json -"devDependencies": { - // ... - "ui5-task-cachebuster": "*" - // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-task-cachebuster", - // ... - ] -} -``` - -> 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`: - -What is possible: -```yaml -builder: - customTasks: - - name: ui5-task-cachebuster - afterTask: uglify - configuration: - debug: true | false - moveResources: true | false - excludeFromMove: ["index.html", "logout.html"] -``` -For app in SAP BTP in Cloud Foundry environment with managed approuter: -```yaml -builder: - customTasks: - - name: ui5-task-cachebuster - afterTask: uglify - configuration: - moveResources: false -``` - -If ui5-task-zipper is used you need to include the beforeTask config. -```yaml - - name: ui5-task-cachebuster - beforeTask: ui5-task-zipper -``` - -## How it works -**This is only relevant for standalone applications, not apps that run in SAP Fiori Launchpad** - -Why do we need this? -"Cache busting is a way for updates to still happen when using web caching." -To make sure that the newest deployed changes of the webapp are displayed, even though web caching is used by the client browsers, a cachetoken is added to the paths which point to the static files. This cachetoken is changing for each build, therefore the browser has to reload all resources if the cachetoken has changed. - -Standalone apps have to explicitly deal with cachbusting. - -This task can be used to move all files except index.html to a subfolder with the current timestamp as a name. In the index.html the `data-sap-ui-resourceroots` path is updated to include the `/~timestamp~/` path like so: `{"my.app": "./~1234241421~/"}`. -This dynamic cachebusting token ensures that the static resources will have to be reloaded after a new build was deployed. - -If the app is deployed on SAP BTP in the Cloud Foundry environment with the managed approuter, the configuration `moveResources: false` should be used, since the `~token~` in the path to the files will be ignored. - -If you included any other .html files in your project who's path should not change, like a logout.html which is routed to in the xs-app.json, you should add it to the `excludeFromMove` configuration. This takes an array of file paths (relative to webapp folder) which should not be moved into the timestamp subfolder. - -Use Cases: -- Standalone Web-Server: - Adapt index.html + Move files into timestamp folder -- CloudFoundry HTML5 Apps with managed approuter: - Just adapt index.html -- Neo HTML5 Apps: - Adapt index.html + enable cachebuster handling in neo-app.json with ui5CacheBuster: true - -## License - -This work is [licensed](../../LICENSE) under Apache 2.0. +## This task is only relevant for standalone applications! + +> :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. + +Task for [ui5-builder](https://github.com/SAP/ui5-builder), enabling cachebusting for standalone applications. + +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 +npm install ui5-task-cachebuster --save-dev +``` + +## Configuration options (in `$yourapp/ui5.yaml`) + +- debug: `true|false`\ +Verbose logging +- moveResouces: `true|false`\ +default true: moves all the files in the build to a subfolder named `/~timestamp~/`\ +false: no files are moved and no subfolder created +- excludeFromMove : eg. `["index.html", "logout.html"]`\ +only relevant if moveResources is `true`\ +default `["index.html"]`: the files which should not be moved into the timestamp subfolder + +## Usage + +1. Define the dependency in `$yourapp/package.json`: + +```json +"devDependencies": { + // ... + "ui5-task-cachebuster": "*" + // ... +} +``` + +2. configure it in `$yourapp/ui5.yaml`: + +What is possible: +```yaml +builder: + customTasks: + - name: ui5-task-cachebuster + afterTask: uglify + configuration: + debug: true | false + moveResources: true | false + excludeFromMove: ["index.html", "logout.html"] +``` +For app in SAP BTP in Cloud Foundry environment with managed approuter: +```yaml +builder: + customTasks: + - name: ui5-task-cachebuster + afterTask: uglify + configuration: + moveResources: false +``` + +If ui5-task-zipper is used you need to include the beforeTask config. +```yaml + - name: ui5-task-cachebuster + beforeTask: ui5-task-zipper +``` + +## How it works +**This is only relevant for standalone applications, not apps that run in SAP Fiori Launchpad** + +Why do we need this? +"Cache busting is a way for updates to still happen when using web caching." +To make sure that the newest deployed changes of the webapp are displayed, even though web caching is used by the client browsers, a cachetoken is added to the paths which point to the static files. This cachetoken is changing for each build, therefore the browser has to reload all resources if the cachetoken has changed. + +Standalone apps have to explicitly deal with cachbusting. + +This task can be used to move all files except index.html to a subfolder with the current timestamp as a name. In the index.html the `data-sap-ui-resourceroots` path is updated to include the `/~timestamp~/` path like so: `{"my.app": "./~1234241421~/"}`. +This dynamic cachebusting token ensures that the static resources will have to be reloaded after a new build was deployed. + +If the app is deployed on SAP BTP in the Cloud Foundry environment with the managed approuter, the configuration `moveResources: false` should be used, since the `~token~` in the path to the files will be ignored. + +If you included any other .html files in your project who's path should not change, like a logout.html which is routed to in the xs-app.json, you should add it to the `excludeFromMove` configuration. This takes an array of file paths (relative to webapp folder) which should not be moved into the timestamp subfolder. + +Use Cases: +- Standalone Web-Server: + Adapt index.html + Move files into timestamp folder +- CloudFoundry HTML5 Apps with managed approuter: + Just adapt index.html +- Neo HTML5 Apps: + Adapt index.html + enable cachebuster handling in neo-app.json with ui5CacheBuster: true + +## License + +This work is [licensed](../../LICENSE) under Apache 2.0. diff --git a/packages/ui5-task-compileless/README.md b/packages/ui5-task-compileless/README.md index d6bcedf1e..2228834fa 100644 --- a/packages/ui5-task-compileless/README.md +++ b/packages/ui5-task-compileless/README.md @@ -1,7 +1,16 @@ # UI5 task for 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. + Task for [ui5-builder](https://github.com/SAP/ui5-builder), enabling compiling of less files in your app folder. +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 @@ -28,18 +37,9 @@ npm install ui5-task-compileless --save-dev // ... "ui5-task-compileless": "*" // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-task-compileless", - // ... - ] } ``` -> 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-task-flatten-library/README.md b/packages/ui5-task-flatten-library/README.md index f11716559..2075975be 100644 --- a/packages/ui5-task-flatten-library/README.md +++ b/packages/ui5-task-flatten-library/README.md @@ -1,10 +1,15 @@ # UI5 task to flatten the library folder structure +> :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. + Task for [ui5-builder](https://github.com/SAP/ui5-builder), to prepare build result for deployment to SAP NetWeaver. ## Prerequisites -- Requires `@ui5/cli` v2.4.0+ (to support [specVersion 2.2](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-22)) +- Requires at least [`@ui5/cli@3.0.0`](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 @@ -28,18 +33,9 @@ yarn add --dev ui5-task-flatten-library // ... "ui5-task-flatten-library": "*" // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-task-flatten-library", - // ... - ] } ``` -> 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-task-i18ncheck/README.md b/packages/ui5-task-i18ncheck/README.md index ce004a71a..6ce228d8d 100644 --- a/packages/ui5-task-i18ncheck/README.md +++ b/packages/ui5-task-i18ncheck/README.md @@ -1,7 +1,16 @@ # UI5 task for checking missing translations in i18n properties used in XML views +> :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. + Task for [ui5-builder](https://github.com/SAP/ui5-builder), checking missing translations. +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 @@ Verbose logging // ... "ui5-task-i18ncheck": "*" // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-task-i18ncheck", - // ... - ] } ``` -> 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 @@ -53,4 +53,4 @@ The task reads all XML views and i18n properties files. Then the task cross-chec 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. -When you like this stuff, buy [@vobu](https://twitter.com/vobu) a beer or buy [@pmuessig](https://twitter.com/pmuessig) or [@fatihpense](https://twitter.com/fatihpense) a coke when you see them. \ No newline at end of file +When you like this stuff, buy [@vobu](https://twitter.com/vobu) a beer or buy [@pmuessig](https://twitter.com/pmuessig) or [@fatihpense](https://twitter.com/fatihpense) a coke when you see them. diff --git a/packages/ui5-task-minify-xml/README.md b/packages/ui5-task-minify-xml/README.md index e6115f6bb..70e6e49cf 100644 --- a/packages/ui5-task-minify-xml/README.md +++ b/packages/ui5-task-minify-xml/README.md @@ -1,7 +1,16 @@ # UI5 task for minifying XML resources (like views, fragments, etc.) +> :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. + Task for [ui5-builder](https://github.com/SAP/ui5-builder), enabling XML minification based on [minify-xml](https://github.com/kristian/minify-xml#readme). +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 @@ -28,18 +37,9 @@ npm install ui5-task-minify-xml --save-dev // ... "ui5-task-minify-xml": "*" // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-task-minify-xml", - // ... - ] } ``` -> 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-task-pwa-enabler/README.md b/packages/ui5-task-pwa-enabler/README.md index 2d53ab44d..f83ccdea2 100644 --- a/packages/ui5-task-pwa-enabler/README.md +++ b/packages/ui5-task-pwa-enabler/README.md @@ -1,6 +1,15 @@ # UI5 task for turning a UI5 App into a PWA -[What are Progressive Web Apps (PWAs)?](https://web.dev/progressive-web-apps/) +> :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. + +Progressive Web Apps are web applications that have been designed to be capable, reliable, and installable. These three pillars transform them into an experience that feels like a platform-specific application. Interested? Find out more here: [What are Progressive Web Apps (PWAs)?](https://web.dev/progressive-web-apps/). + +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 @@ -41,11 +50,6 @@ Whatever you supply here will be copied to the `manifest.webmanifest` file, you ```json "devDependencies": { "ui5-task-pwa-enabler": "*" -}, -"ui5": { - "dependencies": [ - "ui5-task-pwa-enabler" - ] } ``` @@ -107,4 +111,4 @@ your own fancy PWA. 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. -When you like this stuff, buy [@vobu](https://twitter.com/vobu), [@maxmoehl](https://github.com/maxmoehl) or [@monakac](https://github.com/monakac) a beer or buy [@pmuessig](https://twitter.com/pmuessig) a coke when you see them. +When you like this stuff, buy [@maxmoehl](https://github.com/maxmoehl) or [@monakac](https://github.com/monakac) a beer when you see them. diff --git a/packages/ui5-task-zipper/README.md b/packages/ui5-task-zipper/README.md index 531fa4690..83285d55a 100644 --- a/packages/ui5-task-zipper/README.md +++ b/packages/ui5-task-zipper/README.md @@ -1,7 +1,16 @@ # UI5 task for zipping all project resources +> :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. + Task for [ui5-builder](https://github.com/SAP/ui5-builder), enabling zipping. +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 @@ -35,32 +44,10 @@ Set this to `true` if you also want to include the dependencies (UI5 libraries) // ... "ui5-task-zipper": "*" // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-task-zipper", - // ... - ] } ``` -> 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` for UI5 tooling 2.x: - -```yaml -builder: - customTasks: - - name: ui5-task-zipper - afterTask: uglify - configuration: - archiveName: "webapp" - additionalFiles: - - xs-app.json -``` - -or for UI5 tooling 3.x: +2. configure it in `$yourapp/ui5.yaml`: ```yaml builder: @@ -75,8 +62,6 @@ builder: "path/to/files/bar.js": "some/custom/dir/bar.js" ``` -> :warning: For UI5 Tooling V3 the configuration `afterTask: uglify` needs to be adopted to `afterTask: generateVersionInfo`. This works for the UI5 Tooling V2 and V3. - ### Select the dependencies to include With the configuration option `includeDependencies` you can also specifiy a list of dependencies to be included in the zip file. To do so, specify a list of dependencies using their `ui5.yaml`: `metadata > name` property: diff --git a/packages/ui5-task-zipper/test/zipper.test.js b/packages/ui5-task-zipper/test/zipper.test.js index 928e5ed45..b36b127ff 100644 --- a/packages/ui5-task-zipper/test/zipper.test.js +++ b/packages/ui5-task-zipper/test/zipper.test.js @@ -168,27 +168,7 @@ test("shims are included", async (t) => { t.true(allDepsFound.every((dep) => dep === true)); }); -test("Some UI5 lib dependencies are included (V2)", async (t) => { - const ui5 = { - yaml: path.resolve("./test/__assets__/ui5-app/ui5.includeSomeDeps.yaml"), - }; - spawnSync(`ui5 build --config ${ui5.yaml} --dest ${t.context.tmpDir}/dist`, { - stdio: "inherit", // > don't include stdout in test output, - shell: true, - cwd: path.resolve(__dirname, "../../../showcases/ui5-app"), - }); - - const zip = path.join(t.context.tmpDir, "dist", "ui5ecosystemdemoapp.zip"); - // see libraries deps in ui5.includeDepy.yaml - const allDepsFound = await Promise.allSettled([ - promisifiedNeedleInHaystack(zip, "resources/sap/ui/core"), - promisifiedNeedleInHaystack(zip, "resources/sap/ui/layout"), - ]); - t.false(allDepsFound[0].value); - t.true(allDepsFound[1].value); -}); - -test("Some UI5 lib dependencies are included (V3)", async (t) => { +test("Some UI5 lib dependencies are included", async (t) => { const ui5 = { yaml: path.resolve("./test/__assets__/ui5-app-simple/ui5.includeSomeDeps.yaml"), }; diff --git a/packages/ui5-tooling-modules/README.md b/packages/ui5-tooling-modules/README.md index 858e98c4d..a24bd1b3e 100644 --- a/packages/ui5-tooling-modules/README.md +++ b/packages/ui5-tooling-modules/README.md @@ -1,6 +1,6 @@ # UI5 Tooling Extensions for NPM Package Consumption -> **DISCLAIMER**: This is a community project and there is no official support for this package! Also the functionality may stop working at any time in future with newer versions of the UI5 tooling! +> :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 tooling extensions include a custom middleware and a custom task which allow to use NPM package names for AMD-like dependencies, e.g.: @@ -22,6 +22,13 @@ sap.ui.define([ Once the UI5 application is finally built, the Chart.js dependency will be copied into the `dist/resources` folder with the proper namespace. In case of Chart.js above, there is no namespace and thus the location will be `dist/resources/chart.js.js`. +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 @@ -61,18 +68,9 @@ npm install ui5-tooling-modules --save-dev // ... "ui5-tooling-modules": "*" // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-tooling-modules", - // ... - ] } ``` -> 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`: The configuration for the custom task: diff --git a/packages/ui5-tooling-stringreplace/README.md b/packages/ui5-tooling-stringreplace/README.md index 0fd7f9d40..15fea0851 100644 --- a/packages/ui5-tooling-stringreplace/README.md +++ b/packages/ui5-tooling-stringreplace/README.md @@ -1,7 +1,16 @@ -# UI5 tooling extension middleware and task for replacing strings +# UI5 Tooling Extension for Replacing Strings + +> :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. Task and Middleware for [ui5-server](https://github.com/SAP/ui5-server), doing a live string replace on files matched by the includePatterns `files` array configuration option. +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 @@ yarn add --dev ui5-tooling-stringreplace // ... "ui5-tooling-stringreplace": "*" // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-tooling-stringreplace", - // ... - ] } ``` -> 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-tooling-transpile/README.md b/packages/ui5-tooling-transpile/README.md index 79aa2f60f..45c74d4d2 100644 --- a/packages/ui5-tooling-transpile/README.md +++ b/packages/ui5-tooling-transpile/README.md @@ -1,6 +1,6 @@ # UI5 Tooling Extension for Transpiling JS/TS -> **DISCLAIMER**: This is a community project and there is no official support for this package! Also the functionality may stop working at any time in future with newer versions of the UI5 tooling! +> :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 tooling extension provides a middleware and a task which transpiles JavaScript or TypeScript code to ES5 by using Babel. A default Babel configuration will be provided by the tooling extension unless a inline Babel configuration in the `ui5.yaml` or any Babel configuration as described at [Babel config files](https://babeljs.io/docs/en/config-files) will be provided. @@ -8,6 +8,13 @@ The middleware handles by default all requests to `.js`-files. For JavaScript tr The task finally transpiles the relevant source files during the UI5 Tooling build process. In case of TypeScript is enabled, for libraries, the task also generates the `d.ts`-files. For applications, this option can be enabled on demand. +## Prerequisites + +- Requires at least [`@ui5/cli@3.0.0`](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 @@ -76,20 +83,9 @@ Define the dependency in `$yourapp/package.json`: // ... "ui5-tooling-transpile": "*" // ... -}, -"ui5": { - "dependencies": [ - // ... - "ui5-tooling-transpile", - // ... - ] } ``` -> :warning: 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. -> -> :speech_balloon: For UI5 Tooling 3.0 the `ui5 > dependencies` section in the `package.json` isn't necessary anymore and can be removed. - Register the task and middleware in your `$yourapp/ui5.yaml`: ```yaml diff --git a/packages/ui5-tooling-transpile/package.json b/packages/ui5-tooling-transpile/package.json index 46c576ee4..e5e014771 100644 --- a/packages/ui5-tooling-transpile/package.json +++ b/packages/ui5-tooling-transpile/package.json @@ -1,6 +1,6 @@ { "name": "ui5-tooling-transpile", - "version": "3.0.0-pre.1", + "version": "2.0.0", "description": "UI5 tooling extensions to transpile code", "author": "Jorge Martins, Peter Muessig", "license": "Apache-2.0",