# @sap-ux/ui5-config

> Library to UI5 configuration artifacts

Latest version **1.0.9** (published 2026-08-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @sap-ux/ui5-config
pnpm add @sap-ux/ui5-config
yarn add @sap-ux/ui5-config
bun add @sap-ux/ui5-config
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.9 |
| Published | 2026-08-25 |
| First published | 2021-10-21 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 158 |
| Maintainers | tqueck, kranthie.sap, sap_extncrepos, sap-ospo-admin, devinea |

## Links

- npm: https://www.npmjs.com/package/@sap-ux/ui5-config
- Repository: https://github.com/SAP/open-ux-tools
- Issues: https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aui5-config
- npm.io page: https://npm.io/package/@sap-ux/ui5-config

## Recent versions

- 1.0.9 (latest) — 2026-08-25
- 1.0.8 — 2026-08-25
- 1.0.7 — 2026-08-05
- 1.0.6 — 2026-07-28
- 1.0.5 — 2026-07-03
- 1.0.4 — 2026-07-03
- 1.0.3 — 2026-06-10
- 1.0.2 — 2026-06-04
- 1.0.1 — 2026-06-03
- 1.0.0 — 2026-05-30
- 0.31.1 — 2026-05-21
- 0.31.0 — 2026-05-15
- 0.30.4 — 2026-05-06
- 0.30.3 — 2026-04-14
- 0.30.2 — 2026-04-08
- … 105 more at https://npm.io/package/@sap-ux/ui5-config/versions

## README

[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/ui5-config/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/ui5-config)

# [`@sap-ux/ui5-config`](https://github.com/SAP/open-ux-tools/tree/main/packages/ui5-config)
Utility module to create and update [UI5 tooling configuration](https://sap.github.io/ui5-tooling/pages/Configuration/) files (`ui5*.yaml`) with helper methods specifically for Fiori tools middlewares.

## Installation
Npm
`npm install --save @sap-ux/ui5-config`

Yarn
`yarn add @sap-ux/ui5-config`

Pnpm
`pnpm add @sap-ux/ui5-config`

## Usage

Create a new config file
```javascript
// generate an empty instance
const ui5Config = await UI5Config.newInstance('');

// set the UI5 framework with a specific version
ui5Config.addUI5Framework('SAPUI5', '1.64.0', []);

// create the file
fs.write('./ui5.yaml', ui5Config.toString());
```

Add a middleware to an existing file
```javascript
// load a config from the filesytem
const ui5Config = await UI5Config.newInstance(fs.read('./ui5.yaml'));

// add a middlewre
ui5Config.addFioriToolsAppReloadMiddleware();

// write the changes back to the filestystem
fs.write('./ui5.yaml', ui5Config.toString());
```

See more example in [`/test/index.test.ts`](./test/index.test.ts)

## Keywords
SAP Fiori freestyle

---
_Source: https://npm.io/package/@sap-ux/ui5-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._