@ui5/logger 3.0.1-rc.3 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.reuse/dep5 CHANGED
@@ -25,5 +25,5 @@ Disclaimer: The code in this project may include calls to APIs (“API Calls”)
25
25
  parties the right to use of access any SAP External Product, through API Calls.
26
26
 
27
27
  Files: *
28
- Copyright: 2018-2023 SAP SE or an SAP affiliate company and UI5 Tooling contributors
28
+ Copyright: 2018-2024 SAP SE or an SAP affiliate company and UI5 CLI contributors
29
29
  License: Apache-2.0
package/CHANGELOG.md CHANGED
@@ -2,10 +2,16 @@
2
2
  All notable changes to this project will be documented in this file.
3
3
  This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
4
4
 
5
- A list of unreleased changes can be found [here](https://github.com/SAP/ui5-logger/compare/v3.0.1-rc.3...HEAD).
5
+ A list of unreleased changes can be found [here](https://github.com/SAP/ui5-logger/compare/v3.0.1...HEAD).
6
+
7
+ <a name="v3.0.1"></a>
8
+ ## [v3.0.1] - 2025-09-12
9
+ ### Bug Fixes
10
+ - Rename project to UI5 CLI [`4b1181a`](https://github.com/SAP/ui5-logger/commit/4b1181a00bc115c4bd1db54806ab53d37977b45b)
11
+
6
12
 
7
13
  <a name="v3.0.1-rc.3"></a>
8
- ## [v3.0.1-rc.3] - 2023-02-02
14
+ ## [v3.0.1-rc.3] - 2023-02-03
9
15
 
10
16
  <a name="v3.0.1-rc.2"></a>
11
17
  ## [v3.0.1-rc.2] - 2023-01-24
@@ -74,20 +80,26 @@ Only Node.js v16.13.2 and npm v8 or higher are supported.
74
80
  <a name="v3.0.1-alpha.0"></a>
75
81
  ## [v3.0.1-alpha.0] - 2021-12-14
76
82
 
77
- <a name="v3.0.0-next.0"></a>
78
- ## [v3.0.0-next.0] - 2021-11-29
79
-
80
- <a name="v3.0.0-beta.1"></a>
81
- ## [v3.0.0-beta.1] - 2022-11-07
83
+ <a name="v3.0.0"></a>
84
+ ## [v3.0.0] - 2023-02-09
82
85
  ### Breaking Changes
86
+ - Replace npmlog with [@ui5](https://github.com/ui5)/logger/Logger ([#363](https://github.com/SAP/ui5-logger/issues/363)) [`66a159a`](https://github.com/SAP/ui5-logger/commit/66a159acd9b67a27dd66d1e8056c362585f51bcf)
87
+ - Deprecate advanced APIs in preparation of refactoring [`3aea5e7`](https://github.com/SAP/ui5-logger/commit/3aea5e766f9bda156e8c7e62a2e8c65f613ef7e9)
83
88
  - Transform to native ESM ([#306](https://github.com/SAP/ui5-logger/issues/306)) [`c79608b`](https://github.com/SAP/ui5-logger/commit/c79608b0e432168ca8570530b63a456b9ddd12cb)
84
89
  - Require Node.js >= 16.13.2 / npm >= 8 [`a8af8a7`](https://github.com/SAP/ui5-logger/commit/a8af8a7a82c6f657ac10b5018e654939d90fd81f)
85
90
 
91
+ ### Dependency Updates
92
+ - Bump npmlog from 5.0.1 to 7.0.1 ([#321](https://github.com/SAP/ui5-logger/issues/321)) [`6c5c154`](https://github.com/SAP/ui5-logger/commit/6c5c154c53d8f81774d588714e8426922fa85271)
93
+
86
94
  ### Features
87
95
  - Add new log level "perf" [`acf0c71`](https://github.com/SAP/ui5-logger/commit/acf0c717612f440ea7a114e757c05d358ae523a7)
88
96
 
89
97
  ### BREAKING CHANGE
90
98
 
99
+
100
+
101
+
102
+
91
103
  This package has been transformed to native ESM. Therefore it no longer provides a CommonJS export.
92
104
  If your project uses CommonJS, it needs to be converted to ESM or use a dynamic import.
93
105
 
@@ -98,16 +110,58 @@ For more information see also:
98
110
  Support for older Node.js and npm releases has been dropped.
99
111
  Only Node.js v16.13.2 and npm v8 or higher are supported.
100
112
 
113
+ ### Breaking Changes
114
+
115
+ - Replace npmlog with @ui5/logger/Logger (#363) [`66a159a`](https://github.com/SAP/ui5-logger/commit/66a159acd9b67a27dd66d1e8056c362585f51bcf)
116
+ - Deprecate advanced APIs in preparation of refactoring [`3aea5e7`](https://github.com/SAP/ui5-logger/commit/3aea5e766f9bda156e8c7e62a2e8c65f613ef7e9)
117
+ - Transform to ES Modules ([#306](https://github.com/SAP/ui5-logger/issues/306)) [`c79608b`](https://github.com/SAP/ui5-logger/commit/c79608b0e432168ca8570530b63a456b9ddd12cb)
118
+ - Require Node.js ^16.18.0, >=18.12.0 / npm >= 8 [`a8af8a7`](https://github.com/SAP/ui5-logger/commit/a8af8a7a82c6f657ac10b5018e654939d90fd81f)
119
+
120
+ ### BREAKING CHANGE
121
+
122
+ The @ui5/logger got refactored and as a result its API went public.
123
+
124
+ 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.
125
+
126
+ This breaking change removes capabilities that are likely to change and should not be part of a public API.
127
+
128
+ This will ensure that later changes to the module can be donen in a
129
+ compatible manner.
130
+
131
+ Relevant changes:
132
+
133
+ - Restrict log-methods to two argument only. The use of placeholders
134
+ like '%s' is no longer supported. A warning will be logged if more
135
+ than two argument is supplied. Placeholders will be replaced with a
136
+ deprecation message. We suggest the use of template literals.
137
+ - Deprecate #getGroupLogger method. Calling it throws an error.
138
+ It will be removed in one of the next patch releases
139
+ - Deprecate #setShowProgress method. Calling it throws an error.
140
+ It will be removed in one of the next patch releases
141
+ - Remove GroupLogger and TaskLogger classes. Similar functionality might
142
+ be re-added in a later release.
143
+
144
+ This package has been transformed to ES Modules. Therefore it no longer provides a CommonJS export.
145
+ If your project uses CommonJS, it needs to be converted to ES Modules or use a dynamic import.
146
+
147
+ For more information see also:
148
+
149
+ - https://sap.github.io/ui5-tooling/updates/migrate-v3/
150
+ - https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
151
+
152
+ Support for older Node.js and npm releases has been dropped.
153
+ Only Node.js versions v16.18.0, v18.12.0 or higher as well as npm v8 or higher are supported.
154
+
155
+ ### Features
156
+
157
+ - Add new log level "perf" [`acf0c71`](https://github.com/SAP/ui5-logger/commit/acf0c717612f440ea7a114e757c05d358ae523a7)
101
158
 
102
- <a name="v3.0.0-alpha.0"></a>
103
- ## [v3.0.0-alpha.0] - 2021-12-14
104
159
 
105
160
  <a name="v2.0.1"></a>
106
161
  ## [v2.0.1] - 2020-10-22
107
162
  ### Bug Fixes
108
163
  - Typos in error messages [`1d25902`](https://github.com/SAP/ui5-logger/commit/1d2590223c4332f5ea6f1326b23ecf584fea5934)
109
164
 
110
-
111
165
  <a name="v2.0.0"></a>
112
166
  ## [v2.0.0] - 2020-03-31
113
167
  ### Breaking Changes
@@ -118,13 +172,11 @@ Only Node.js v16.13.2 and npm v8 or higher are supported.
118
172
  Support for older Node.js releases has been dropped.
119
173
  Only Node.js v10 or higher is supported.
120
174
 
121
-
122
175
  <a name="v1.0.2"></a>
123
176
  ## [v1.0.2] - 2019-10-14
124
177
  ### Bug Fixes
125
178
  - Fix handling of log level "silent" [`020ced8`](https://github.com/SAP/ui5-logger/commit/020ced85a82d33c94e429aa28983affa0d8341ba)
126
179
 
127
-
128
180
  <a name="v1.0.1"></a>
129
181
  ## [v1.0.1] - 2019-03-21
130
182
 
@@ -136,7 +188,6 @@ Only Node.js v10 or higher is supported.
136
188
  ### Features
137
189
  - Add UI5_LOG_LVL environment variable [`c3e65c4`](https://github.com/SAP/ui5-logger/commit/c3e65c444045832773e4dc43ffa2baf903a27e52)
138
190
 
139
-
140
191
  <a name="v0.2.1"></a>
141
192
  ## [v0.2.1] - 2018-10-29
142
193
 
@@ -148,7 +199,7 @@ Only Node.js v10 or higher is supported.
148
199
 
149
200
  <a name="v0.0.1"></a>
150
201
  ## v0.0.1 - 2018-06-06
151
-
202
+ [v3.0.1]: https://github.com/SAP/ui5-logger/compare/v3.0.1-rc.3...v3.0.1
152
203
  [v3.0.1-rc.3]: https://github.com/SAP/ui5-logger/compare/v3.0.1-rc.2...v3.0.1-rc.3
153
204
  [v3.0.1-rc.2]: https://github.com/SAP/ui5-logger/compare/v3.0.1-rc.1...v3.0.1-rc.2
154
205
  [v3.0.1-rc.1]: https://github.com/SAP/ui5-logger/compare/v3.0.1-rc.0...v3.0.1-rc.1
@@ -158,10 +209,8 @@ Only Node.js v10 or higher is supported.
158
209
  [v3.0.1-alpha.3]: https://github.com/SAP/ui5-logger/compare/v3.0.1-alpha.2...v3.0.1-alpha.3
159
210
  [v3.0.1-alpha.2]: https://github.com/SAP/ui5-logger/compare/v3.0.1-alpha.1...v3.0.1-alpha.2
160
211
  [v3.0.1-alpha.1]: https://github.com/SAP/ui5-logger/compare/v3.0.1-alpha.0...v3.0.1-alpha.1
161
- [v3.0.1-alpha.0]: https://github.com/SAP/ui5-logger/compare/v3.0.0-next.0...v3.0.1-alpha.0
162
- [v3.0.0-next.0]: https://github.com/SAP/ui5-logger/compare/v3.0.0-beta.1...v3.0.0-next.0
163
- [v3.0.0-beta.1]: https://github.com/SAP/ui5-logger/compare/v3.0.0-alpha.0...v3.0.0-beta.1
164
- [v3.0.0-alpha.0]: https://github.com/SAP/ui5-logger/compare/v2.0.1...v3.0.0-alpha.0
212
+ [v3.0.1-alpha.0]: https://github.com/SAP/ui5-logger/compare/v3.0.0...v3.0.1-alpha.0
213
+ [v3.0.0]: https://github.com/SAP/ui5-logger/compare/v2.0.1...v3.0.0
165
214
  [v2.0.1]: https://github.com/SAP/ui5-logger/compare/v2.0.0...v2.0.1
166
215
  [v2.0.0]: https://github.com/SAP/ui5-logger/compare/v1.0.2...v2.0.0
167
216
  [v1.0.2]: https://github.com/SAP/ui5-logger/compare/v1.0.1...v1.0.2
package/CONTRIBUTING.md CHANGED
@@ -1,3 +1,3 @@
1
- # Contributing to the UI5 Tooling
1
+ # Contributing to the UI5 CLI
2
2
 
3
- See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md) repository.
3
+ See CONTRIBUTING.md in the [UI5/cli](https://github.com/UI5/cli/blob/v3/CONTRIBUTING.md) repository.
package/LICENSE.txt CHANGED
@@ -186,7 +186,7 @@
186
186
  same "printed page" as the copyright notice for easier
187
187
  identification within third-party archives.
188
188
 
189
- Copyright 2018-2023 SAP SE or an SAP affiliate company and UI5 Tooling contributors
189
+ Copyright 2018-2024 SAP SE or an SAP affiliate company and UI5 CLI contributors
190
190
 
191
191
  Licensed under the Apache License, Version 2.0 (the "License");
192
192
  you may not use this file except in compliance with the License.
package/README.md CHANGED
@@ -1,27 +1,27 @@
1
- ![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/main/docs/images/UI5_logo_wide.png)
1
+ ![UI5 icon](https://raw.githubusercontent.com/UI5/cli/v3/docs/images/UI5_logo_wide.png)
2
2
 
3
3
  # ui5-logger
4
- > Providing logging functionality for all UI5 Tooling modules and extensions.
4
+ > Providing logging functionality for all UI5 CLI modules and extensions.
5
5
  > Features log levels and rendering of a progress bar.
6
- > Part of [UI5 Tooling](https://github.com/SAP/ui5-tooling)
6
+ > Part of [UI5 CLI](https://github.com/UI5/cli)
7
7
 
8
8
  [![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-logger)](https://api.reuse.software/info/github.com/SAP/ui5-logger)
9
- [![Build Status](https://dev.azure.com/sap/opensource/_apis/build/status/SAP.ui5-logger?branchName=main)](https://dev.azure.com/sap/opensource/_build/latest?definitionId=37&branchName=main)
9
+ [![Build Status](https://dev.azure.com/sap/opensource/_apis/build/status/SAP.ui5-logger?branchName=v3)](https://dev.azure.com/sap/opensource/_build/latest?definitionId=37&branchName=v3)
10
10
  [![npm Package Version](https://badge.fury.io/js/%40ui5%2Flogger.svg)](https://www.npmjs.com/package/@ui5/logger)
11
11
  [![Coverage Status](https://coveralls.io/repos/github/SAP/ui5-logger/badge.svg)](https://coveralls.io/github/SAP/ui5-logger)
12
12
 
13
13
  ## Documentation
14
- General UI5 Tooling documentation can be found here: [sap.github.io/ui5-tooling](https://sap.github.io/ui5-tooling/)
14
+ General UI5 CLI documentation can be found here: [ui5.github.io/cli](https://ui5.github.io/cli/)
15
15
 
16
- The UI5 Logger API Reference can be found here: [`@ui5/logger`](https://sap.github.io/ui5-tooling/v3/api/module-@ui5_logger.html)
16
+ The UI5 Logger API Reference can be found here: [`@ui5/logger`](https://ui5.github.io/cli/v3/api/module-@ui5_logger.html)
17
17
 
18
18
  ## Contributing
19
- Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md).
19
+ Please check our [Contribution Guidelines](https://github.com/UI5/cli/blob/v3/CONTRIBUTING.md).
20
20
 
21
21
  ## Support
22
- Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md#report-an-issue) on how to report an issue.
22
+ Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/v3/CONTRIBUTING.md#report-an-issue) on how to report an issue.
23
23
 
24
- Please report issues in the main [UI5 Tooling](https://github.com/SAP/ui5-tooling) repository.
24
+ Please report issues in the main [UI5 CLI](https://github.com/UI5/cli) repository.
25
25
 
26
26
  ## Release History
27
27
  See [CHANGELOG.md](CHANGELOG.md).
package/jsdoc.json CHANGED
@@ -25,11 +25,11 @@
25
25
  }
26
26
  },
27
27
  "openGraph": {
28
- "title": "UI5 Tooling - API Reference",
28
+ "title": "UI5 CLI - API Reference",
29
29
  "type": "website",
30
- "image": "https://sap.github.io/ui5-tooling/v3/images/UI5_logo_wide.png",
31
- "site_name": "UI5 Tooling - API Reference",
32
- "url": "https://sap.github.io/ui5-tooling/"
30
+ "image": "https://ui5.github.io/cli/v3/images/UI5_logo_wide.png",
31
+ "site_name": "UI5 CLI - API Reference",
32
+ "url": "https://ui5.github.io/cli/"
33
33
  },
34
34
  "docdash": {
35
35
  "sectionOrder": [
@@ -43,8 +43,8 @@
43
43
  "Interfaces"
44
44
  ],
45
45
  "meta": {
46
- "title": "UI5 Tooling - API Reference - UI5 Logger",
47
- "description": "UI5 Tooling - API Reference - UI5 Logger",
46
+ "title": "UI5 CLI - API Reference - UI5 Logger",
47
+ "description": "UI5 CLI - API Reference - UI5 Logger",
48
48
  "keyword": "openui5 sapui5 ui5 build development tool api reference"
49
49
  },
50
50
  "search": true,
package/lib/index.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import Logger from "./loggers/Logger.js";
2
2
 
3
3
  /**
4
- * Interface for the UI5 Tooling logging module
4
+ * Interface for the UI5 CLI logging module
5
5
  *
6
6
  * @public
7
7
  * @module @ui5/logger
@@ -1,7 +1,7 @@
1
1
  import Logger from "./Logger.js";
2
2
 
3
3
  /**
4
- * Logger for emitting status events on the progress a UI5 Tooling build process.
4
+ * Logger for emitting status events on the progress a UI5 CLI build process.
5
5
  * <br><br>
6
6
  * Emits <code>ui5.log</code>, <code>ui5.build-metadata</code> and <code>ui5.build-status</code> events on the
7
7
  * [<code>process</code>]{@link https://nodejs.org/api/process.html} object, which can which can be handled
@@ -5,7 +5,7 @@ import {inspect} from "node:util";
5
5
  const rIllegalModuleNameChars = /[^0-9a-zA-Z-_:@./]/i;
6
6
 
7
7
  /**
8
- * Standard logging module for UI5 Tooling and extensions.
8
+ * Standard logging module for UI5 CLI and extensions.
9
9
  * <br><br>
10
10
  * Emits <code>ui5.log</code> events on the [<code>process</code>]{@link https://nodejs.org/api/process.html} object,
11
11
  * which can be handled by dedicated writers,
@@ -7,7 +7,7 @@ import Logger from "../loggers/Logger.js";
7
7
  /**
8
8
  * Standard handler for events emitted by @ui5/logger modules. Writes messages to
9
9
  * [<code>process.stderr</code>]{@link https://nodejs.org/api/process.html#processstderr} stream
10
- * and renders a progress bar for UI5 Tooling build processes.
10
+ * and renders a progress bar for UI5 CLI build processes.
11
11
  * <br><br>
12
12
  * The progress bar is only used in interactive terminals. If verbose logging is enabled, the progress
13
13
  * bar is disabled.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@ui5/logger",
3
- "version": "3.0.1-rc.3",
4
- "description": "UI5 Tooling - Internal Logger",
3
+ "version": "3.0.1",
4
+ "description": "UI5 CLI - Internal Logger",
5
5
  "author": {
6
6
  "name": "SAP SE",
7
7
  "email": "openui5@sap.com",
@@ -43,8 +43,8 @@
43
43
  "jsdoc-generate": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./lib/ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
44
44
  "jsdoc-watch": "npm run jsdoc && chokidar \"./lib/**/*.js\" -c \"npm run jsdoc-generate\"",
45
45
  "preversion": "npm test",
46
- "version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md && git add CHANGELOG.md",
47
- "postversion": "git push --follow-tags",
46
+ "version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md v3.0.0.. && git add CHANGELOG.md",
47
+ "prepublishOnly": "git push --follow-tags",
48
48
  "release-note": "git-chglog --sort semver -c .chglog/release-config.yml v$npm_package_version",
49
49
  "depcheck": "depcheck --ignores @ui5/logger,rimraf,docdash,@istanbuljs/esm-loader-hook"
50
50
  },
@@ -62,7 +62,8 @@
62
62
  ],
63
63
  "nodeArguments": [
64
64
  "--no-warnings"
65
- ]
65
+ ],
66
+ "workerThreads": false
66
67
  },
67
68
  "nyc": {
68
69
  "reporter": [
@@ -109,27 +110,27 @@
109
110
  "url": "git@github.com:SAP/ui5-logger.git"
110
111
  },
111
112
  "dependencies": {
112
- "chalk": "^5.2.0",
113
- "cli-progress": "^3.11.2",
113
+ "chalk": "^5.6.0",
114
+ "cli-progress": "^3.12.0",
114
115
  "figures": "^5.0.0"
115
116
  },
116
117
  "devDependencies": {
117
118
  "@istanbuljs/esm-loader-hook": "^0.2.0",
118
- "ava": "^5.1.1",
119
+ "ava": "^5.3.1",
119
120
  "chokidar-cli": "^3.0.0",
120
121
  "cross-env": "^7.0.3",
121
- "depcheck": "^1.4.3",
122
- "docdash": "^2.0.1",
123
- "eslint": "^8.33.0",
122
+ "depcheck": "^1.4.7",
123
+ "docdash": "^2.0.2",
124
+ "eslint": "^8.57.1",
124
125
  "eslint-config-google": "^0.14.0",
125
126
  "eslint-plugin-ava": "^14.0.0",
126
- "eslint-plugin-jsdoc": "^39.7.4",
127
- "jsdoc": "^3.6.11",
127
+ "eslint-plugin-jsdoc": "^46.10.1",
128
+ "jsdoc": "^4.0.4",
128
129
  "nyc": "^15.1.0",
129
- "open-cli": "^7.1.0",
130
- "rimraf": "^4.1.2",
131
- "sinon": "^15.0.1",
132
- "strip-ansi": "^7.0.1",
130
+ "open-cli": "^7.2.0",
131
+ "rimraf": "^5.0.10",
132
+ "sinon": "^16.1.3",
133
+ "strip-ansi": "^7.1.0",
133
134
  "tap-xunit": "^2.4.1"
134
135
  }
135
136
  }