UI5 Project¶

The UI5 Project module provides functionality to build a UI5 project's dependency tree, including the validated project configurations. It is also responsible for installing and managing framework dependencies. Also see Development Overview: Project Dependencies.

API Reference

Normalizer¶

The purpose of the normalizer is to collect dependency information and to enrich it with project configuration (both done in generateProjectTree).

Translators are used to collect dependency information. The Project Preprocessor enriches this dependency information with project configuration, typically from a ui5.yaml file. A development server and build process can use this information to locate project and dependency resources.

If you want to retrieve the project dependency graph without any configuration, you may use use the generateDependencyTree API.

Translators¶

Translators collect recursively all dependencies on a package manager specific layer and return information about them in a well-defined tree structure.

Tree structure as returned by a Translator:

{
    "id": "projectA",
    "version": "1.0.0",
    "path": "/absolute/path/to/projectA",
    "dependencies": [
        {
            "id": "projectB",
            "version": "1.0.0",
            "path": "/path/to/projectB",
            "dependencies": [
                {
                    "id": "projectD",
                    "path": "/path/to/different/projectD"
                }
            ]
        },
        {
            "id": "projectD",
            "version": "1.0.0",
            "path": "/path/to/projectD"
        },
        {
            "id": "myStaticServerTool",
            "version": "1.0.0",
            "path": "/path/to/some/dependency"
        }
    ]
}

This dependency tree can be used as input for the Project Preprocessor:

npm Translator¶

The npm translator is currently the default translator and looks for dependencies defined in the package.json file of a certain project. dependencies, devDepedencies, and napa dependencies (Git repositories which don't have a package.json file) are located via the Node.js module resolution logic.

Static Translator¶

This translator is currently intended for testing purposes only.

Can be used to supply the full dependency information of a project in a single structured file.

Example: projectDependencies.yaml

---
id: testsuite
version: ""
path: "./"
dependencies:
  - id: sap.f
    version: ""
    path: "../sap.f"
  - id: sap.m
    version: ""
    path: "../sap.m"

This can be used via ui5 serve --translator static:/path/to/projectDependencies.yaml

Project Preprocessor¶

Enhances a given dependency tree based on a projects configuration.

Enhanced dependency tree structure as returned by the Project Preprocessor:

{
    "id": "projectA",
    "version": "1.0.0",
    "path": "/absolute/path/to/projectA",
    "specVersion": "2.6",
    "type": "application",
    "metadata": {
        "name": "sap.projectA",
        "copyright": "Some copyright ${currentYear}"
    },
    "resources": {
        "configuration": {
            "paths": {
                "webapp": "app"
            }
        },
        "pathMappings": {
             "/": "app"
        }
    },
    "dependencies": [
        {
            "id": "projectB",
            "version": "1.0.0",
            "path": "/path/to/projectB",
            "specVersion": "2.6",
            "type": "library",
            "metadata": {
                "name": "sap.ui.projectB"
            },
            "resources": {
                "configuration": {
                    "paths": {
                        "src": "src",
                        "test": "test"
                    }
                },
                "pathMappings": {
                    "/resources/": "src",
                    "/test-resources/": "test"
                }
            },
            "dependencies": [
                {
                    "id": "projectD",
                    "version": "1.0.0",
                    "path": "/path/to/different/projectD",
                    "specVersion": "2.6",
                    "type": "library",
                    "metadata": {
                        "name": "sap.ui.projectD"
                    },
                    "resources": {
                        "configuration": {
                            "paths": {
                                "src": "src/main/uilib",
                                "test": "src/test"
                            }
                        },
                        "pathMappings": {
                            "/resources/": "src/main/uilib",
                            "/test-resources/": "src/test"
                        }
                    },
                    "dependencies": []
                }
            ]
        },
        {
            "id": "projectD",
            "version": "1.0.0",
            "path": "/path/to/projectD",
            "specVersion": "2.6",
            "type": "library",
            "metadata": {
                "name": "sap.ui.projectD"
            },
            "resources": {
                "configuration": {
                    "paths": {
                        "src": "src/main/uilib",
                        "test": "src/test"
                    }
                },
                "pathMappings": {
                    "/resources/": "src/main/uilib",
                    "/test-resources/": "src/test"
                }
            },
            "dependencies": []
        }
    ]
}