From 61f4dcb291fa54886ce0b694ae2846ad73820a40 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Fri, 1 Dec 2023 15:13:22 +0200 Subject: [PATCH 1/6] specVersion 3.2 docs --- docs/pages/Configuration.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index 2c5a7b4f02..1849bf3260 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -695,7 +695,7 @@ A list of bundle definitions. A `bundleDefinition` contains of the following opt - `name`: The module bundle name - `defaultFileTypes`: List of default file types which should be included in the bundle. Defaults to: `.js`, `.control.xml`, `.fragment.html`, `.fragment.json`, `.fragment.xml`, `.view.html`, `.view.json` and `.view.xml` - `sections`: A list of module bundle definition sections. Each section specifies an embedding technology (see [API-Reference](https://sap.github.io/ui5-tooling/v3/api/module-@ui5_builder_processors_bundlers_moduleBundler.html#~ModuleBundleDefinition)) and lists the resources that should be in- or excluded from the section. - - `mode`: The embedding technology (e.g. provided, raw, preload) + - `mode`: The embedding technology (e.g. provided, raw, preload, depCache) - `filters`: List of modules declared as glob patterns (resource name patterns) that are in- or excluded. Similarly to the use of a single `*` or double `**` asterisk, a pattern ending with a slash `/` denotes an arbitrary number of characters or folder names. Excludes have to be marked with a leading exclamation mark `!`. The order of filters is relevant; a later inclusion overrides an earlier exclusion, and vice versa. - `resolve`: Setting resolve to `true` will also include all (transitive) dependencies of the files - `resolveConditional`: Whether conditional dependencies of modules should be resolved and added to the module set for this section. By default set to `false` @@ -737,6 +737,7 @@ Unless otherwise noted in the table below, UI5 Tooling modules are backward comp Version | UI5 CLI Release --- | --- +**3.2** | v3.8.0+ **3.1** | v3.5.0+ **3.0** | v3.0.0+ **2.6** | v2.14.0+ @@ -750,6 +751,12 @@ Version | UI5 CLI Release **1.0** | v1.0.0+ **0.1** | v0.0.1+ +### Specification Version 3.2 + +**Features:** + +- Adds a new bundling mode in sections for providing a dependencies cache: [`builder.bundles.bundleDefinition.sections.mode=depCache`](#properties) configuration for projects of type `module` + ### Specification Version 3.1 **Features:** From 4d36bb6d7c6a9ae607c6b65ada0cf68ea6f3b660 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 5 Dec 2023 14:15:39 +0200 Subject: [PATCH 2/6] Update docs/pages/Configuration.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthias Oßwald --- docs/pages/Configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index 1849bf3260..afa693e97b 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -695,7 +695,7 @@ A list of bundle definitions. A `bundleDefinition` contains of the following opt - `name`: The module bundle name - `defaultFileTypes`: List of default file types which should be included in the bundle. Defaults to: `.js`, `.control.xml`, `.fragment.html`, `.fragment.json`, `.fragment.xml`, `.view.html`, `.view.json` and `.view.xml` - `sections`: A list of module bundle definition sections. Each section specifies an embedding technology (see [API-Reference](https://sap.github.io/ui5-tooling/v3/api/module-@ui5_builder_processors_bundlers_moduleBundler.html#~ModuleBundleDefinition)) and lists the resources that should be in- or excluded from the section. - - `mode`: The embedding technology (e.g. provided, raw, preload, depCache) + - `mode`: The embedding technology (e.g. provided, raw, preload, bundleInfo, depCache) - `filters`: List of modules declared as glob patterns (resource name patterns) that are in- or excluded. Similarly to the use of a single `*` or double `**` asterisk, a pattern ending with a slash `/` denotes an arbitrary number of characters or folder names. Excludes have to be marked with a leading exclamation mark `!`. The order of filters is relevant; a later inclusion overrides an earlier exclusion, and vice versa. - `resolve`: Setting resolve to `true` will also include all (transitive) dependencies of the files - `resolveConditional`: Whether conditional dependencies of modules should be resolved and added to the module set for this section. By default set to `false` From a252a3f8e2a840d71c2ee3eee4c0564686229e4c Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 5 Dec 2023 14:15:52 +0200 Subject: [PATCH 3/6] Update docs/pages/Configuration.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthias Oßwald --- docs/pages/Configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index afa693e97b..ca523aa9b4 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -755,7 +755,7 @@ Version | UI5 CLI Release **Features:** -- Adds a new bundling mode in sections for providing a dependencies cache: [`builder.bundles.bundleDefinition.sections.mode=depCache`](#properties) configuration for projects of type `module` +- Adds a new bundling mode `depCache` for providing a dependencies cache: [`builder.bundles.bundleDefinition.sections.mode=depCache`](#properties) ### Specification Version 3.1 From 779230db705e702fa86049f6c8d49702a57eea4f Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Wed, 6 Dec 2023 10:03:04 +0200 Subject: [PATCH 4/6] Add footer notes for specVersion 3.x --- docs/pages/Configuration.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index ca523aa9b4..610c7e53eb 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -757,12 +757,16 @@ Version | UI5 CLI Release - Adds a new bundling mode `depCache` for providing a dependencies cache: [`builder.bundles.bundleDefinition.sections.mode=depCache`](#properties) +Specification Version 3.0 projects are supported by [UI5 CLI](https://github.com/SAP/ui5-cli) v3.0.0 and above. + ### Specification Version 3.1 **Features:** - Adds support for maintaining the [`builder.resources.excludes`](#exclude-resources) configuration for projects of type `module` +Specification Version 3.0 projects are supported by [UI5 CLI](https://github.com/SAP/ui5-cli) v3.0.0 and above. + ### Specification Version 3.0 **Breaking changes:** From 8fe687814d5bd209eb99a4a1d010790b637c476b Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Wed, 6 Dec 2023 13:04:23 +0200 Subject: [PATCH 5/6] Adjust specVersion to UI5 Tooling mappings --- docs/pages/Configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index 610c7e53eb..524634c7e5 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -757,7 +757,7 @@ Version | UI5 CLI Release - Adds a new bundling mode `depCache` for providing a dependencies cache: [`builder.bundles.bundleDefinition.sections.mode=depCache`](#properties) -Specification Version 3.0 projects are supported by [UI5 CLI](https://github.com/SAP/ui5-cli) v3.0.0 and above. +Specification Version 3.2 projects are supported by [UI5 CLI](https://github.com/SAP/ui5-cli) v3.8.0 and above. ### Specification Version 3.1 @@ -765,7 +765,7 @@ Specification Version 3.0 projects are supported by [UI5 CLI](https://github.com - Adds support for maintaining the [`builder.resources.excludes`](#exclude-resources) configuration for projects of type `module` -Specification Version 3.0 projects are supported by [UI5 CLI](https://github.com/SAP/ui5-cli) v3.0.0 and above. +Specification Version 3.1 projects are supported by [UI5 CLI](https://github.com/SAP/ui5-cli) v3.5.0 and above. ### Specification Version 3.0 From db1eec1d6f860b425bbd8d89088dc7d875eb6a69 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 12 Dec 2023 13:19:47 +0200 Subject: [PATCH 6/6] Update inline code examples to use specVersion: "3.2" --- docs/index.md | 2 +- docs/pages/Configuration.md | 22 +++++++++---------- docs/pages/OpenUI5.md | 4 ++-- docs/pages/SAPUI5.md | 4 ++-- .../extensibility/CustomServerMiddleware.md | 8 +++---- docs/pages/extensibility/CustomTasks.md | 10 ++++----- docs/pages/extensibility/ProjectShims.md | 22 +++++++++---------- 7 files changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/index.md b/docs/index.md index ccf7e33cf6..9d9091a67b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,7 +29,7 @@ Configure your project for use with UI5 Tooling. ❯ ui5 init Wrote ui5.yaml: -specVersion: "3.1" +specVersion: "3.2" metadata: name: my-app type: application diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index 524634c7e5..c6fc04fbb4 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -16,7 +16,7 @@ See the list of [clients](https://github.com/redhat-developer/yaml-language-serv ## Example ```yaml -specVersion: "3.1" +specVersion: "3.2" type: application|library|theme-library|module metadata: name: some.project.name @@ -36,28 +36,28 @@ The type defines the default path mappings and build tasks. See [UI5 Builder: Ty === "application" ```yaml - specVersion: "3.1" + specVersion: "3.2" type: application ``` === "library" ```yaml - specVersion: "3.1" + specVersion: "3.2" type: library ``` === "theme-library" ```yaml - specVersion: "3.1" + specVersion: "3.2" type: theme-library ``` === "module" ```yaml - specVersion: "3.1" + specVersion: "3.2" type: module ``` @@ -270,7 +270,7 @@ You can find an overview of the available versions for each framework here: !!! example === "application" ```yaml - specVersion: "3.1" + specVersion: "3.2" type: application metadata: name: my.company.app @@ -286,7 +286,7 @@ You can find an overview of the available versions for each framework here: === "library" ```yaml - specVersion: "3.1" + specVersion: "3.2" type: library metadata: name: my.company.library @@ -618,12 +618,12 @@ The default and configured server ports can always be overwritten with the CLI p !!! example ```yaml - specVersion: "3.1" + specVersion: "3.2" type: application metadata: name: my.application --- - specVersion: "3.1" + specVersion: "3.2" kind: extension type: project-shim metadata: @@ -631,7 +631,7 @@ The default and configured server ports can always be overwritten with the CLI p shims: configurations: lodash: - specVersion: "3.1" + specVersion: "3.2" type: module metadata: name: lodash @@ -718,7 +718,7 @@ A list of bundle definitions. A `bundleDefinition` contains of the following opt A project must define a specification version by setting the `specVersion` property. UI5 Tooling uses this information to detect whether the currently installed version is compatible to a project's configuration. ```yaml -specVersion: "3.1" +specVersion: "3.2" [...] ``` diff --git a/docs/pages/OpenUI5.md b/docs/pages/OpenUI5.md index fb1f0c847a..bfaad71b45 100644 --- a/docs/pages/OpenUI5.md +++ b/docs/pages/OpenUI5.md @@ -23,7 +23,7 @@ This configuration can be maintained by editing the file, or by using the UI5 CL **Example ui5.yaml of an application** ```yaml -specVersion: "3.1" +specVersion: "3.2" type: application metadata: name: some.project.name @@ -39,7 +39,7 @@ framework: **Example ui5.yaml of a library** ```yaml -specVersion: "3.1" +specVersion: "3.2" type: library metadata: name: some.library diff --git a/docs/pages/SAPUI5.md b/docs/pages/SAPUI5.md index 8dec6a2923..87a06768b0 100644 --- a/docs/pages/SAPUI5.md +++ b/docs/pages/SAPUI5.md @@ -34,7 +34,7 @@ This configuration can be maintained by editing the file, or by using the UI5 CL **Example ui5.yaml of an application** ```yaml -specVersion: "3.1" +specVersion: "3.2" type: application metadata: name: some.project.name @@ -52,7 +52,7 @@ framework: **Example ui5.yaml of a library** ```yaml -specVersion: "3.1" +specVersion: "3.2" type: library metadata: name: some.library diff --git a/docs/pages/extensibility/CustomServerMiddleware.md b/docs/pages/extensibility/CustomServerMiddleware.md index 53b7f13c8b..1968cd2dc1 100644 --- a/docs/pages/extensibility/CustomServerMiddleware.md +++ b/docs/pages/extensibility/CustomServerMiddleware.md @@ -15,7 +15,7 @@ A middleware may be executed before or after any other middleware. This can eith ### Example: Basic configuration ```yaml -specVersion: "3.1" +specVersion: "3.2" type: application metadata: name: my.application @@ -45,7 +45,7 @@ A custom middleware extension consists of a `ui5.yaml` and a [custom middleware ### Example: ui5.yaml ```yaml -specVersion: "3.1" +specVersion: "3.2" kind: extension type: server-middleware metadata: @@ -65,7 +65,7 @@ The UI5 Server will detect the custom middleware configuration of the project an ```yaml # Project configuration for the above example -specVersion: "3.1" +specVersion: "3.2" kind: project type: application metadata: @@ -76,7 +76,7 @@ server: beforeMiddleware: serveResources --- # Custom middleware extension as part of your project -specVersion: "3.1" +specVersion: "3.2" kind: extension type: server-middleware metadata: diff --git a/docs/pages/extensibility/CustomTasks.md b/docs/pages/extensibility/CustomTasks.md index 5957e8720a..4d8dc7a235 100644 --- a/docs/pages/extensibility/CustomTasks.md +++ b/docs/pages/extensibility/CustomTasks.md @@ -20,7 +20,7 @@ Another custom task called `render-markdown-files` is then executed immediately ```yaml # In this example configuration, two custom tasks are defined: 'babel' and 'render-markdown-files'. -specVersion: "3.1" +specVersion: "3.2" type: library metadata: name: my.library @@ -41,7 +41,7 @@ You can also connect multiple custom tasks with each other. The order in the con ```yaml # In this example, 'my-custom-task-2' gets executed after 'my-custom-task-1'. -specVersion: "3.1" +specVersion: "3.2" type: library metadata: name: my.library @@ -60,7 +60,7 @@ A custom task extension consists of a `ui5.yaml` and a [task implementation](#ta ### Example: ui5.yaml ```yaml -specVersion: "3.1" +specVersion: "3.2" kind: extension type: task metadata: @@ -80,7 +80,7 @@ The task extension will then be automatically collected and processed during the ```yaml # Project configuration for the above example -specVersion: "3.1" +specVersion: "3.2" kind: project type: library metadata: @@ -94,7 +94,7 @@ builder: firstH1IsTitle: true --- # Task extension as part of your project -specVersion: "3.1" +specVersion: "3.2" kind: extension type: task metadata: diff --git a/docs/pages/extensibility/ProjectShims.md b/docs/pages/extensibility/ProjectShims.md index 26ec702a2f..80a04fac7a 100644 --- a/docs/pages/extensibility/ProjectShims.md +++ b/docs/pages/extensibility/ProjectShims.md @@ -5,7 +5,7 @@ Also see [RFC 0002 Project Shims](https://github.com/SAP/ui5-tooling/blob/main/r #### Structure ```yaml -specVersion: "3.1" +specVersion: "3.2" kind: extension type: project-shim metadata: @@ -13,12 +13,12 @@ metadata: shims: configurations: : - specVersion: "3.1" + specVersion: "3.2" type: metadata: name: : - specVersion: "3.1" + specVersion: "3.2" type: metadata: name: @@ -61,12 +61,12 @@ An application "my-application" defines a npm dependency to [lodash](https://lod **ui5.yaml** ```yaml -specVersion: "3.1" +specVersion: "3.2" type: application metadata: name: my.application --- # Everything below this line could also be put into the ui5.yaml of a standalone extension module -specVersion: "3.1" +specVersion: "3.2" kind: extension type: project-shim metadata: @@ -74,7 +74,7 @@ metadata: shims: configurations: lodash: # name as defined in package.json - specVersion: "3.1" + specVersion: "3.2" type: module # Use module type metadata: name: lodash @@ -142,12 +142,12 @@ application-a/ The shim defined in the application configures the legacy libraries and defines their dependencies. This shim might as well be a standalone module that is added to the applications dependencies. That would be the typical reuse scenario for shims. ```yaml -specVersion: "3.1" +specVersion: "3.2" type: application metadata: name: application.a ---- -specVersion: "3.1" +specVersion: "3.2" kind: extension type: project-shim metadata: @@ -155,17 +155,17 @@ metadata: shims: configurations: legacy-library-a: - specVersion: "3.1" + specVersion: "3.2" type: library metadata: name: legacy.library.a legacy-library-b: - specVersion: "3.1" + specVersion: "3.2" type: library metadata: name: legacy.library.b legacy-library-x: - specVersion: "3.1" + specVersion: "3.2" type: library metadata: name: legacy.library.x