https://github.com/stockbal/ui5-middleware-global-variables

custom ui5 server middleware for global variables
https://github.com/stockbal/ui5-middleware-global-variables

ui5-tooling

Last synced: 5 days ago
JSON representation

custom ui5 server middleware for global variables

• Host: GitHub
• URL: https://github.com/stockbal/ui5-middleware-global-variables
• Owner: stockbal
• License: apache-2.0
• Created: 2020-07-17T12:57:23.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-17T13:19:51.000Z (over 4 years ago)
• Last Synced: 2024-04-25T08:02:41.169Z (7 months ago)
• Topics: ui5-tooling
• Language: JavaScript
• Homepage:
• Size: 10.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm version](https://badge.fury.io/js/ui5-middleware-global-variables.svg)](https://badge.fury.io/js/ui5-middleware-global-variables)

# UI5 global variables middleware

Middleware for [ui5-server](https://github.com/SAP/ui5-server), for accessing globally injected variables.

## Install

```bash

npm install ui5-middleware-global-variables --save-dev

```

## Configuration options (in `$yourapp/ui5.yaml`)

- rootPath: `string`

  the root path to the static resources on your system

## Usage

1. Define the dependency in `$yourapp/package.json`:

```json

"devDependencies": {

    // ...

    "ui5-middleware-global-variables": "*"

    // ...

},

"ui5": {

  "dependencies": [

    // ...

    "ui5-middleware-global-variables",

    // ...

  ]

}

```

> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.

2. configure it in `$yourapp/ui5.yaml`:  

```yaml

server:

  customMiddleware:

  - name: ui5-middleware-global-variables

    afterMiddleware: compression

    configuration:

      debug: true

```

## How it works

You insert the following `script`-tag at the end of the `head`-tag of the `*.html` file you use for your dev server.

```html

```

The middleware will then inject the source code into the script which will convert all `.env` Variables that start with **`UI5_GLOBAL_VAR__`** into a global object called `$ui5GlobalVariables`.  

This object has only one method called `get` which expects the id of a global variable (defined in `.env`)

## License

This work is [licensed](../../LICENSE) under Apache 2.0.