From 74a8f986ff41c3969448ad14fddd40037cb95009 Mon Sep 17 00:00:00 2001 From: Matthias Osswald Date: Fri, 25 Mar 2022 14:23:37 +0100 Subject: [PATCH 1/6] [INTERNAL] Add preliminary guide for v3 migration --- docs/updates/migrate-v3.md | 71 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 docs/updates/migrate-v3.md diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md new file mode 100644 index 0000000000..a3db182208 --- /dev/null +++ b/docs/updates/migrate-v3.md @@ -0,0 +1,71 @@ +# Migrate to v3 + +TBD: Add notice about current development state of v3 and how to install it. + +## Breaking changes + +**All UI5 Tooling Modules: Require Node.js >= 16.13.2 / npm >= 8** + +Support for older Node.js and npm releases has been dropped. +Only Node.js v16.13.2 and npm v8 or higher are supported. + +**Removal of tasks and processors** + +The following tasks have been removed: + +- createDebugFiles +- uglify + +The following processors have been removed: + +- debugFileCreator +- resourceCopier +- uglifier + +As a replacement, the new 'minify' task and 'minifier' processor can be +used. + +Note: The minify task is executed earlier, before the bundling +process takes place. Existing 'beforeTask' and 'afterTask' configuration of +custom tasks might need to be adapted to cater for this change. + +Updated list of standard tasks: + +| Task | Type `application` | Type `library` | Type `theme-library` | +| ---- | :----: | :----: | :----: | +| escapeNonAsciiCharacters | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | | +| replaceCopyright | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | +| replaceVersion | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | +| replaceBuildtime | | {: .sap-icon-circle-task-2 } | | +| generateJsdoc | | {: .sap-icon-circle-task }^1^ | | +| executeJsdocSdkTransformation | | {: .sap-icon-circle-task }^1^ | | +| generateFlexChangesBundle | | {: .sap-icon-circle-task-2 } | | +| generateManifestBundle | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | | +| **ADDED:** minify | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | | +| generateLibraryManifest | | {: .sap-icon-circle-task-2 } | | +| generateLibraryPreload | | {: .sap-icon-circle-task-2 } | | +| generateComponentPreload | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task }^2^ | | +| generateStandaloneAppBundle | {: .sap-icon-circle-task }^3^ | | | +| transformBootstrapHtml | {: .sap-icon-circle-task }^3^ | | | +| generateBundle | {: .sap-icon-circle-task }^4^ | {: .sap-icon-circle-task }^4^ | | +| buildThemes | | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | +| generateThemeDesignerResources | | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | +| **REMOVED:** ~~createDebugFiles~~ | | | | +| **REMOVED:** ~~uglify~~ | | | | +| generateVersionInfo | {: .sap-icon-circle-task-2 } | | | +| generateCachebusterInfo | {: .sap-icon-circle-task } | | | +| generateApiIndex | {: .sap-icon-circle-task }^1^ | | | +| generateResourcesJson | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | + +*Enabled by default* +{: .sap-icon-circle-task-2-before } + +*Disabled by default. Can be activated by certain build modes, project configuration or by using the `--include-task` [CLI parameter](../pages/CLI.md#ui5-build). See footnotes where given* +{: .sap-icon-circle-task-before } + +--- + +^1^ Enabled in `jsdoc` build, which disables most of the other tasks +^2^ Enabled for projects defining a [component preload configuration](../pages/Configuration.md#component-preload-generation) +^3^ Enabled in `self-contained` build, which disables `generateComponentPreload` and `generateLibraryPreload` +^4^ Enabled for projects defining a [bundle configuration](../pages/Configuration.md#custom-bundling) From 7276773dc5ca94c04623ff5feda683aa4373f87c Mon Sep 17 00:00:00 2001 From: Matthias Osswald Date: Tue, 29 Mar 2022 10:58:56 +0200 Subject: [PATCH 2/6] Add Source Maps section in Builder page --- docs/pages/Builder.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/pages/Builder.md b/docs/pages/Builder.md index 2b403505ce..664c9eb15b 100644 --- a/docs/pages/Builder.md +++ b/docs/pages/Builder.md @@ -96,5 +96,12 @@ Since string replacement is a common build step, it can be useful in different c Available processors are listed [in the API reference](https://sap.github.io/ui5-tooling/api/module-@ui5_builder.processors.html). +## Source Map support + +Source Maps will be supported by the upcoming v3.0.0 version which is currently in development. +Files will be generated automatically for all bundles. + +See [Migrate to v3](../updates/migrate-v3.md) for further details. + ## Legacy Bundle Tooling (lbt) JavaScript port of the "legacy" Maven/Java based bundle tooling. From 5619c60b753723616a11e34a41691cde82da7406 Mon Sep 17 00:00:00 2001 From: Matthias Osswald Date: Tue, 29 Mar 2022 10:59:11 +0200 Subject: [PATCH 3/6] Add info about v3 development and how to install --- docs/updates/migrate-v3.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md index a3db182208..3ae35f7d5a 100644 --- a/docs/updates/migrate-v3.md +++ b/docs/updates/migrate-v3.md @@ -1,6 +1,8 @@ # Migrate to v3 -TBD: Add notice about current development state of v3 and how to install it. +!!! warning + UI5 Tooling v3 is currently in development. Further breaking changes are expected. + The latest development version can be installed via `npm i -D @ui5/cli@next` ## Breaking changes From 568c732a176055d0c060db9370baa33409064b70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20O=C3=9Fwald?= <1410947+matz3@users.noreply.github.com> Date: Mon, 4 Apr 2022 14:52:27 +0200 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: KlattG <57760635+KlattG@users.noreply.github.com> --- docs/updates/migrate-v3.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md index 3ae35f7d5a..a288704fee 100644 --- a/docs/updates/migrate-v3.md +++ b/docs/updates/migrate-v3.md @@ -6,7 +6,7 @@ ## Breaking changes -**All UI5 Tooling Modules: Require Node.js >= 16.13.2 / npm >= 8** +**All UI5 Tooling Modules Require Node.js >= 16.13.2 / npm >= 8** Support for older Node.js and npm releases has been dropped. Only Node.js v16.13.2 and npm v8 or higher are supported. @@ -28,7 +28,7 @@ As a replacement, the new 'minify' task and 'minifier' processor can be used. Note: The minify task is executed earlier, before the bundling -process takes place. Existing 'beforeTask' and 'afterTask' configuration of +process takes place. Any existing 'beforeTask' or 'afterTask' configuration of custom tasks might need to be adapted to cater for this change. Updated list of standard tasks: @@ -62,7 +62,7 @@ Updated list of standard tasks: *Enabled by default* {: .sap-icon-circle-task-2-before } -*Disabled by default. Can be activated by certain build modes, project configuration or by using the `--include-task` [CLI parameter](../pages/CLI.md#ui5-build). See footnotes where given* +*Disabled by default. Can be activated by certain build modes, the project configuration, or by using the `--include-task` [CLI parameter](../pages/CLI.md#ui5-build). See footnotes where given* {: .sap-icon-circle-task-before } --- From aa8b33c7099d8fcc743dfe0ce7875441b119c4f5 Mon Sep 17 00:00:00 2001 From: Matthias Osswald Date: Mon, 4 Apr 2022 14:53:52 +0200 Subject: [PATCH 5/6] Apply same suggestion to Builder.md --- docs/pages/Builder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Builder.md b/docs/pages/Builder.md index 664c9eb15b..280e10de6f 100644 --- a/docs/pages/Builder.md +++ b/docs/pages/Builder.md @@ -78,7 +78,7 @@ All available standard tasks are documented [in the API reference](https://sap.g *Enabled by default* {: .sap-icon-circle-task-2-before } -*Disabled by default. Can be activated by certain build modes, project configuration or by using the `--include-task` [CLI parameter](./CLI.md#ui5-build). See footnotes where given* +*Disabled by default. Can be activated by certain build modes, the project configuration, or by using the `--include-task` [CLI parameter](../pages/CLI.md#ui5-build). See footnotes where given* {: .sap-icon-circle-task-before } --- From 7eb2369a748d620654838af7d159f2d347e92225 Mon Sep 17 00:00:00 2001 From: Matthias Osswald Date: Wed, 6 Apr 2022 08:52:10 +0200 Subject: [PATCH 6/6] Add link to Source Maps PR --- docs/pages/Builder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Builder.md b/docs/pages/Builder.md index 280e10de6f..75e181316e 100644 --- a/docs/pages/Builder.md +++ b/docs/pages/Builder.md @@ -101,7 +101,7 @@ Available processors are listed [in the API reference](https://sap.github.io/ui5 Source Maps will be supported by the upcoming v3.0.0 version which is currently in development. Files will be generated automatically for all bundles. -See [Migrate to v3](../updates/migrate-v3.md) for further details. +See [Migrate to v3](../updates/migrate-v3.md) and [SAP/ui5-builder#695](https://github.com/SAP/ui5-builder/pull/695) for further details. ## Legacy Bundle Tooling (lbt) JavaScript port of the "legacy" Maven/Java based bundle tooling.