diff --git a/README.md b/README.md index 8239e901b..6f64491c5 100644 --- a/README.md +++ b/README.md @@ -73,13 +73,12 @@ id: testsuite version: "" path: "./" dependencies: -- id: sap.f - version: "" - path: "../sap.f" - -- id: sap.m - version: "" - path: "../sap.m" + - id: sap.f + version: "" + path: "../sap.f" + - id: sap.m + version: "" + path: "../sap.m" ```` This can be used via `ui5 serve -b static:/path/to/projectDependencies.yaml` diff --git a/docs/BuildExtensibility.md b/docs/BuildExtensibility.md index f9f1f9789..8574fb6f3 100644 --- a/docs/BuildExtensibility.md +++ b/docs/BuildExtensibility.md @@ -21,12 +21,12 @@ metadata: name: my.library builder: customTasks: - - name: babel - beforeTask: generateComponentPreload - - name: generateMarkdownFiles - afterTask: uglify - configuration: - color: blue + - name: babel + beforeTask: generateComponentPreload + - name: generateMarkdownFiles + afterTask: uglify + configuration: + color: blue ```` ### Example: Connect multiple custom tasks @@ -42,10 +42,10 @@ metadata: name: my.library builder: customTasks: - - name: myCustomTask1 - beforeTask: generateComponentPreload - - name: myCustomTask2 - afterTask: myCustomTask1 + - name: myCustomTask1 + beforeTask: generateComponentPreload + - name: myCustomTask2 + afterTask: myCustomTask1 ```` ## Custom Task Extension @@ -83,10 +83,10 @@ metadata: name: my.library builder: customTasks: - - name: generateMarkdownFiles - afterTask: uglify - configuration: - color: blue + - name: generateMarkdownFiles + afterTask: uglify + configuration: + color: blue --- # Task extension as part of your project specVersion: "1.0" diff --git a/docs/Configuration.md b/docs/Configuration.md index 47295d418..7ea181443 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -6,8 +6,8 @@ The content represents the **[Specification Version](#specification-versions) `1 ## Contents - [Project Configuration](#project-configuration) - [Extension Configuration](#extension-configuration) - + [Tasks](#tasks) - + [Project Shims](#project-shims) + + [Tasks](#tasks) + + [Project Shims](#project-shims) - [Specification Versions](#specification-versions) ## Project Configuration @@ -33,15 +33,15 @@ Configuration can also be supplied by other means. In cases where JSON is used, specVersion: "1.0" type: application|library|module metadata: - name: testsuite + name: some.project.name copyright: |- * (c) Copyright 2009-${currentYear} resources: configuration: paths: - "": "" - "": "" + "": "" + "": "" builder: customTasks: - name: custom-task-name-1 @@ -52,6 +52,9 @@ builder: afterTask: custom-task-name-1 configuration: color: blue + jsdoc: + excludes: + - some/project/name/thirdparty/** server: settings: port: 8099 @@ -70,21 +73,23 @@ Some general information: #### resources (optional) - `configuration` - `paths`: Mapping between virtual paths and physical paths. Physical paths are always relative to the projects root directory - + `webapp: webapp`: This path will be mapped to the virtual path `/`. - *(Only available for projects of type `application`)* - + `src: src`: This path will be mapped to the virtual path `/resources`. - *(Only available for projects of type `library`)* - + `test: test`: This path will be mapped to the virtual path `/test-resources`. - *(Only available for projects of type `library`)* + + `webapp: webapp`: This path will be mapped to the virtual path `/`. + *(Only available for projects of type `application`)* + + `src: src`: This path will be mapped to the virtual path `/resources`. + *(Only available for projects of type `library`)* + + `test: test`: This path will be mapped to the virtual path `/test-resources`. + *(Only available for projects of type `library`)* + `: ` (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`). #### 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 + - `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 +- `jsdoc` + - `excludes`: List of glob patterns. Matching resources will be ignored from the JSDoc build #### server (optional) - `settings` (not yet implemented) @@ -111,31 +116,30 @@ specVersion: "1.0" kind: extension type: project-shim metadata: - name: + name: shims: - configurations: - : - specVersion: "1.0", - type: - metadata: - name: - : - specVersion: "1.0", - type: - metadata: - name: - dependencies: - : - - - - - - - - ... - collections: - : - modules: - : - : - : + configurations: + : + specVersion: "1.0", + type: + metadata: + name: + : + specVersion: "1.0", + type: + metadata: + name: + dependencies: + : + - + - + - + collections: + : + modules: + : + : + : ``` "module name" refers to the name of the module as identified by the used translator. E.g. when using the npm translator, the name declared in the modules `package.json` is used here. In most cases, the module name also becomes the internal ID of the project. @@ -248,41 +252,41 @@ The shim defined in the application configures the legacy libraries and defines specVersion: "1.0" type: application metadata: - name: application.a + name: application.a ---- specVersion: "1.0" kind: extension type: project-shim metadata: - name: legacy-lib-shims + name: legacy-lib-shims shims: - configurations: - legacy-library-a: - specVersion: "1.0" - type: library - metadata: - name: legacy.library.a - legacy-library-b: - specVersion: "1.0" - type: library - metadata: - name: legacy.library.b - legacy-library-x: - specVersion: "1.0" - type: library - metadata: - name: legacy.library.x - dependencies: - legacy-library-a: - - legacy-library-b - - legacy-library-x - legacy-library-b: - - legacy-library-x - collections: - legacy-libs: - modules: - legacy-library-a: src/library.a - legacy-library-b: src/library.b + configurations: + legacy-library-a: + specVersion: "1.0" + type: library + metadata: + name: legacy.library.a + legacy-library-b: + specVersion: "1.0" + type: library + metadata: + name: legacy.library.b + legacy-library-x: + specVersion: "1.0" + type: library + metadata: + name: legacy.library.x + dependencies: + legacy-library-a: + - legacy-library-b + - legacy-library-x + legacy-library-b: + - legacy-library-x + collections: + legacy-libs: + modules: + legacy-library-a: src/library.a + legacy-library-b: src/library.b ``` ## Specification Versions