Skip to content

Commit 687d462

Browse files
authored
[INTERNAL] Rename project to UI5 CLI (#1093)
For further insights, see https://community.sap.com/t5/technology-blog-posts-by-sap/goodbye-ui5-tooling-hello-ui5-cli/ba-p/14211769. JIRA: CPOUI5FOUNDATION-1098
1 parent 146c9a5 commit 687d462

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+246
-241
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug Report
3-
about: Report an issue with UI5 Tooling
3+
about: Report an issue with UI5 CLI
44
title: ''
55
labels: bug, needs triage
66
assignees: ''

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Feature Request
3-
about: Request a new feature to be added to UI5 Tooling
3+
about: Request a new feature to be added to UI5 CLI
44
title: ''
55
labels: enhancement
66
assignees: ''

.reuse/dep5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@ Disclaimer: The code in this project may include calls to APIs (“API Calls”)
2525
parties the right to use of access any SAP External Product, through API Calls.
2626

2727
Files: *
28-
Copyright: 2018-2024 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
2929
License: Apache-2.0

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to the UI5 Tooling
1+
# Contributing to the UI5 CLI
22
## Content
33
1. [📝 **Reporting Issues**](#-reporting-issues)
44
2. [🤩 **Feature Requests**](#-feature-requests)
@@ -11,12 +11,12 @@
1111

1212
## 📝 Reporting Issues
1313
### 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).
1515

1616
### 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.
1818

19-
1. **Only UI5 Tooling issues**
19+
1. **Only UI5 CLI issues**
2020
* Please do not report:
2121
* Issues caused by dependencies or plugins.
2222
* 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
6767
* **`wontfix`**: While acknowledged to be an issue, a fix cannot or will not be provided.
6868

6969
### 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.
7171

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.
7373

7474
Bug report analysis support is always very welcome! See [Analyze Issues](#-analyzing-issues).
7575

7676
## 🤩 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
7878

7979
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.
8080

@@ -88,13 +88,13 @@ You may be able to add additional or missing information, such as a step-by-step
8888

8989
## 💻 Contributing Code
9090
### 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.
9292

9393
There are three important things to know:
9494

9595
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.
9696
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.
9898

9999
### Developer Certificate of Origin (DCO)
100100

@@ -105,7 +105,7 @@ This DCO replaces the previously used CLA ("Contributor License Agreement") as w
105105

106106
### How to Contribute
107107
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.
109109
1. Create a branch by forking the relevant module repository and apply your change.
110110
1. Commit and push your change on that branch.
111111
- 👉 **Please follow our [Development Conventions and Guidelines](docs/Guidelines.md).**

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
![UI5 logo](./docs/images/UI5_logo_wide.png)
22

3-
# UI5 Tooling
3+
# UI5 CLI
44
> An open and modular toolchain to develop state-of-the-art applications based on the [UI5](https://ui5.sap.com) framework.
55
66
[![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-tooling)](https://api.reuse.software/info/github.com/SAP/ui5-tooling)
77
[![OpenUI5 Community Slack (#tooling channel)](https://img.shields.io/badge/slack-join-44cc11.svg)](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com)
88
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
99

1010

11-
> [UI5 Tooling v4](https://sap.github.io/ui5-tooling/v4) is the latest and stable version 🎉
11+
> [UI5 CLI v4](https://sap.github.io/ui5-tooling/v4) is the latest and stable version 🎉
1212
>
13-
> [UI5 Tooling v3](https://sap.github.io/ui5-tooling/v3) is a stable version and in maintenance mode 🚢
13+
> [UI5 CLI v3](https://sap.github.io/ui5-tooling/v3) is a stable version and in maintenance mode 🚢
1414
>
15-
> [UI5 Tooling v2](https://sap.github.io/ui5-tooling/v2) has been deprecated 🚫
15+
> [UI5 CLI v2](https://sap.github.io/ui5-tooling/v2) has been deprecated 🚫
1616
>
17-
> Please migrate your projects to [UI5 Tooling v3](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/)!
17+
> Please migrate your projects to [UI5 CLI v3](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/)!
1818
1919

2020

@@ -29,7 +29,7 @@
2929
- [Roadmap](https://github.com/SAP/ui5-tooling/issues/701)
3030

3131
## Modules
32-
UI5 Tooling consists of multiple modules. Each one is managed in a separate repository:
32+
UI5 CLI consists of multiple modules. Each one is managed in a separate repository:
3333

3434
- [ui5-cli](https://github.com/SAP/ui5-cli): UI5 Command Line Interface, utilizing all of the following modules
3535
- [ui5-project](https://github.com/SAP/ui5-project): Modules for building a UI5 project's dependency tree, including configuration

SUPPORT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Support
22

3-
If you need help setting something up, or if you have questions regarding UI5 Tooling, please refrain from opening an issue on GitHub.
3+
If you need help setting something up, or if you have questions regarding UI5 CLI, please refrain from opening an issue on GitHub.
44

55
Instead, please use one of the following platforms to seek help:
66

docs/index.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
![UI5 logo](images/UI5_logo_wide.png)
22

3-
# UI5 Tooling
3+
# UI5 CLI
44

55
An open and modular toolchain to develop state-of-the-art applications based on the [UI5](https://ui5.sap.com) framework.
66

7+
!!! abstract "Project Rename"
8+
**UI5 Tooling has been renamed to UI5 CLI 🚨**
9+
10+
Read the announcement blog post: **[SAP Community: Goodbye UI5 Tooling - Hello UI5 CLI!](https://community.sap.com/t5/technology-blog-posts-by-sap/goodbye-ui5-tooling-hello-ui5-cli/ba-p/14211769)**
11+
712
[**Get Started**](./pages/GettingStarted.md){: .md-button .md-button--primary .sap-icon-initiative }
813

914
## Main Features
@@ -22,7 +27,7 @@ npm install --save-dev @ui5/cli
2227

2328
#### ⚙️ Project Setup
2429

25-
Configure your project for use with UI5 Tooling.
30+
Configure your project for use with UI5 CLI.
2631
*Also see the [Configuration Documentation](./pages/Configuration.md)*
2732

2833
```
@@ -37,7 +42,7 @@ type: application
3742

3843
#### 🚚 Dependency Management
3944

40-
UI5 framework dependencies are managed by the tooling. All other dependencies are managed by your favorite node package manager.
45+
UI5 framework dependencies are managed by the UI5 CLI. All other dependencies are managed by your favorite node package manager.
4146

4247
```
4348
❯ ui5 use [email protected]
@@ -84,10 +89,10 @@ info ProjectBuilder Executing cleanup tasks...
8489

8590
### 🧪 Node.js API
8691

87-
Most UI5 Tooling modules provide JavaScript APIs for direct consumption in other Node.js projects.
88-
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.
92+
Most UI5 CLI modules provide JavaScript APIs for direct consumption in other Node.js projects.
93+
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.
8994

90-
All available APIs are documented in the [UI5 Tooling API Reference](https://sap.github.io/ui5-tooling/v3/api/index.html).
95+
All available APIs are documented in the [UI5 CLI API Reference](https://sap.github.io/ui5-tooling/v3/api/index.html).
9196

9297
=== "ESM"
9398

docs/indexJsdoc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# UI5 Tooling API Reference
1+
# UI5 CLI API Reference
22

33
## Support
44
Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/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)

docs/pages/Benchmarking.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Benchmarking UI5 Tooling
1+
# Benchmarking UI5 CLI
22

3-
For benchmarking UI5 Tooling we typically make use of the open source tool [hyperfine](https://github.com/sharkdp/hyperfine).
3+
For benchmarking UI5 CLI we typically make use of the open source tool [hyperfine](https://github.com/sharkdp/hyperfine).
44

55
In general we only benchmark calls to the UI5 CLI. However, we might add scripted benchmarks for some components in the future.
66

@@ -9,10 +9,10 @@ The following is a walk-through on how to evaluate the performance impact of an
99
## Setup
1010

1111
1. Install [hyperfine](https://github.com/sharkdp/hyperfine#installation)
12-
1. Prepare the UI5 Tooling projects you want to measure *(optional if your development environment already reflects this)*:
12+
1. Prepare the UI5 CLI projects you want to measure *(optional if your development environment already reflects this)*:
1313
1. Start in an empty directory
1414
```sh
15-
mkdir ui5-tooling-benchmark && cd ui5-tooling-benchmark/
15+
mkdir ui5-cli-benchmark && cd ui5-cli-benchmark/
1616
```
1717
1. Clone [UI5 CLI](https://github.com/SAP/ui5-cli)
1818
```sh
@@ -45,7 +45,7 @@ The following is a walk-through on how to evaluate the performance impact of an
4545
4646
For example:
4747
```
48-
3.0.0 (from /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.cjs)
48+
3.0.0 (from /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs)
4949
```
5050
5151
1. Prepare your test project (we choose the [openui5-sample-app](https://github.com/SAP/openui5-sample-app))
@@ -64,11 +64,11 @@ The following is a walk-through on how to evaluate the performance impact of an
6464
Note: We won't link UI5 CLI into this project. Instead, we'll call it directly.
6565
1. Verify that the previously installed UI5 CLI can be called with the following command:
6666
```sh
67-
UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.cjs --version
67+
UI5_CLI_NO_LOCAL=X node /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs --version
6868
```
6969
On Windows:
7070
```sh
71-
set UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.cjs --version
71+
set UI5_CLI_NO_LOCAL=X node /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs --version
7272
```
7373
*(Replace the path to ui5.cjs with the one shown in the previous `ui5 --version` output)*
7474
@@ -84,20 +84,20 @@ The following is a walk-through on how to evaluate the performance impact of an
8484
1. In the project, start your first benchmark
8585
```sh
8686
hyperfine --warmup 1 \
87-
'UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.cjs build' \
87+
'UI5_CLI_NO_LOCAL=X node /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs build' \
8888
--export-markdown ./baseline.md
8989
```
9090
On Windows:
9191
```sh
9292
hyperfine --warmup 1 \
93-
'set UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.cjs build' \
93+
'set UI5_CLI_NO_LOCAL=X node /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs build' \
9494
--export-markdown ./baseline.md
9595
```
9696
1. Your baseline benchmark is now stored in `baseline.md` and should look similar to this:
9797
9898
| Command | Mean [s] | Min [s] | Max [s] | Relative |
9999
|:---|---:|---:|---:|---:|
100-
| `UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.cjs build` | 1.439 ± 0.036 | 1.400 | 1.507 | 1.00 |
100+
| `UI5_CLI_NO_LOCAL=X node /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs build` | 1.439 ± 0.036 | 1.400 | 1.507 | 1.00 |
101101
102102
1. Prepare your change
103103
1. Switch to the branch that contains your change
@@ -108,19 +108,19 @@ The following is a walk-through on how to evaluate the performance impact of an
108108
```sh
109109
(cd ../ui5-builder && npm install)
110110
```
111-
1. The link from UI5 CLI is still in place. However, if you have changes in **multiple** UI5 Tooling modules, you might need to `npm link` those again
111+
1. The link from UI5 CLI is still in place. However, if you have changes in **multiple** UI5 CLI modules, you might need to `npm link` those again
112112
113113
1. Perform the change measurement
114114
1. In the project, start your second benchmark
115115
```sh
116116
hyperfine --warmup 1 \
117-
'UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.cjs build' \
117+
'UI5_CLI_NO_LOCAL=X node /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs build' \
118118
--export-markdown ./my_change.md
119119
```
120120
On Windows:
121121
```sh
122122
hyperfine --warmup 1 \
123-
'set UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.cjs build' \
123+
'set UI5_CLI_NO_LOCAL=X node /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs build' \
124124
--export-markdown ./my_change.md
125125
```
126126
1. Your change's benchmark is now stored in `my_change.md`

0 commit comments

Comments
 (0)