From 72c430160e29267921848fd5ebefd1a45a2542e9 Mon Sep 17 00:00:00 2001 From: Merlin Beutlberger Date: Wed, 13 Mar 2019 11:12:03 +0100 Subject: [PATCH 1/4] [INTERNAL] Configuration docs: Add various resource excludes --- docs/Configuration.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/Configuration.md b/docs/Configuration.md index 397ea18a4..74b99ae62 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -42,6 +42,8 @@ resources: paths: "": "" "": "" + excludes: + - /test-resources/some/project/name/screenshots/** builder: customTasks: - name: custom-task-name-1 @@ -52,6 +54,9 @@ builder: afterTask: custom-task-name-1 configuration: color: blue + resources: + excludes: + - /resources/some/project/name/test_results/** jsdoc: excludes: - some/project/name/thirdparty/** @@ -82,12 +87,15 @@ Some general information: + `: ` (default `/: ./`): Any virtual path mapping can be defined here. *(Only available for projects of type `module`)* It is recommended that modules include their namespace in the virtual path and use the `/resources` prefix (e.g. `/resources/my/first/library/module-xy`). +- `excludes`: List of glob patterns. Matching resources will be ignored by the UI5 Tooling (builder, server, etc.) #### builder (optional) - `customTasks` (optional, list): In this block, you define additional custom build tasks, see [here](./BuildExtensibility.md) for a detailed explanation and examples of the build extensibility. Each entry in the `customTasks` list consists of the following options: - `name` (mandatory): The name of the custom task - `afterTask` or `beforeTask` (only one, mandatory): The name of the build task after or before which your custom task will be executed. - `configuration` (optional): Additional configuration that is passed to the custom build task +- `resources`: + - `excludes`: List of glob patterns. Matching resources will be ignored by the builder - `jsdoc` - `excludes`: List of glob patterns. Matching resources will be ignored from the JSDoc build From 793a796234c51995357afd6d4dd09c865ee7955b Mon Sep 17 00:00:00 2001 From: Merlin Beutlberger Date: Tue, 28 May 2019 18:34:10 +0200 Subject: [PATCH 2/4] Remove general exclude configuration and refine documentation --- docs/Configuration.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index 74b99ae62..1d536a7c8 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -42,8 +42,6 @@ resources: paths: "": "" "": "" - excludes: - - /test-resources/some/project/name/screenshots/** builder: customTasks: - name: custom-task-name-1 @@ -87,17 +85,18 @@ Some general information: + `: ` (default `/: ./`): Any virtual path mapping can be defined here. *(Only available for projects of type `module`)* It is recommended that modules include their namespace in the virtual path and use the `/resources` prefix (e.g. `/resources/my/first/library/module-xy`). -- `excludes`: List of glob patterns. Matching resources will be ignored by the UI5 Tooling (builder, server, etc.) #### builder (optional) +- `resources`: General resource configuration + - `excludes`: List of glob patterns. Matching resources will be ignored by the builder (i.e. all tasks). + Patterns are applied to the **virtual** path of resources (i.e. the UI5 runtime paths). +- `jsdoc`: Configuration specific to the JSDoc build task + - `excludes`: List of glob patterns. Matching resources will be ignored by the JSDoc build task. + Patterns are always applied relative to the projects virtual **source** directory `/resources/` - `customTasks` (optional, list): In this block, you define additional custom build tasks, see [here](./BuildExtensibility.md) for a detailed explanation and examples of the build extensibility. Each entry in the `customTasks` list consists of the following options: - `name` (mandatory): The name of the custom task - `afterTask` or `beforeTask` (only one, mandatory): The name of the build task after or before which your custom task will be executed. - `configuration` (optional): Additional configuration that is passed to the custom build task -- `resources`: - - `excludes`: List of glob patterns. Matching resources will be ignored by the builder -- `jsdoc` - - `excludes`: List of glob patterns. Matching resources will be ignored from the JSDoc build #### server (optional) - `settings` (not yet implemented) From 3e318dba6696774ce7b345022dfbcfdf8f890d94 Mon Sep 17 00:00:00 2001 From: Merlin Beutlberger Date: Wed, 29 May 2019 16:32:45 +0200 Subject: [PATCH 3/4] Clarify how glob patterns are applied --- docs/Configuration.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index 1d536a7c8..c281b2a7c 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -55,6 +55,8 @@ builder: resources: excludes: - /resources/some/project/name/test_results/** + - /test-resources/** + - !/test-resources/some/project/name/demo-app/** jsdoc: excludes: - some/project/name/thirdparty/** @@ -87,12 +89,13 @@ Some general information: It is recommended that modules include their namespace in the virtual path and use the `/resources` prefix (e.g. `/resources/my/first/library/module-xy`). #### builder (optional) -- `resources`: General resource configuration - - `excludes`: List of glob patterns. Matching resources will be ignored by the builder (i.e. all tasks). - Patterns are applied to the **virtual** path of resources (i.e. the UI5 runtime paths). +- `resources`: General resource configuration for this project + - `excludes`: List of glob patterns. Matching resources of this project will be ignored by the builder (i.e. all tasks). + Patterns are applied to the **virtual** path of resources (i.e. the UI5 runtime paths). Exclude patterns are always applied after any includes. - `jsdoc`: Configuration specific to the JSDoc build task - `excludes`: List of glob patterns. Matching resources will be ignored by the JSDoc build task. - Patterns are always applied relative to the projects virtual **source** directory `/resources/` + Patterns are always applied relative to the projects virtual **source** directory `/resources/`. + Any general builder excludes (as defined in `builder.resources.excludes`) are applied *after* these excludes. - `customTasks` (optional, list): In this block, you define additional custom build tasks, see [here](./BuildExtensibility.md) for a detailed explanation and examples of the build extensibility. Each entry in the `customTasks` list consists of the following options: - `name` (mandatory): The name of the custom task - `afterTask` or `beforeTask` (only one, mandatory): The name of the build task after or before which your custom task will be executed. From bae953ec9159d1ee579ab68ced014fb1b87ff6cf Mon Sep 17 00:00:00 2001 From: Merlin Beutlberger Date: Tue, 4 Jun 2019 16:59:54 +0200 Subject: [PATCH 4/4] Put globs into strings --- docs/Configuration.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index c281b2a7c..b1a95f8a3 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -54,12 +54,12 @@ builder: color: blue resources: excludes: - - /resources/some/project/name/test_results/** - - /test-resources/** - - !/test-resources/some/project/name/demo-app/** + - "/resources/some/project/name/test_results/**" + - "/test-resources/**" + - "!/test-resources/some/project/name/demo-app/**" jsdoc: excludes: - - some/project/name/thirdparty/** + - "some/project/name/thirdparty/**" server: settings: port: 8099