create-easy-ui5 1.0.0
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/.editorconfig +21 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +40 -0
- package/.github/ISSUE_TEMPLATE/custom.md +7 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +19 -0
- package/.github/workflows/commitlint.yml +20 -0
- package/.github/workflows/release-auto.yml +29 -0
- package/.github/workflows/release-manual.yml +24 -0
- package/.husky/commit-msg +4 -0
- package/.husky/pre-commit +4 -0
- package/.prettierignore +1 -0
- package/CHANGELOG.md +10 -0
- package/CODE_OF_CONDUCT.md +128 -0
- package/CONTRIBUTING.md +166 -0
- package/LICENSE +202 -0
- package/README.md +56 -0
- package/index.js +34 -0
- package/package.json +57 -0
package/.editorconfig
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# EditorConfig helps developers define and maintain consistent
|
|
2
|
+
# coding styles between different editors and IDEs
|
|
3
|
+
# editorconfig.org
|
|
4
|
+
|
|
5
|
+
root = true
|
|
6
|
+
|
|
7
|
+
[*]
|
|
8
|
+
end_of_line = lf
|
|
9
|
+
charset = utf-8
|
|
10
|
+
trim_trailing_whitespace = true
|
|
11
|
+
insert_final_newline = true
|
|
12
|
+
indent_style = space
|
|
13
|
+
|
|
14
|
+
[*.md]
|
|
15
|
+
trim_trailing_whitespace = false
|
|
16
|
+
|
|
17
|
+
[{package.json,ui5.yaml}]
|
|
18
|
+
indent_size = 2
|
|
19
|
+
|
|
20
|
+
[*.js]
|
|
21
|
+
indent_size = 2
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Bug report
|
|
3
|
+
about: Create a report to help us improve
|
|
4
|
+
title: ""
|
|
5
|
+
labels: ""
|
|
6
|
+
assignees: ""
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
**Describe the bug**
|
|
10
|
+
A clear and concise description of what the bug is.
|
|
11
|
+
|
|
12
|
+
**To Reproduce**
|
|
13
|
+
Steps to reproduce the behavior:
|
|
14
|
+
|
|
15
|
+
1. Go to '...'
|
|
16
|
+
2. Click on '....'
|
|
17
|
+
3. Scroll down to '....'
|
|
18
|
+
4. See error
|
|
19
|
+
|
|
20
|
+
**Expected behavior**
|
|
21
|
+
A clear and concise description of what you expected to happen.
|
|
22
|
+
|
|
23
|
+
**Screenshots**
|
|
24
|
+
If applicable, add screenshots to help explain your problem.
|
|
25
|
+
|
|
26
|
+
**Desktop (please complete the following information):**
|
|
27
|
+
|
|
28
|
+
- OS: [e.g. iOS]
|
|
29
|
+
- Browser [e.g. chrome, safari]
|
|
30
|
+
- Version [e.g. 22]
|
|
31
|
+
|
|
32
|
+
**Smartphone (please complete the following information):**
|
|
33
|
+
|
|
34
|
+
- Device: [e.g. iPhone6]
|
|
35
|
+
- OS: [e.g. iOS8.1]
|
|
36
|
+
- Browser [e.g. stock browser, safari]
|
|
37
|
+
- Version [e.g. 22]
|
|
38
|
+
|
|
39
|
+
**Additional context**
|
|
40
|
+
Add any other context about the problem here.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Feature request
|
|
3
|
+
about: Suggest an idea for this project
|
|
4
|
+
title: ""
|
|
5
|
+
labels: ""
|
|
6
|
+
assignees: ""
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
**Is your feature request related to a problem? Please describe.**
|
|
10
|
+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
11
|
+
|
|
12
|
+
**Describe the solution you'd like**
|
|
13
|
+
A clear and concise description of what you want to happen.
|
|
14
|
+
|
|
15
|
+
**Describe alternatives you've considered**
|
|
16
|
+
A clear and concise description of any alternative solutions or features you've considered.
|
|
17
|
+
|
|
18
|
+
**Additional context**
|
|
19
|
+
Add any other context or screenshots about the feature request here.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
name: Lint Commit Message
|
|
2
|
+
on:
|
|
3
|
+
# Trigger the workflow on push or pull request,
|
|
4
|
+
# but only for the main branch
|
|
5
|
+
# See: https://github.community/t/duplicate-checks-on-push-and-pull-request-simultaneous-event/18012
|
|
6
|
+
push:
|
|
7
|
+
branches:
|
|
8
|
+
- main
|
|
9
|
+
pull_request:
|
|
10
|
+
branches:
|
|
11
|
+
- main
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
commitlint:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v2
|
|
18
|
+
with:
|
|
19
|
+
fetch-depth: 0
|
|
20
|
+
- uses: wagoid/commitlint-github-action@v4
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
name: Release (automatic)
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
release:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
if: "contains(github.event.head_commit.message, 'chore(release): publish')"
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v2
|
|
14
|
+
with:
|
|
15
|
+
fetch-depth: 0
|
|
16
|
+
- uses: actions/setup-node@v2
|
|
17
|
+
with:
|
|
18
|
+
node-version: "14"
|
|
19
|
+
|
|
20
|
+
- name: Install dependencies
|
|
21
|
+
run: npm ci
|
|
22
|
+
|
|
23
|
+
- name: Publish to NPM
|
|
24
|
+
run: |
|
|
25
|
+
echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
|
|
26
|
+
echo ":::: Publishing as $(npm whoami)"
|
|
27
|
+
npm publish
|
|
28
|
+
env:
|
|
29
|
+
NPM_TOKEN: ${{ secrets.NPM_RELEASE_AUTH_TOKEN }}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
name: Release (manually)
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
|
|
6
|
+
jobs:
|
|
7
|
+
release:
|
|
8
|
+
runs-on: ubuntu-latest
|
|
9
|
+
steps:
|
|
10
|
+
- uses: actions/checkout@v2
|
|
11
|
+
- uses: actions/setup-node@v2
|
|
12
|
+
with:
|
|
13
|
+
node-version: "14"
|
|
14
|
+
|
|
15
|
+
- name: Install dependencies
|
|
16
|
+
run: npm ci
|
|
17
|
+
|
|
18
|
+
- name: Publish to NPM
|
|
19
|
+
run: |
|
|
20
|
+
echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
|
|
21
|
+
echo ":::: Publishing as $(npm whoami)"
|
|
22
|
+
npm publish
|
|
23
|
+
env:
|
|
24
|
+
NPM_TOKEN: ${{ secrets.NPM_RELEASE_AUTH_TOKEN }}
|
package/.prettierignore
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
package-lock.json
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# [1.0.0](https://github.com/ui5-community/create-easy-ui5/compare/f9e81780ee499a24ab573e455cf15e9d190874d4...v1.0.0) (2022-03-10)
|
|
2
|
+
|
|
3
|
+
### Bug Fixes
|
|
4
|
+
|
|
5
|
+
- bugfix for arguments and polish docs ([29577d1](https://github.com/ui5-community/create-easy-ui5/commit/29577d14c99453aa869e63da28de1de4d8968862))
|
|
6
|
+
- run easy-ui5 in embedded mode ([f9e8178](https://github.com/ui5-community/create-easy-ui5/commit/f9e81780ee499a24ab573e455cf15e9d190874d4))
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
- fully initalize the repo ([532fc33](https://github.com/ui5-community/create-easy-ui5/commit/532fc33ed425730043b682e38b03f631f16d61b6))
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity
|
|
10
|
+
and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
- Demonstrating empathy and kindness toward other people
|
|
21
|
+
- Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
- Giving and gracefully accepting constructive feedback
|
|
23
|
+
- Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
- Focusing on what is best not just for us as individuals, but for the
|
|
26
|
+
overall community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
- The use of sexualized language or imagery, and sexual attention or
|
|
31
|
+
advances of any kind
|
|
32
|
+
- Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
- Public or private harassment
|
|
34
|
+
- Publishing others' private information, such as a physical or email
|
|
35
|
+
address, without their explicit permission
|
|
36
|
+
- Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
ui5communityteam@gmail.com.
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series
|
|
86
|
+
of actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or
|
|
93
|
+
permanent ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within
|
|
113
|
+
the community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.0, available at
|
|
119
|
+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
|
122
|
+
enforcement ladder](https://github.com/mozilla/diversity).
|
|
123
|
+
|
|
124
|
+
[homepage]: https://www.contributor-covenant.org
|
|
125
|
+
|
|
126
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
127
|
+
https://www.contributor-covenant.org/faq. Translations are available at
|
|
128
|
+
https://www.contributor-covenant.org/translations.
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# Contributing to `create-easy-ui5`
|
|
2
|
+
|
|
3
|
+
## Content
|
|
4
|
+
|
|
5
|
+
1. [📝 **Reporting Issues**](#-reporting-issues)
|
|
6
|
+
2. [🤩 **Feature Requests**](#-feature-requests)
|
|
7
|
+
3. [🔍 **Analyzing Issues**](#-analyzing-issues)
|
|
8
|
+
4. [💻 **Contributing Code**](#-contributing-code)
|
|
9
|
+
5. [📦 **Releasing Package**](#-releasing-package)
|
|
10
|
+
|
|
11
|
+
## 📝 Reporting Issues
|
|
12
|
+
|
|
13
|
+
### Seeking Help / Not a Bug
|
|
14
|
+
|
|
15
|
+
If you need help setting something up, or if you have questions regarding `create-easy-ui5`, please seek help on a community platform like [StackOverflow](http://stackoverflow.com/questions/tagged/ui5) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).
|
|
16
|
+
|
|
17
|
+
### How to Report an Issue
|
|
18
|
+
|
|
19
|
+
1. **Only `create-easy-ui5` issues**
|
|
20
|
+
2. **No duplicate**: You have searched the [issue tracker](https://github.com/ui5-community/create-easy-ui5/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to make sure the bug has not already been reported.
|
|
21
|
+
3. **Good summary**: The summary should be specific to the issue.
|
|
22
|
+
4. **Current bug**: The bug can be reproduced in the most current version of the relevant module(s).
|
|
23
|
+
5. **Reproducible bug**: There are step-by-step instructions provided on how to reproduce the issue.
|
|
24
|
+
6. **Well-documented**:
|
|
25
|
+
- Precisely state the expected and the actual behavior.
|
|
26
|
+
- Give information about the environment in which the issue occurs (OS/Platform, Node.js version, etc.).
|
|
27
|
+
- Generally, give as much additional information as possible.
|
|
28
|
+
7. **Only one bug per report**: Open additional tickets for additional issues.
|
|
29
|
+
8. **Please report bugs in English.**
|
|
30
|
+
|
|
31
|
+
We encourage you to follow the issue template that will be presented to you when creating a new issue.
|
|
32
|
+
|
|
33
|
+
When you are ready, report your issue here: https://github.com/ui5-community/create-easy-ui5/issues/new
|
|
34
|
+
|
|
35
|
+
### Use of Labels
|
|
36
|
+
|
|
37
|
+
GitHub offers labels to categorize issues. The labels can only be set and modified by committers.
|
|
38
|
+
|
|
39
|
+
#### General issue categories
|
|
40
|
+
|
|
41
|
+
- **`bug`**: This issue is a bug in the code.
|
|
42
|
+
- **`documentation`**: This issue is about wrong documentation.
|
|
43
|
+
- **`enhancement`**: This is not a bug report, but an enhancement request.
|
|
44
|
+
|
|
45
|
+
#### Status of an open issue
|
|
46
|
+
|
|
47
|
+
- **`information required`**: The author is required to provide information.
|
|
48
|
+
- **`good first issue`**: A newcomer may work on this.
|
|
49
|
+
- **`help wanted`**: Additional help in analyzing this issue is required.
|
|
50
|
+
|
|
51
|
+
#### Status/resolution of a closed issue
|
|
52
|
+
|
|
53
|
+
- **`duplicate`**: The issue was already reported somewhere else.
|
|
54
|
+
- **`invalid`**: For any reason, this issue report will not be handled further. Possible reasons are lack of information, or that the issue does not apply anymore.
|
|
55
|
+
- **`wontfix`**: While acknowledged to be an issue, a fix cannot or will not be provided.
|
|
56
|
+
|
|
57
|
+
### Issue Reporting Disclaimer
|
|
58
|
+
|
|
59
|
+
We want to improve the quality of the UI5 Communtiy projects and good bug reports are welcome! But keep in mind that this here is spare-time work and thus the capacity is limited.
|
|
60
|
+
|
|
61
|
+
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 Community projects are Open Source and comes without warranty.
|
|
62
|
+
|
|
63
|
+
Bug report analysis support is always very welcome! See [Analyze Issues](#-analyzing-issues).
|
|
64
|
+
|
|
65
|
+
## 🤩 Feature Requests
|
|
66
|
+
|
|
67
|
+
You can request most features by creating an issue in the repository: https://github.com/ui5-community/create-easy-ui5/issues/new
|
|
68
|
+
|
|
69
|
+
## 🔍 Analyzing Issues
|
|
70
|
+
|
|
71
|
+
Analyzing issue reports can be a lot of effort. Any help is welcome! 👍
|
|
72
|
+
|
|
73
|
+
You may be able to add additional or missing information, such as a step-by-step guide on how to reproduce an issue or an analysis of the root cause. In case of the latter, you might even be able to [contribute](#-contributing-code) a bugfix. 🙌
|
|
74
|
+
|
|
75
|
+
## 💻 Contributing Code
|
|
76
|
+
|
|
77
|
+
### General Remarks
|
|
78
|
+
|
|
79
|
+
You are welcome to contribute code to the project in order to fix bugs or to implement new features.
|
|
80
|
+
|
|
81
|
+
There are three important things to know:
|
|
82
|
+
|
|
83
|
+
1. You must be aware of the Apache License (which describes contributions).
|
|
84
|
+
2. **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 project and improve it. Before contributing a feature, please open a feature request upfront to discuss the necessity of the feature with the core contributors.
|
|
85
|
+
|
|
86
|
+
### How to Contribute
|
|
87
|
+
|
|
88
|
+
1. Make sure the change is welcome (see [General Remarks](#general-remarks)).
|
|
89
|
+
2. Create a branch by forking the relevant module repository and apply your change.
|
|
90
|
+
3. Commit and push your change on that branch.
|
|
91
|
+
4. Create a pull request in the relevant repository.
|
|
92
|
+
5. Wait for our code review and approval, possibly enhancing your change on request.
|
|
93
|
+
6. Once the change has been approved and merged, we will inform you in a comment.
|
|
94
|
+
7. Let's celebrate together! 🎉
|
|
95
|
+
|
|
96
|
+
#### Requirements
|
|
97
|
+
|
|
98
|
+
The technical requirements to contribute to the project are the following:
|
|
99
|
+
|
|
100
|
+
- A current version of [Node.js](https://nodejs.org/)
|
|
101
|
+
- A code editor (preferably the free [Microsoft Visual Studio Code](https://code.visualstudio.com/))
|
|
102
|
+
|
|
103
|
+
#### Getting Started
|
|
104
|
+
|
|
105
|
+
To get started contributing to this project you need to do the following steps:
|
|
106
|
+
|
|
107
|
+
- Clone the repository
|
|
108
|
+
- Run `npm install`
|
|
109
|
+
|
|
110
|
+
#### Commit Messages format
|
|
111
|
+
|
|
112
|
+
This project enforces the [conventional-commits][conventional_commits] commit message formats.
|
|
113
|
+
The possible commits types prefixes are limited to those defined by [conventional-commit-types][commit_types].
|
|
114
|
+
This promotes a clean project history and enabled automatically generating a changelog.
|
|
115
|
+
|
|
116
|
+
The commit message format will be inspected both on a git pre-commit hook
|
|
117
|
+
and during the central CI build and will **fail the build** if issues are found.
|
|
118
|
+
|
|
119
|
+
#### Formatting
|
|
120
|
+
|
|
121
|
+
[Prettier](https://prettier.io/) is used for some of the sub-packages to do a proper code formatting. The formatting is running as part of the `pre-commit` hook.
|
|
122
|
+
|
|
123
|
+
#### Compiling
|
|
124
|
+
|
|
125
|
+
This project is implemented using plain ECMAScript without any compilation / transpilation steps.
|
|
126
|
+
|
|
127
|
+
#### Testing
|
|
128
|
+
|
|
129
|
+
There is no testing tooling used for this repository so for. To test the project the simplest way is to run it:
|
|
130
|
+
|
|
131
|
+
```sh
|
|
132
|
+
# run the project
|
|
133
|
+
npm start
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## 📦 Release Package
|
|
137
|
+
|
|
138
|
+
This repository uses [Lerna](https://github.com/lerna/lerna) to manage the release process.
|
|
139
|
+
|
|
140
|
+
### Release Process
|
|
141
|
+
|
|
142
|
+
First, make sure that you pull the latest state of the GitHub repository and then proceed with the following steps:
|
|
143
|
+
|
|
144
|
+
1. Update the version: `npm version patch|minor|major`
|
|
145
|
+
2. Update the changelog: `npm run changelog`, commit and amend the version change from step 1: `git add . && git commit --amend --no-edit`
|
|
146
|
+
3. Push the new commit and tag: `git push origin --tags`
|
|
147
|
+
4. Inspect the newly artifacts published on npmjs.com.
|
|
148
|
+
|
|
149
|
+
A GitHub action will do the needful once the new tag has been pushed.
|
|
150
|
+
|
|
151
|
+
### Upgrading the version of the dependencies
|
|
152
|
+
|
|
153
|
+
To upgrade the version of the dependencies the NPM package `npm-check-updates` is used. The following code snippets shows how to use it:
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
# install the npm-check-updates
|
|
157
|
+
npm install -g npm-check-updates
|
|
158
|
+
|
|
159
|
+
# check for dependencies to be updated
|
|
160
|
+
ncu
|
|
161
|
+
|
|
162
|
+
# update the dependencies automatically
|
|
163
|
+
ncu -u
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Be careful with major version changes of the dependencies as this might cause additional work to make the package running again.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
202
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# npm-init wrapper for Easy-UI5
|
|
2
|
+
|
|
3
|
+
[![License Status][license-image]][license-url]
|
|
4
|
+
|
|
5
|
+
This NPM package wraps [Easy-UI5](https://github.com/SAP/generator-easy-ui5) Yeoman generator in [`npm-init`](https://docs.npmjs.com/cli/v8/commands/npm-init), [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) or even just a binary. It automatically benefits from all the available [UI5 Community generators](https://github.com/ui5-community/?q=generator-ui5&type=all&language=&sort=).
|
|
6
|
+
|
|
7
|
+
## Getting Started
|
|
8
|
+
|
|
9
|
+
This NPM packages just adds a few more options to use the Easy-UI5 Yeoman generator - but even a bit easier...
|
|
10
|
+
|
|
11
|
+
### Option 1: Using `npm-init`
|
|
12
|
+
|
|
13
|
+
The [`npm-init`](https://docs.npmjs.com/cli/v8/commands/npm-init) command is used to setup new repositories. You can use the `create-easy-ui5` package for `npm-init` like this:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
npm init easy-ui5 [template]
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The `create-easy-ui5` package doesn't need to be installed upfront to be used as `npm-init` is downloading it automatically from the central NPM registry.
|
|
20
|
+
|
|
21
|
+
### Option 2: Using `npx`
|
|
22
|
+
|
|
23
|
+
The [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) command is used to run NPM packages directly and can be used to run the setup script:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
npx create-easy-ui5 [template]
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The `create-easy-ui5` package doesn't need to be installed upfront to be used as `npm-init` is downloading it automatically from the central NPM registry.
|
|
30
|
+
|
|
31
|
+
### Option 3: Using `easy-ui5` binary
|
|
32
|
+
|
|
33
|
+
The `easy-ui5` binary is provided by the `create-easy-ui5` NPM package and once installed it can be used to setup new repositories using the Easy-UI5 Yeoman generator:
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
# Install create-easy-ui5
|
|
37
|
+
npm i -g create-easy-ui5
|
|
38
|
+
|
|
39
|
+
# Run the binary
|
|
40
|
+
easy-ui5 [template]
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Support
|
|
44
|
+
|
|
45
|
+
Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.
|
|
46
|
+
|
|
47
|
+
## Contributing
|
|
48
|
+
|
|
49
|
+
We welcome any type of contribution (code contributions, pull requests, issues) to this generator equally.
|
|
50
|
+
|
|
51
|
+
## License
|
|
52
|
+
|
|
53
|
+
This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.
|
|
54
|
+
|
|
55
|
+
[license-image]: https://img.shields.io/github/license/ui5-community/create-easy-ui5.svg
|
|
56
|
+
[license-url]: https://github.com/ui5-community/create-easy-ui5/blob/main/LICENSE
|
package/index.js
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
// extract the arguments (remove "easy-ui5" if present)
|
|
4
|
+
const args = process.argv.slice(2);
|
|
5
|
+
if (args[0] === "easy-ui5") {
|
|
6
|
+
args.splice(0, 1);
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
// create the env for the plugin generator
|
|
10
|
+
const yeoman = require("yeoman-environment");
|
|
11
|
+
const env = yeoman.createEnv(args, {
|
|
12
|
+
cwd: process.cwd(),
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
// lookup the easy-ui5 generator
|
|
16
|
+
const generators = env
|
|
17
|
+
.lookup({
|
|
18
|
+
localOnly: false,
|
|
19
|
+
})
|
|
20
|
+
.filter((sub) => {
|
|
21
|
+
return sub.namespace === "easy-ui5:app";
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
// finally, run the subgenerator
|
|
25
|
+
if (generators[0]?.namespace) {
|
|
26
|
+
env.run([generators[0].namespace].concat(args), {
|
|
27
|
+
// verbose: this.options.verbose,
|
|
28
|
+
embedded: true,
|
|
29
|
+
});
|
|
30
|
+
} else {
|
|
31
|
+
console.error(
|
|
32
|
+
"Easy-UI5 cannot be found! Please run 'npm i -g generator-easy-ui5'!"
|
|
33
|
+
);
|
|
34
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "create-easy-ui5",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "npm-init wrapper for Easy-UI5",
|
|
5
|
+
"bin": {
|
|
6
|
+
"easy-ui5": "index.js"
|
|
7
|
+
},
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/ui5-community/create-easy-ui5.git"
|
|
11
|
+
},
|
|
12
|
+
"keywords": [],
|
|
13
|
+
"author": "Peter Muessig",
|
|
14
|
+
"license": "Apache 2.0",
|
|
15
|
+
"bugs": {
|
|
16
|
+
"url": "https://github.com/ui5-community/create-easy-ui5/issues"
|
|
17
|
+
},
|
|
18
|
+
"homepage": "https://github.com/ui5-community/create-easy-ui5#readme",
|
|
19
|
+
"engines": {
|
|
20
|
+
"node": ">=14.0.0"
|
|
21
|
+
},
|
|
22
|
+
"scripts": {
|
|
23
|
+
"start": "node index.js",
|
|
24
|
+
"format": "prettier --write .",
|
|
25
|
+
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
|
|
26
|
+
"prepare": "husky install",
|
|
27
|
+
"hooks:pre-commit": "lint-staged",
|
|
28
|
+
"hooks:commit-msg": "commitlint -e"
|
|
29
|
+
},
|
|
30
|
+
"dependencies": {
|
|
31
|
+
"generator-easy-ui5": "^3.3.0"
|
|
32
|
+
},
|
|
33
|
+
"devDependencies": {
|
|
34
|
+
"@commitlint/cli": "16.2.1",
|
|
35
|
+
"@commitlint/config-conventional": "16.2.1",
|
|
36
|
+
"conventional-changelog-cli": "^2.2.2",
|
|
37
|
+
"cz-conventional-changelog": "3.3.0",
|
|
38
|
+
"husky": "^7.0.4",
|
|
39
|
+
"lint-staged": "12.3.4",
|
|
40
|
+
"prettier": "^2.5.1"
|
|
41
|
+
},
|
|
42
|
+
"lint-staged": {
|
|
43
|
+
"*.{ts,js,json,md,yml}": [
|
|
44
|
+
"prettier --write ."
|
|
45
|
+
]
|
|
46
|
+
},
|
|
47
|
+
"config": {
|
|
48
|
+
"commitizen": {
|
|
49
|
+
"path": "cz-conventional-changelog"
|
|
50
|
+
}
|
|
51
|
+
},
|
|
52
|
+
"commitlint": {
|
|
53
|
+
"extends": [
|
|
54
|
+
"@commitlint/config-conventional"
|
|
55
|
+
]
|
|
56
|
+
}
|
|
57
|
+
}
|