ui5-logger

Providing logging functionality for all UI5 Tooling modules and extensions.
Features log levels and rendering of a progress bar.
Part of UI5 Tooling

Documentation

General UI5 Tooling documentation can be found here: sap.github.io/ui5-tooling

The UI5 Logger API Reference can be found here: @ui5/logger

Contributing

Please check our Contribution Guidelines.

Support

Please follow our Contribution Guidelines on how to report an issue.

Please report issues in the main UI5 Tooling repository.

Release History

See CHANGELOG.md.

Changelog

All notable changes to this project will be documented in this file.
This project adheres to Semantic Versioning.

A list of unreleased changes can be found here.

v4.0.1 - 2024-07-17

v4.0.0 - 2024-07-16

Breaking Changes

• Require Node.js 20.11.x/>=21.2.0 and npm >=10 37620d7

Dependency Updates

• Bump figures from 5.0.0 to 6.0.1 550a3cd

BREAKING CHANGE

Support for older Node.js and npm releases has been dropped. Only Node.js 20.11.x and >=21.2.0 as well as npm v10 or higher are supported.

v3.0.0 - 2023-02-09

Breaking Changes

• Replace npmlog with @ui5/logger/Logger (#363) 66a159a
• Deprecate advanced APIs in preparation of refactoring 3aea5e7
• Transform to ES Modules (#306) c79608b
• Require Node.js ^16.18.0, >=18.12.0 / npm >= 8 a8af8a7

BREAKING CHANGE

The @ui5/logger got refactored and as a result its API went public.

Remove the usage of npmlog and refactor @ui5/logger modules to emit log events which are then caught in dedicated handlers. This is somewhat inspired by npm's proc-log module.

This breaking change removes capabilities that are likely to change and should not be part of a public API.

This will ensure that later changes to the module can be donen in a compatible manner.

Relevant changes:

• Restrict log-methods to two argument only. The use of placeholders like '%s' is no longer supported. A warning will be logged if more than two argument is supplied. Placeholders will be replaced with a deprecation message. We suggest the use of template literals.
• Deprecate #getGroupLogger method. Calling it throws an error. It will be removed in one of the next patch releases
• Deprecate #setShowProgress method. Calling it throws an error. It will be removed in one of the next patch releases
• Remove GroupLogger and TaskLogger classes. Similar functionality might be re-added in a later release.

This package has been transformed to ES Modules. Therefore it no longer provides a CommonJS export. If your project uses CommonJS, it needs to be converted to ES Modules or use a dynamic import.

For more information see also:

• https://sap.github.io/ui5-tooling/updates/migrate-v3/
• https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

Support for older Node.js and npm releases has been dropped. Only Node.js versions v16.18.0, v18.12.0 or higher as well as npm v8 or higher are supported.

Features

• Add new log level "perf" acf0c71

v2.0.1 - 2020-10-22

Bug Fixes

• Typos in error messages 1d25902

v2.0.0 - 2020-03-31

Breaking Changes

• Require Node.js >= 10 1825d10

BREAKING CHANGE

Support for older Node.js releases has been dropped. Only Node.js v10 or higher is supported.

v1.0.2 - 2019-10-14

Bug Fixes

• Fix handling of log level "silent" 020ced8

v1.0.1 - 2019-03-21

v1.0.0 - 2019-01-09

v0.2.2 - 2018-11-16

Features

• Add UI5_LOG_LVL environment variable c3e65c4

v0.2.1 - 2018-10-29

v0.2.0 - 2018-07-11

v0.1.0 - 2018-06-26

v0.0.1 - 2018-06-06