@ui5/create-webcomponents-package 0.0.0-fb61e9889 → 0.0.0-fc993d8cd
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/CHANGELOG.md +257 -0
- package/README.md +32 -13
- package/{index.js → create-package.js} +108 -45
- package/package.json +4 -3
- package/template/.eslintignore +2 -0
- package/template/gitignore +4 -0
- package/template/global.d.ts +12 -0
- package/template/npmrc +2 -0
- package/template/package-scripts.js +2 -1
- package/template/src/Assets.js +1 -1
- package/template/src/Assets.ts +5 -0
- package/template/src/MyFirstComponent.js +22 -11
- package/template/src/MyFirstComponent.ts +48 -0
- package/template/test/pages/index.html +1 -3
- package/template/test/specs/Demo.spec.js +3 -1
- package/template/tsconfig.json +15 -0
- package/template/config/.eslintrc.js +0 -1
- package/template/config/rollup.config.js +0 -1
package/CHANGELOG.md
ADDED
@@ -0,0 +1,257 @@
|
|
1
|
+
# Change Log
|
2
|
+
|
3
|
+
All notable changes to this project will be documented in this file.
|
4
|
+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
5
|
+
|
6
|
+
# [1.12.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0-rc.2...v1.12.0-rc.3) (2023-03-30)
|
7
|
+
|
8
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
9
|
+
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
|
14
|
+
# [1.12.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0-rc.1...v1.12.0-rc.2) (2023-03-23)
|
15
|
+
|
16
|
+
|
17
|
+
### Bug Fixes
|
18
|
+
|
19
|
+
* inline sources in the .map file so the src folder is not mandatory ([#6732](https://github.com/SAP/ui5-webcomponents/issues/6732)) ([16771a6](https://github.com/SAP/ui5-webcomponents/commit/16771a64d7b13f418af9afa1a03b224fe3762775))
|
20
|
+
|
21
|
+
|
22
|
+
|
23
|
+
|
24
|
+
|
25
|
+
# [1.12.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0-rc.0...v1.12.0-rc.1) (2023-03-16)
|
26
|
+
|
27
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
28
|
+
|
29
|
+
|
30
|
+
|
31
|
+
|
32
|
+
|
33
|
+
# [1.12.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0...v1.12.0-rc.0) (2023-03-09)
|
34
|
+
|
35
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
36
|
+
|
37
|
+
|
38
|
+
|
39
|
+
|
40
|
+
|
41
|
+
# [1.11.0](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.4...v1.11.0) (2023-03-06)
|
42
|
+
|
43
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
44
|
+
|
45
|
+
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
# [1.11.0-rc.4](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.3...v1.11.0-rc.4) (2023-03-02)
|
50
|
+
|
51
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
52
|
+
|
53
|
+
|
54
|
+
|
55
|
+
|
56
|
+
|
57
|
+
# [1.11.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.2...v1.11.0-rc.3) (2023-02-23)
|
58
|
+
|
59
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
|
65
|
+
# [1.11.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.1...v1.11.0-rc.2) (2023-02-16)
|
66
|
+
|
67
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
# [1.11.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.0...v1.11.0-rc.1) (2023-02-09)
|
74
|
+
|
75
|
+
|
76
|
+
### Features
|
77
|
+
|
78
|
+
* **framework:** add option to define package name, tag and typescript support from CLI ([#6379](https://github.com/SAP/ui5-webcomponents/issues/6379)) ([687c0f7](https://github.com/SAP/ui5-webcomponents/commit/687c0f7a420a72f77f294ace2898223c48708ae2)), closes [#6382](https://github.com/SAP/ui5-webcomponents/issues/6382)
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
# [1.11.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.10.4-rc.0...v1.11.0-rc.0) (2023-02-02)
|
85
|
+
|
86
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
## [1.10.4-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.10.3...v1.10.4-rc.0) (2023-01-26)
|
93
|
+
|
94
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
## [1.10.3](https://github.com/SAP/ui5-webcomponents/compare/v1.10.2...v1.10.3) (2023-01-25)
|
101
|
+
|
102
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
## [1.10.1](https://github.com/SAP/ui5-webcomponents/compare/v0.0.0-7b49a7ff1...v1.10.1) (2023-01-24)
|
109
|
+
|
110
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
# [1.10.0](https://github.com/SAP/ui5-webcomponents/compare/v1.9.3...v1.10.0) (2023-01-20)
|
117
|
+
|
118
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
## [1.9.3](https://github.com/SAP/ui5-webcomponents/compare/v1.9.2...v1.9.3) (2022-12-16)
|
125
|
+
|
126
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
## [1.9.1](https://github.com/SAP/ui5-webcomponents/compare/v1.9.0...v1.9.1) (2022-11-10)
|
133
|
+
|
134
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
# [1.9.0](https://github.com/SAP/ui5-webcomponents/compare/v1.8.0...v1.9.0) (2022-10-31)
|
141
|
+
|
142
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
# [1.8.0](https://github.com/SAP/ui5-webcomponents/compare/v1.7.1...v1.8.0) (2022-10-03)
|
149
|
+
|
150
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
## [1.7.1](https://github.com/SAP/ui5-webcomponents/compare/v1.7.0...v1.7.1) (2022-09-08)
|
157
|
+
|
158
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
# [1.7.0](https://github.com/SAP/ui5-webcomponents/compare/v1.6.0...v1.7.0) (2022-09-02)
|
165
|
+
|
166
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
# [1.6.0](https://github.com/SAP/ui5-webcomponents/compare/v1.5.0...v1.6.0) (2022-07-25)
|
173
|
+
|
174
|
+
|
175
|
+
### Bug Fixes
|
176
|
+
|
177
|
+
* create package bugs ([#5517](https://github.com/SAP/ui5-webcomponents/issues/5517)) ([f528f5c](https://github.com/SAP/ui5-webcomponents/commit/f528f5c))
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
# [1.5.0](https://github.com/SAP/ui5-webcomponents/compare/v1.4.0...v1.5.0) (2022-07-03)
|
184
|
+
|
185
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
# [1.4.0](https://github.com/SAP/ui5-webcomponents/compare/v1.3.1...v1.4.0) (2022-05-25)
|
192
|
+
|
193
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
## [1.3.1](https://github.com/SAP/ui5-webcomponents/compare/v1.3.0...v1.3.1) (2022-04-27)
|
200
|
+
|
201
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
# [1.3.0](https://github.com/SAP/ui5-webcomponents/compare/v1.2.4...v1.3.0) (2022-04-19)
|
208
|
+
|
209
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
## [1.2.4](https://github.com/SAP/ui5-webcomponents/compare/v1.2.3...v1.2.4) (2022-03-30)
|
216
|
+
|
217
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
## [1.2.3](https://github.com/SAP/ui5-webcomponents/compare/v1.2.2...v1.2.3) (2022-03-23)
|
224
|
+
|
225
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
## [1.2.2](https://github.com/SAP/ui5-webcomponents/compare/v1.2.1...v1.2.2) (2022-03-22)
|
232
|
+
|
233
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
## [1.2.1](https://github.com/SAP/ui5-webcomponents/compare/v1.2.0...v1.2.1) (2022-03-02)
|
240
|
+
|
241
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
# [1.2.0](https://github.com/SAP/ui5-webcomponents/compare/v1.1.2...v1.2.0) (2022-02-28)
|
248
|
+
|
249
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
## [1.1.2](https://github.com/SAP/ui5-webcomponents/compare/v1.1.1...v1.1.2) (2022-01-26)
|
256
|
+
|
257
|
+
**Note:** Version bump only for package @ui5/create-webcomponents-package
|
package/README.md
CHANGED
@@ -1,38 +1,57 @@
|
|
1
|
-

|
2
2
|
|
3
3
|
# UI5 Web Components - Create Package
|
4
4
|
|
5
|
-
[](https://travis-ci.org/SAP/ui5-webcomponents)
|
6
5
|
[](https://www.npmjs.com/package/@ui5/webcomponents)
|
7
6
|
|
8
7
|
Provides an `npm init` script for creating new "UI5 Web Components" packages.
|
9
8
|
|
10
|
-
## Usage
|
9
|
+
## Usage with npm
|
11
10
|
|
12
|
-
|
11
|
+
```
|
12
|
+
Usage:
|
13
13
|
|
14
|
-
|
15
|
-
|
14
|
+
# npm 6.x
|
15
|
+
npm init @ui5/webcomponents-package [OPTIONS]
|
16
|
+
# npm 7+, an extra double-dash is needed:
|
17
|
+
npm init @ui5/webcomponents-package -- [OPTIONS]
|
16
18
|
|
17
|
-
|
19
|
+
Options:
|
20
|
+
--name <string> - defines the package name
|
21
|
+
--tag <string> - defines the tag name of the sample web component that will be created in your new package
|
22
|
+
--enable-typescript - enables TypeScript support for the package
|
23
|
+
--skip - skips configuration and generates package with a default value for each parameter that wasn't passed
|
24
|
+
```
|
18
25
|
|
19
|
-
|
20
|
-
|
26
|
+
The script creates a new directory, and fills it with a `package.json` file and all necessary source files, and resources for a new
|
27
|
+
components package.
|
28
|
+
|
29
|
+
## Usage with yarn
|
30
|
+
|
31
|
+
```
|
32
|
+
Usage:
|
33
|
+
yarn create @ui5/webcomponents-package [OPTIONS]
|
34
|
+
Options:
|
35
|
+
--name <string> - defines the package name
|
36
|
+
--tag <string> - defines the tag name of the sample web component that will be created in your new package
|
37
|
+
--enable-typescript - enables TypeScript support for the package
|
38
|
+
--skip - skips configuration and generates package with a default value for each parameter that wasn't passed
|
39
|
+
```
|
21
40
|
|
22
41
|
The script creates a new directory, and fills it with a `package.json` file and all necessary source files, and resources for a new
|
23
42
|
components package.
|
24
43
|
|
25
44
|
## Resources
|
26
|
-
- [UI5 Web Components - README.md](https://github.com/SAP/ui5-webcomponents/blob/
|
45
|
+
- [UI5 Web Components - README.md](https://github.com/SAP/ui5-webcomponents/blob/main/README.md)
|
27
46
|
- [UI5 Web Components - Home Page](https://sap.github.io/ui5-webcomponents)
|
28
47
|
- [UI5 Web Components - Playground and API Reference](https://sap.github.io/ui5-webcomponents/playground/)
|
29
48
|
|
30
49
|
## Support
|
31
|
-
We welcome all comments, suggestions, questions, and bug reports. Please follow our [Support Guidelines](https://github.com/SAP/ui5-webcomponents/blob/
|
50
|
+
We welcome all comments, suggestions, questions, and bug reports. Please follow our [Support Guidelines](https://github.com/SAP/ui5-webcomponents/blob/main/SUPPORT.md#-content) on how to report an issue, or chat with us in the `#webcomponents` channel of the [OpenUI5 Community Slack](https://join-ui5-slack.herokuapp.com/).
|
32
51
|
|
33
52
|
## Contribute
|
34
|
-
Please check our [Contribution Guidelines](https://github.com/SAP/ui5-webcomponents/blob/
|
53
|
+
Please check our [Contribution Guidelines](https://github.com/SAP/ui5-webcomponents/blob/main/docs/6-contributing/02-conventions-and-guidelines.md).
|
35
54
|
|
36
55
|
## License
|
37
56
|
Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
|
38
|
-
This file is licensed under the Apache Software License, Version 2.0 except as noted otherwise in the [LICENSE](https://github.com/SAP/ui5-webcomponents/blob/
|
57
|
+
This file is licensed under the Apache Software License, Version 2.0 except as noted otherwise in the [LICENSE](https://github.com/SAP/ui5-webcomponents/blob/main/LICENSE.txt) file.
|
@@ -5,6 +5,12 @@ const path = require("path");
|
|
5
5
|
const mkdirp = require("mkdirp");
|
6
6
|
const prompts = require("prompts");
|
7
7
|
const parser = require("npm-config-user-agent-parser");
|
8
|
+
const yargs = require("yargs/yargs");
|
9
|
+
const { hideBin } = require("yargs/helpers");
|
10
|
+
|
11
|
+
const argv = yargs(hideBin(process.argv)).argv;
|
12
|
+
|
13
|
+
const version = JSON.parse(fs.readFileSync(path.join(__dirname, "package.json"))).version;
|
8
14
|
|
9
15
|
// from where all the files will be copied
|
10
16
|
const TEMPLATE_DIR = path.join(`${__dirname}`, `template/`);
|
@@ -17,10 +23,21 @@ const toCamelCase = parts => {
|
|
17
23
|
return index === 0 ? string.toLowerCase() : string.charAt(0).toUpperCase() + string.slice(1).toLowerCase();
|
18
24
|
}).join("");
|
19
25
|
};
|
26
|
+
const isTSRelatedFile = sourcePath => {
|
27
|
+
return ["Assets.ts", "MyFirstComponent.ts", "tsconfig.json", "global.d.ts"].some(fileName => sourcePath.includes(fileName));
|
28
|
+
};
|
29
|
+
const isJSRelatedFile = sourcePath => {
|
30
|
+
return ["Assets.js", "MyFirstComponent.js"].some(fileName => sourcePath.includes(fileName));
|
31
|
+
};
|
32
|
+
const isGitIgnore = sourcePath => {
|
33
|
+
return sourcePath.includes("gitignore");
|
34
|
+
};
|
35
|
+
const isNPMRC = sourcePath => {
|
36
|
+
return sourcePath.includes("npmrc");
|
37
|
+
};
|
20
38
|
|
21
39
|
// Validation of user input
|
22
40
|
const isNameValid = name => typeof name === "string" && name.match(/^[a-zA-Z0-9\-_]+$/);
|
23
|
-
const isPortValid = port => typeof port === "string" && port.match(/^[0-9]+$/);
|
24
41
|
const isTagValid = tag => typeof tag === "string" && tag.match(/^[a-z0-9]+?-[a-zA-Z0-9\-_]+?[a-z0-9]$/);
|
25
42
|
|
26
43
|
// Utils for building the file structure
|
@@ -37,10 +54,28 @@ const replaceVarsInFileName = (vars, fileName) => {
|
|
37
54
|
};
|
38
55
|
|
39
56
|
const copyFile = (vars, sourcePath, destPath) => {
|
40
|
-
|
57
|
+
const ignoreJsRelated = vars.INIT_PACKAGE_VAR_TYPESCRIPT && isJSRelatedFile(sourcePath);
|
58
|
+
const ignoreTsRelated = !vars.INIT_PACKAGE_VAR_TYPESCRIPT && isTSRelatedFile(sourcePath);
|
59
|
+
|
60
|
+
if (ignoreJsRelated || ignoreTsRelated) {
|
61
|
+
return;
|
62
|
+
}
|
63
|
+
|
64
|
+
let content = fs.readFileSync(sourcePath, { encoding: "UTF-8" });
|
41
65
|
content = replaceVarsInFileContent(vars, content);
|
42
66
|
destPath = replaceVarsInFileName(vars, destPath);
|
67
|
+
|
43
68
|
fs.writeFileSync(destPath, content);
|
69
|
+
|
70
|
+
// Rename "gitignore" to ".gitignore" (npm init won't include ".gitignore", so we add it as "gitignore" and rename it later)
|
71
|
+
if (isGitIgnore(sourcePath)) {
|
72
|
+
fs.renameSync(destPath, destPath.replace("gitignore", ".gitignore"))
|
73
|
+
}
|
74
|
+
|
75
|
+
// Rename "npmrc" to ".npmrc" (npm init won't include ".npmrc", so we add it as "npmrc" and rename it later)
|
76
|
+
if (isNPMRC(sourcePath)) {
|
77
|
+
fs.renameSync(destPath, destPath.replace("npmrc", ".npmrc"));
|
78
|
+
}
|
44
79
|
};
|
45
80
|
|
46
81
|
const copyFiles = (vars, sourcePath, destPath) => {
|
@@ -57,51 +92,15 @@ const copyFiles = (vars, sourcePath, destPath) => {
|
|
57
92
|
}
|
58
93
|
};
|
59
94
|
|
60
|
-
|
61
|
-
const createWebcomponentsPackage = async () => {
|
62
|
-
let response;
|
63
|
-
|
64
|
-
// Get the name
|
65
|
-
let name = process.argv[2];
|
66
|
-
|
67
|
-
if (!isNameValid(name)) {
|
68
|
-
response = await prompts({
|
69
|
-
type: "text",
|
70
|
-
name: "name",
|
71
|
-
message: "Package name:",
|
72
|
-
validate: isNameValid,
|
73
|
-
});
|
74
|
-
name = response.name;
|
75
|
-
}
|
76
|
-
|
77
|
-
// Get the port
|
78
|
-
response = await prompts({
|
79
|
-
type: "text",
|
80
|
-
name: "port",
|
81
|
-
message: "Dev server port:",
|
82
|
-
validate: isPortValid,
|
83
|
-
initial: "8080",
|
84
|
-
});
|
85
|
-
const port = response.port;
|
86
|
-
|
87
|
-
// Get the tag
|
88
|
-
response = await prompts({
|
89
|
-
type: "text",
|
90
|
-
name: "tag",
|
91
|
-
message: "Demo component name:",
|
92
|
-
initial: "my-first-component",
|
93
|
-
validate: isTagValid,
|
94
|
-
});
|
95
|
-
const tag = response.tag;
|
96
|
-
|
95
|
+
const generateFilesContent = (name, tag, typescript) => {
|
97
96
|
const className = capitalizeFirst(kebabToCamelCase(tag));
|
98
97
|
|
99
98
|
// All variables that will be replaced in the content of the resources/
|
100
99
|
const vars = {
|
101
100
|
INIT_PACKAGE_VAR_NAME: name,
|
102
|
-
INIT_PACKAGE_VAR_PORT: port,
|
103
101
|
INIT_PACKAGE_VAR_TAG: tag,
|
104
102
|
INIT_PACKAGE_VAR_CLASS_NAME: className,
|
103
|
+
INIT_PACKAGE_VAR_TYPESCRIPT: typescript,
|
105
104
|
};
|
106
105
|
|
107
106
|
const packageContent = {
|
@@ -115,14 +114,12 @@ const createWebcomponentsPackage = async () => {
|
|
115
114
|
"lint": "wc-dev lint",
|
116
115
|
"start": "wc-dev start",
|
117
116
|
"watch": "wc-dev watch",
|
118
|
-
"serve": "wc-dev serve",
|
119
117
|
"build": "wc-dev build",
|
120
118
|
"test": "wc-dev test",
|
121
119
|
"create-ui5-element": "wc-create-ui5-element",
|
122
120
|
"prepublishOnly": "npm run build",
|
123
121
|
},
|
124
122
|
exports: {
|
125
|
-
"./.port": "./.port",
|
126
123
|
"./src/*": "./src/*",
|
127
124
|
"./dist/*": "./dist/*",
|
128
125
|
"./package.json": "./package.json",
|
@@ -130,15 +127,19 @@ const createWebcomponentsPackage = async () => {
|
|
130
127
|
"./*": "./dist/*",
|
131
128
|
},
|
132
129
|
"dependencies": {
|
133
|
-
"@ui5/webcomponents-base":
|
134
|
-
"@ui5/webcomponents-
|
130
|
+
"@ui5/webcomponents-base": version,
|
131
|
+
"@ui5/webcomponents-theming": version,
|
135
132
|
},
|
136
133
|
"devDependencies": {
|
137
|
-
"@ui5/webcomponents-tools":
|
134
|
+
"@ui5/webcomponents-tools": version,
|
138
135
|
"chromedriver": "*",
|
139
136
|
},
|
140
137
|
};
|
141
138
|
|
139
|
+
if (typescript) {
|
140
|
+
packageContent.devDependencies.typescript = "^4.9.4";
|
141
|
+
}
|
142
|
+
|
142
143
|
// Update package.json
|
143
144
|
const destDir = path.join(`./`, name);
|
144
145
|
mkdirp.sync(destDir);
|
@@ -165,4 +166,66 @@ const createWebcomponentsPackage = async () => {
|
|
165
166
|
console.log("\n");
|
166
167
|
};
|
167
168
|
|
169
|
+
// Main function
|
170
|
+
const createWebcomponentsPackage = async () => {
|
171
|
+
let response;
|
172
|
+
if (argv.name && !isNameValid(argv.name)) {
|
173
|
+
throw new Error("The package name should be a string (a-z, A-Z, 0-9).");
|
174
|
+
}
|
175
|
+
|
176
|
+
if (argv.tag && !isTagValid(argv.tag) ) {
|
177
|
+
throw new Error("The tag should be in kebab-case (my-first-component f.e) and it can't be a single word.");
|
178
|
+
}
|
179
|
+
|
180
|
+
let name = argv.name || "my-package";
|
181
|
+
let tag = argv.tag || "my-first-component";
|
182
|
+
let typescriptSupport = !!argv.enableTypescript;
|
183
|
+
|
184
|
+
if (argv.skip) {
|
185
|
+
return generateFilesContent(name, tag, typescriptSupport);
|
186
|
+
}
|
187
|
+
|
188
|
+
if (!argv.name) {
|
189
|
+
response = await prompts({
|
190
|
+
type: "text",
|
191
|
+
name: "name",
|
192
|
+
message: "Package name:",
|
193
|
+
validate: isNameValid,
|
194
|
+
});
|
195
|
+
name = response.name;
|
196
|
+
}
|
197
|
+
|
198
|
+
if (!typescriptSupport) {
|
199
|
+
response = await prompts({
|
200
|
+
type: "select",
|
201
|
+
name: "language",
|
202
|
+
message: "Project type:",
|
203
|
+
choices: [
|
204
|
+
{
|
205
|
+
title: "JavaScript",
|
206
|
+
value: false,
|
207
|
+
},
|
208
|
+
{
|
209
|
+
title: "TypeScript",
|
210
|
+
value: true,
|
211
|
+
},
|
212
|
+
],
|
213
|
+
});
|
214
|
+
typescriptSupport = response.language;
|
215
|
+
}
|
216
|
+
|
217
|
+
if (!argv.tag) {
|
218
|
+
response = await prompts({
|
219
|
+
type: "text",
|
220
|
+
name: "tag",
|
221
|
+
message: "Component name:",
|
222
|
+
initial: "my-first-component",
|
223
|
+
validate: isTagValid,
|
224
|
+
});
|
225
|
+
tag = response.tag;
|
226
|
+
}
|
227
|
+
|
228
|
+
return generateFilesContent(name, tag, typescriptSupport);
|
229
|
+
};
|
230
|
+
|
168
231
|
createWebcomponentsPackage();
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@ui5/create-webcomponents-package",
|
3
|
-
"version": "0.0.0-
|
3
|
+
"version": "0.0.0-fc993d8cd",
|
4
4
|
"description": "UI5 Web Components: create package",
|
5
5
|
"author": "SAP SE (https://www.sap.com)",
|
6
6
|
"license": "Apache-2.0",
|
@@ -11,7 +11,7 @@
|
|
11
11
|
"ui5"
|
12
12
|
],
|
13
13
|
"bin": {
|
14
|
-
"create-webcomponents-package": "
|
14
|
+
"create-webcomponents-package": "create-package.js"
|
15
15
|
},
|
16
16
|
"repository": {
|
17
17
|
"type": "git",
|
@@ -21,6 +21,7 @@
|
|
21
21
|
"dependencies": {
|
22
22
|
"mkdirp": "^1.0.4",
|
23
23
|
"npm-config-user-agent-parser": "^1.0.0",
|
24
|
-
"prompts": "^2.4.1"
|
24
|
+
"prompts": "^2.4.1",
|
25
|
+
"yargs": "^17.5.1"
|
25
26
|
}
|
26
27
|
}
|
package/template/.eslintignore
CHANGED
@@ -0,0 +1,12 @@
|
|
1
|
+
// eslint-disable-next-line
|
2
|
+
import "@ui5/webcomponents-base/dist/global";
|
3
|
+
import { TemplateFunction } from "@ui5/webcomponents-base/dist/renderer/executeTemplate.js";
|
4
|
+
|
5
|
+
export {};
|
6
|
+
|
7
|
+
declare global {
|
8
|
+
module "*.lit.js" {
|
9
|
+
const content: TemplateFunction;
|
10
|
+
export default content;
|
11
|
+
}
|
12
|
+
}
|
package/template/npmrc
ADDED
package/template/src/Assets.js
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
|
2
2
|
import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
|
3
|
-
import {
|
3
|
+
import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
|
4
4
|
|
5
5
|
// Template
|
6
6
|
import INIT_PACKAGE_VAR_CLASS_NAMETemplate from "./generated/templates/INIT_PACKAGE_VAR_CLASS_NAMETemplate.lit.js";
|
@@ -10,6 +10,9 @@ import INIT_PACKAGE_VAR_CLASS_NAMECss from "./generated/themes/INIT_PACKAGE_VAR_
|
|
10
10
|
|
11
11
|
import { PLEASE_WAIT } from "./generated/i18n/i18n-defaults.js";
|
12
12
|
|
13
|
+
/**
|
14
|
+
* @public
|
15
|
+
*/
|
13
16
|
const metadata = {
|
14
17
|
tag: "INIT_PACKAGE_VAR_TAG",
|
15
18
|
properties: {
|
@@ -20,16 +23,20 @@ const metadata = {
|
|
20
23
|
},
|
21
24
|
};
|
22
25
|
|
26
|
+
/**
|
27
|
+
* @class
|
28
|
+
*
|
29
|
+
* <h3 class="comment-api-title">Overview</h3>
|
30
|
+
*
|
31
|
+
* The <code>INIT_PACKAGE_VAR_TAG</code> component is a demo component that displays some text.
|
32
|
+
*
|
33
|
+
* @constructor
|
34
|
+
* @alias demo.components.INIT_PACKAGE_VAR_CLASS_NAME
|
35
|
+
* @extends sap.ui.webc.base.UI5Element
|
36
|
+
* @tagname INIT_PACKAGE_VAR_TAG
|
37
|
+
* @public
|
38
|
+
*/
|
23
39
|
class INIT_PACKAGE_VAR_CLASS_NAME extends UI5Element {
|
24
|
-
constructor() {
|
25
|
-
super();
|
26
|
-
this.i18nBundle = getI18nBundle("INIT_PACKAGE_VAR_NAME");
|
27
|
-
}
|
28
|
-
|
29
|
-
get pleaseWaitText() {
|
30
|
-
return this.i18nBundle.getText(PLEASE_WAIT);
|
31
|
-
}
|
32
|
-
|
33
40
|
static get metadata() {
|
34
41
|
return metadata;
|
35
42
|
}
|
@@ -47,7 +54,11 @@ class INIT_PACKAGE_VAR_CLASS_NAME extends UI5Element {
|
|
47
54
|
}
|
48
55
|
|
49
56
|
static async onDefine() {
|
50
|
-
await
|
57
|
+
INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle = await getI18nBundle("INIT_PACKAGE_VAR_NAME");
|
58
|
+
}
|
59
|
+
|
60
|
+
get pleaseWaitText() {
|
61
|
+
return INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle.getText(PLEASE_WAIT);
|
51
62
|
}
|
52
63
|
}
|
53
64
|
|
@@ -0,0 +1,48 @@
|
|
1
|
+
import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
|
2
|
+
import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
|
3
|
+
import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
|
4
|
+
import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
|
5
|
+
import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
|
6
|
+
|
7
|
+
// Template
|
8
|
+
import INIT_PACKAGE_VAR_CLASS_NAMETemplate from "./generated/templates/INIT_PACKAGE_VAR_CLASS_NAMETemplate.lit.js";
|
9
|
+
|
10
|
+
// Styles
|
11
|
+
import INIT_PACKAGE_VAR_CLASS_NAMECss from "./generated/themes/INIT_PACKAGE_VAR_CLASS_NAME.css.js";
|
12
|
+
|
13
|
+
import { PLEASE_WAIT } from "./generated/i18n/i18n-defaults.js";
|
14
|
+
|
15
|
+
/**
|
16
|
+
* @class
|
17
|
+
*
|
18
|
+
* <h3 class="comment-api-title">Overview</h3>
|
19
|
+
*
|
20
|
+
* The <code>INIT_PACKAGE_VAR_TAG</code> component is a demo component that displays some text.
|
21
|
+
*
|
22
|
+
* @constructor
|
23
|
+
* @alias demo.components.INIT_PACKAGE_VAR_CLASS_NAME
|
24
|
+
* @extends sap.ui.webc.base.UI5Element
|
25
|
+
* @tagname INIT_PACKAGE_VAR_TAG
|
26
|
+
* @public
|
27
|
+
*/
|
28
|
+
@customElement({
|
29
|
+
tag: "INIT_PACKAGE_VAR_TAG",
|
30
|
+
renderer: litRender,
|
31
|
+
styles: INIT_PACKAGE_VAR_CLASS_NAMECss,
|
32
|
+
template: INIT_PACKAGE_VAR_CLASS_NAMETemplate,
|
33
|
+
})
|
34
|
+
class INIT_PACKAGE_VAR_CLASS_NAME extends UI5Element {
|
35
|
+
static i18nBundle: I18nBundle;
|
36
|
+
|
37
|
+
static async onDefine() {
|
38
|
+
INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle = await getI18nBundle("INIT_PACKAGE_VAR_NAME");
|
39
|
+
}
|
40
|
+
|
41
|
+
get pleaseWaitText() {
|
42
|
+
return INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle.getText(PLEASE_WAIT);
|
43
|
+
}
|
44
|
+
}
|
45
|
+
|
46
|
+
INIT_PACKAGE_VAR_CLASS_NAME.define();
|
47
|
+
|
48
|
+
export default INIT_PACKAGE_VAR_CLASS_NAME;
|
@@ -2,12 +2,10 @@
|
|
2
2
|
<html>
|
3
3
|
|
4
4
|
<head>
|
5
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
6
5
|
<meta charset="utf-8">
|
7
6
|
|
8
7
|
<title>INIT_PACKAGE_VAR_TAG</title>
|
9
8
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
10
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
11
9
|
<meta charset="utf-8">
|
12
10
|
|
13
11
|
<script data-ui5-config type="application/json">
|
@@ -16,7 +14,7 @@
|
|
16
14
|
}
|
17
15
|
</script>
|
18
16
|
|
19
|
-
<script src="../../
|
17
|
+
<script src="../../bundle.esm.js" type="module"></script>
|
20
18
|
|
21
19
|
<style>
|
22
20
|
code { color: blue; font-size: small; }
|
@@ -1,7 +1,9 @@
|
|
1
1
|
const assert = require("assert");
|
2
2
|
|
3
3
|
describe("INIT_PACKAGE_VAR_TAG rendering", async () => {
|
4
|
-
|
4
|
+
before(async () => {
|
5
|
+
await browser.url("test/pages/index.html");
|
6
|
+
});
|
5
7
|
|
6
8
|
it("tests if web component is correctly rendered", async () => {
|
7
9
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
{
|
2
|
+
"include": ["src/**/*", "global.d.ts"],
|
3
|
+
"compilerOptions": {
|
4
|
+
"target": "ES2021",
|
5
|
+
// Generate d.ts files
|
6
|
+
"declaration": true,
|
7
|
+
"outDir": "dist",
|
8
|
+
"skipLibCheck": true,
|
9
|
+
"sourceMap": true,
|
10
|
+
"inlineSources": true,
|
11
|
+
"strict": true,
|
12
|
+
"moduleResolution": "node",
|
13
|
+
"experimentalDecorators": true,
|
14
|
+
},
|
15
|
+
}
|
@@ -1 +0,0 @@
|
|
1
|
-
module.exports = require("@ui5/webcomponents-tools/components-package/eslint.js"); // eslint-disable-line
|
@@ -1 +0,0 @@
|
|
1
|
-
module.exports = require("@ui5/webcomponents-tools/components-package/rollup.js"); // eslint-disable-line
|