You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Contributing to the UI5 Tooling
1
+
# Contributing to the UI5 CLI
2
2
## Content
3
3
1.[📝 **Reporting Issues**](#-reporting-issues)
4
4
2.[🤩 **Feature Requests**](#-feature-requests)
@@ -11,12 +11,12 @@
11
11
12
12
## 📝 Reporting Issues
13
13
### Seeking Help / Not a Bug
14
-
If you need help setting something up, or if you have questions regarding UI5 Tooling, please seek help on a community platform like the [SAP Community](https://answers.sap.com/topics/ui5-tooling.html), [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).
14
+
If you need help setting something up, or if you have questions regarding UI5 CLI, please seek help on a community platform like the [SAP Community](https://answers.sap.com/topics/ui5-tooling.html), [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).
15
15
16
16
### How to Report an Issue
17
-
Note that we collect issues for all UI5 Tooling modules (*[ui5-cli](https://github.com/SAP/ui5-cli), [ui5-server](https://github.com/SAP/ui5-server), [ui5-project](https://github.com/SAP/ui5-project), [ui5-builder](https://github.com/SAP/ui5-builder), [ui5-fs](https://github.com/SAP/ui5-fs) and [ui5-logger](https://github.com/SAP/ui5-logger)*) in the central [ui5-tooling](https://github.com/SAP/ui5-tooling) repository.
17
+
Note that we collect issues for all UI5 CLI modules (*[ui5-cli](https://github.com/SAP/ui5-cli), [ui5-server](https://github.com/SAP/ui5-server), [ui5-project](https://github.com/SAP/ui5-project), [ui5-builder](https://github.com/SAP/ui5-builder), [ui5-fs](https://github.com/SAP/ui5-fs) and [ui5-logger](https://github.com/SAP/ui5-logger)*) in the central [ui5-tooling](https://github.com/SAP/ui5-tooling) repository.
18
18
19
-
1.**Only UI5 Tooling issues**
19
+
1.**Only UI5 CLI issues**
20
20
* Please do not report:
21
21
* Issues caused by dependencies or plugins.
22
22
* Issues caused by the use of non-public/internal methods. Only the public methods listed in the API documentation may be used.
@@ -67,14 +67,14 @@ GitHub offers labels to categorize issues. The labels can only be set and modifi
67
67
***`wontfix`**: While acknowledged to be an issue, a fix cannot or will not be provided.
68
68
69
69
### Issue Reporting Disclaimer
70
-
We want to improve the quality of the UI5 Tooling and good bug reports are welcome! But our capacity is limited, so we cannot handle questions or consultation requests, and we cannot afford to ask for required details.
70
+
We want to improve the quality of the UI5 CLI and good bug reports are welcome! But our capacity is limited, so we cannot handle questions or consultation requests, and we cannot afford to ask for required details.
71
71
72
-
Therefore, we reserve the right to close or to not process insufficient bug reports in favor of those which are clearly documented and easy to reproduce. Even though we would like to solve each well-documented issue, there is always the chance that it won't happen - please remember: The UI5 Tooling is Open Source and comes without warranty.
72
+
Therefore, we reserve the right to close or to not process insufficient bug reports in favor of those which are clearly documented and easy to reproduce. Even though we would like to solve each well-documented issue, there is always the chance that it won't happen - please remember: The UI5 CLI is Open Source and comes without warranty.
73
73
74
74
Bug report analysis support is always very welcome! See [Analyze Issues](#-analyzing-issues).
75
75
76
76
## 🤩 Feature Requests
77
-
You can request most features by creating an issue in the UI5 Tooling repository: https://github.com/SAP/ui5-tooling/issues/new
77
+
You can request most features by creating an issue in the UI5 CLI repository: https://github.com/SAP/ui5-tooling/issues/new
78
78
79
79
For bigger features an RFC (Request for Comment) might be necessary. You should always clarify the need for an RFC with the project contributors upfront. You could do this either by opening an issue or in our [Slack channel](#seeking-help--not-a-bug). You can use [this template](rfcs/0000-template.md) for creating an RFC.
80
80
@@ -88,13 +88,13 @@ You may be able to add additional or missing information, such as a step-by-step
88
88
89
89
## 💻 Contributing Code
90
90
### General Remarks
91
-
You are welcome to contribute code to the UI5 Tooling in order to fix bugs or to implement new features.
91
+
You are welcome to contribute code to the UI5 CLI in order to fix bugs or to implement new features.
92
92
93
93
There are three important things to know:
94
94
95
95
1. You must be aware of the Apache License (which describes contributions) and **agree to the Developer Certificate of Origin***. This is common practice in major Open Source projects. To make this process as simple as possible, we are using *[CLA assistant](https://cla-assistant.io/)* for individual contributions. CLA assistant is an open source tool that integrates with GitHub very well and enables a one-click experience for accepting the DCO. For company contributers, special rules apply. See the respective section below for details.
96
96
2. Follow our **[Development Conventions and Guidelines](docs/Guidelines.md)**.
97
-
3.**Not all proposed contributions can be accepted**. Some features may just fit a third-party add-on better. The code must match the overall direction of the UI5 Tooling and improve it. So there should be some "bang for the byte". For most bug fixes this is a given, but a major feature implementation first needs to be discussed with one of the committers. Possibly, one who touched the related code or module recently. The more effort you invest, the better you should clarify in advance whether the contribution will match the project's direction. The best way would be to just open an enhancement ticket in the issue tracker to discuss the feature you plan to implement (make it clear that you intend to contribute). We will then forward the proposal to the respective code owner. This avoids disappointment.
97
+
3.**Not all proposed contributions can be accepted**. Some features may just fit a third-party add-on better. The code must match the overall direction of the UI5 CLI and improve it. So there should be some "bang for the byte". For most bug fixes this is a given, but a major feature implementation first needs to be discussed with one of the committers. Possibly, one who touched the related code or module recently. The more effort you invest, the better you should clarify in advance whether the contribution will match the project's direction. The best way would be to just open an enhancement ticket in the issue tracker to discuss the feature you plan to implement (make it clear that you intend to contribute). We will then forward the proposal to the respective code owner. This avoids disappointment.
98
98
99
99
### Developer Certificate of Origin (DCO)
100
100
@@ -105,7 +105,7 @@ This DCO replaces the previously used CLA ("Contributor License Agreement") as w
105
105
106
106
### How to Contribute
107
107
1. Make sure the change is welcome (see [General Remarks](#general-remarks)).
108
-
- Also check on the [UI5 Tooling Task Board](https://github.com/orgs/SAP/projects/1) whether related tasks are already being worked on, blocked, or in discussion.
108
+
- Also check on the [UI5 CLI Task Board](https://github.com/orgs/SAP/projects/1) whether related tasks are already being worked on, blocked, or in discussion.
109
109
1. Create a branch by forking the relevant module repository and apply your change.
110
110
1. Commit and push your change on that branch.
111
111
- 👉 **Please follow our [Development Conventions and Guidelines](docs/Guidelines.md).**
Copy file name to clipboardExpand all lines: README.md
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1

2
2
3
-
# UI5 Tooling
3
+
# UI5 CLI
4
4
5
5
> An open and modular toolchain to develop state-of-the-art applications based on the [UI5](https://ui5.sap.com) framework.
6
6
@@ -10,19 +10,21 @@
10
10
11
11
## Deprecation
12
12
13
-
> [UI5 Tooling v3](https://sap.github.io/ui5-tooling/v3) is the latest and stable version 🎉
13
+
> [UI5 CLI v4](https://sap.github.io/ui5-tooling/v4) is the latest and stable version 🎉
14
14
>
15
-
> [UI5 Tooling v2](https://sap.github.io/ui5-tooling/v2) has been deprecated 🚫
15
+
> [UI5 CLI v3](https://sap.github.io/ui5-tooling/v3) is a stable version and in maintenance mode 🚢
16
16
>
17
-
> Please migrate your projects to [UI5 Tooling v3](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/)!
17
+
> [UI5 CLI v2](https://sap.github.io/ui5-tooling/v2) has been deprecated 🚫
18
+
>
19
+
> Please migrate your projects to [UI5 CLI v3](https://sap.github.io/ui5-tooling/v4/updates/migrate-v3/) and afterwards to [UI5 CLI v4](https://sap.github.io/ui5-tooling/v4/updates/migrate-v4/)!
18
20
19
-
The reason to deprecate **UI5 Tooling Version 2** and enforce the migration to **UI5 Tooling Version 3** is rooted in our efforts to allow the usage of the latest ECMAScript syntax in the UI5 framework. OpenUI5 and SAPUI5 libraries will make use of modern ECMAScript syntax up to and including "ES2022". UI5 Tooling comes with comprehensive [ECMAScript support](https://sap.github.io/ui5-tooling/v3/pages/ESSupport/) only with Version 3.
21
+
The reason to deprecate **UI5 CLI Version 2** and enforce the migration to **UI5 CLI Version 3** is rooted in our efforts to allow the usage of the latest ECMAScript syntax in the UI5 framework. OpenUI5 and SAPUI5 libraries will make use of modern ECMAScript syntax up to and including "ES2022". UI5 CLI comes with comprehensive [ECMAScript support](https://sap.github.io/ui5-tooling/v3/pages/ESSupport/) only with Version 3.
20
22
21
-
Beginning with Release **1.116** of **OpenUI5** and **SAPUI5**, UI5 Framework libraries will start using modern ECMAScript syntax and define **"Specification Version 3.0"** in their UI5 Tooling configuration.
23
+
Beginning with Release **1.116** of **OpenUI5** and **SAPUI5**, UI5 Framework libraries will start using modern ECMAScript syntax and define **"Specification Version 3.0"** in their UI5 CLI configuration.
22
24
23
-
If you use UI5 Tooling in your projects, this means you will have to upgrade to UI5 Tooling Version 3.
25
+
If you use UI5 CLI in your projects, this means you will have to upgrade to UI5 CLI Version 3.
24
26
25
-
If you use additional build scripts or UI5 Tooling extensions, you should ensure their support for ECMAScript 2022.
27
+
If you use additional build scripts or UI5 CLI extensions, you should ensure their support for ECMAScript 2022.
26
28
27
29
28
30
## Resources
@@ -36,7 +38,7 @@ If you use additional build scripts or UI5 Tooling extensions, you should ensure
Copy file name to clipboardExpand all lines: audit-ci.jsonc
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@
12
12
13
13
// The package "http-cache-semantics" is vulnerable to a Regular Expression Denial of Service (ReDoS) attack.
14
14
// It is used by the "make-fetch-happen" and "got" packages which are only used to communicate with the npm registry configured by the user (registry.npmjs.org by default).
15
-
// Although this ReDoS attack is mainly applicable to servers, in theory a server could also send malicious headers to the client (UI5 Tooling) to cause an unexpected slowdown.
15
+
// Although this ReDoS attack is mainly applicable to servers, in theory a server could also send malicious headers to the client (UI5 CLI) to cause an unexpected slowdown.
16
16
// However, this configured npm registry is already considered a trusted connection as code is downloaded and run by the client.
The UI5 Tooling Version 2 code line won't get any further features. Therefore, please checkout the latest [Guidelines](https://github.com/SAP/ui5-tooling/blob/main/docs/Guidelines.md).
2
+
The UI5 CLI Version 2 code line won't get any further features. Therefore, please checkout the latest [Guidelines](https://github.com/SAP/ui5-tooling/blob/main/docs/Guidelines.md).
Most UI5 Tooling modules provide JavaScript APIs for direct consumption in other Node.js projects.
80
-
This allows you to rely on UI5 Tooling for UI5-specific build functionality and project handling, while creating your own tools to perfectly match the needs of your project.
84
+
Most UI5 CLI modules provide JavaScript APIs for direct consumption in other Node.js projects.
85
+
This allows you to rely on UI5 CLI for UI5-specific build functionality and project handling, while creating your own tools to perfectly match the needs of your project.
81
86
82
-
All available APIs are documented in the [UI5 Tooling API Reference](https://sap.github.io/ui5-tooling/v2/api/index.html).
87
+
All available APIs are documented in the [UI5 CLI API Reference](https://sap.github.io/ui5-tooling/v2/api/index.html).
Copy file name to clipboardExpand all lines: docs/indexJsdoc.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# UI5 Tooling API Reference
1
+
# UI5 CLI API Reference
2
2
3
3
## Support
4
4
Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/master/CONTRIBUTING.md#report-an-issue) on how to report an issue. Or chat with us in the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/)
0 commit comments