@ui5/create-webcomponents-package 0.0.0-8393c7cdd → 0.0.0-8c62d34c3

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.
Files changed (34) hide show
  1. package/CHANGELOG.md +516 -0
  2. package/README.md +31 -8
  3. package/create-package.js +271 -0
  4. package/package.json +4 -3
  5. package/template/.eslintignore +3 -0
  6. package/template/.eslintrc.js +5 -0
  7. package/template/gitignore +4 -0
  8. package/template/npmrc +2 -0
  9. package/template/package-scripts.js +2 -1
  10. package/template/src/Assets.ts +5 -0
  11. package/template/src/MyFirstComponent.hbs +1 -1
  12. package/template/src/MyFirstComponent.js +21 -6
  13. package/template/src/MyFirstComponent.ts +63 -0
  14. package/template/src/i18n/messagebundle.properties +3 -2
  15. package/template/src/i18n/messagebundle_de.properties +1 -1
  16. package/template/src/i18n/messagebundle_en.properties +1 -1
  17. package/template/src/i18n/messagebundle_es.properties +1 -1
  18. package/template/src/i18n/messagebundle_fr.properties +1 -1
  19. package/template/src/themes/MyFirstComponent.css +14 -9
  20. package/template/src/themes/sap_fiori_3/parameters-bundle.css +1 -1
  21. package/template/src/themes/sap_horizon_dark/parameters-bundle.css +3 -0
  22. package/template/src/themes/sap_horizon_hcb/parameters-bundle.css +3 -0
  23. package/template/test/pages/css/index.css +36 -0
  24. package/template/test/pages/img/logo.png +0 -0
  25. package/template/test/pages/index.html +35 -30
  26. package/template/test/specs/Demo.spec.js +3 -2
  27. package/template/tsconfig.json +15 -0
  28. package/index.js +0 -169
  29. package/template/src/themes/sap_belize_hcw/parameters-bundle.css +0 -3
  30. package/template/src/themes/sap_fiori_3_dark/parameters-bundle.css +0 -3
  31. package/template/src/themes/sap_fiori_3_hcb/parameters-bundle.css +0 -3
  32. package/template/src/themes/sap_fiori_3_hcw/parameters-bundle.css +0 -3
  33. /package/template/src/themes/{sap_belize → sap_horizon}/parameters-bundle.css +0 -0
  34. /package/template/src/themes/{sap_belize_hcb → sap_horizon_hcw}/parameters-bundle.css +0 -0
package/CHANGELOG.md CHANGED
@@ -3,6 +3,522 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [1.20.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.20.0-rc.2...v1.20.0-rc.3) (2023-11-30)
7
+
8
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
9
+
10
+
11
+
12
+
13
+
14
+ # [1.20.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.20.0-rc.1...v1.20.0-rc.2) (2023-11-23)
15
+
16
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
17
+
18
+
19
+
20
+
21
+
22
+ # [1.20.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.20.0-rc.0...v1.20.0-rc.1) (2023-11-16)
23
+
24
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
25
+
26
+
27
+
28
+
29
+
30
+ # [1.20.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.19.0...v1.20.0-rc.0) (2023-11-09)
31
+
32
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
33
+
34
+
35
+
36
+
37
+
38
+ # [1.19.0](https://github.com/SAP/ui5-webcomponents/compare/v1.19.0-rc.3...v1.19.0) (2023-11-02)
39
+
40
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
41
+
42
+
43
+
44
+
45
+
46
+ # [1.19.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.19.0-rc.2...v1.19.0-rc.3) (2023-11-02)
47
+
48
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
49
+
50
+
51
+
52
+
53
+
54
+ # [1.19.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.19.0-rc.1...v1.19.0-rc.2) (2023-10-26)
55
+
56
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
57
+
58
+
59
+
60
+
61
+
62
+ # [1.19.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.19.0-rc.0...v1.19.0-rc.1) (2023-10-19)
63
+
64
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
65
+
66
+
67
+
68
+
69
+
70
+ # [1.19.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.18.1-rc.0...v1.19.0-rc.0) (2023-10-12)
71
+
72
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
73
+
74
+
75
+
76
+
77
+
78
+ ## [1.18.1-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.18.0...v1.18.1-rc.0) (2023-10-05)
79
+
80
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
81
+
82
+
83
+
84
+
85
+
86
+ # [1.18.0](https://github.com/SAP/ui5-webcomponents/compare/v1.18.0-rc.2...v1.18.0) (2023-10-02)
87
+
88
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
89
+
90
+
91
+
92
+
93
+
94
+ # [1.18.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.18.0-rc.1...v1.18.0-rc.2) (2023-09-28)
95
+
96
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
97
+
98
+
99
+
100
+
101
+
102
+ # [1.18.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.18.0-rc.0...v1.18.0-rc.1) (2023-09-21)
103
+
104
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
105
+
106
+
107
+
108
+
109
+
110
+ # [1.18.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.17.0...v1.18.0-rc.0) (2023-09-07)
111
+
112
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
113
+
114
+
115
+
116
+
117
+
118
+ # [1.17.0](https://github.com/SAP/ui5-webcomponents/compare/v1.17.0-rc.2...v1.17.0) (2023-09-01)
119
+
120
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
121
+
122
+
123
+
124
+
125
+
126
+ # [1.17.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.17.0-rc.1...v1.17.0-rc.2) (2023-08-24)
127
+
128
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
129
+
130
+
131
+
132
+
133
+
134
+ # [1.17.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.17.0-rc.0...v1.17.0-rc.1) (2023-08-17)
135
+
136
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
137
+
138
+
139
+
140
+
141
+
142
+ # [1.17.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.16.0...v1.17.0-rc.0) (2023-08-10)
143
+
144
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
145
+
146
+
147
+
148
+
149
+
150
+ # [1.16.0](https://github.com/SAP/ui5-webcomponents/compare/v1.16.0-rc.4...v1.16.0) (2023-08-03)
151
+
152
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
153
+
154
+
155
+
156
+
157
+
158
+ # [1.16.0-rc.4](https://github.com/SAP/ui5-webcomponents/compare/v1.16.0-rc.3...v1.16.0-rc.4) (2023-08-03)
159
+
160
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
161
+
162
+
163
+
164
+
165
+
166
+ # [1.16.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.16.0-rc.2...v1.16.0-rc.3) (2023-07-27)
167
+
168
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
169
+
170
+
171
+
172
+
173
+
174
+ # [1.16.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.16.0-rc.1...v1.16.0-rc.2) (2023-07-20)
175
+
176
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
177
+
178
+
179
+
180
+
181
+
182
+ # [1.16.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.16.0-rc.0...v1.16.0-rc.1) (2023-07-13)
183
+
184
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
185
+
186
+
187
+
188
+
189
+
190
+ # [1.16.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.15.1...v1.16.0-rc.0) (2023-07-06)
191
+
192
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
193
+
194
+
195
+
196
+
197
+
198
+ ## [1.15.1](https://github.com/SAP/ui5-webcomponents/compare/v1.15.0...v1.15.1) (2023-06-30)
199
+
200
+
201
+ ### Bug Fixes
202
+
203
+ * **framework:** fix links in starting page of new pkg [ci skip] ([475fed5](https://github.com/SAP/ui5-webcomponents/commit/475fed55504f4a15e8b26aaf3c9e4d73b55976ec))
204
+
205
+
206
+
207
+
208
+
209
+ # [1.15.0](https://github.com/SAP/ui5-webcomponents/compare/v1.15.0-rc.2...v1.15.0) (2023-06-30)
210
+
211
+
212
+ ### Bug Fixes
213
+
214
+ * fix image in `create-webcomponent-package` ([#7253](https://github.com/SAP/ui5-webcomponents/issues/7253)) ([3317e64](https://github.com/SAP/ui5-webcomponents/commit/3317e64b911f992abf34b88a48e6003a723f7b9e))
215
+
216
+
217
+
218
+
219
+
220
+ # [1.15.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.15.0-rc.1...v1.15.0-rc.2) (2023-06-22)
221
+
222
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
223
+
224
+
225
+
226
+
227
+
228
+ # [1.15.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.15.0-rc.0...v1.15.0-rc.1) (2023-06-15)
229
+
230
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+ # [1.15.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.14.0...v1.15.0-rc.0) (2023-06-08)
241
+
242
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
243
+
244
+
245
+
246
+
247
+
248
+ # [1.14.0](https://github.com/SAP/ui5-webcomponents/compare/v1.14.0-rc.2...v1.14.0) (2023-06-01)
249
+
250
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
251
+
252
+
253
+
254
+
255
+
256
+ # [1.14.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.14.0-rc.1...v1.14.0-rc.2) (2023-06-01)
257
+
258
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
259
+
260
+
261
+
262
+
263
+
264
+ # [1.14.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.14.0-rc.0...v1.14.0-rc.1) (2023-05-25)
265
+
266
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
267
+
268
+
269
+
270
+
271
+
272
+ # [1.14.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.13.2...v1.14.0-rc.0) (2023-05-18)
273
+
274
+
275
+ ### Features
276
+
277
+ * users can provide a JSDoc namespeace when creating a package ([#7034](https://github.com/SAP/ui5-webcomponents/issues/7034)) ([0af8d23](https://github.com/SAP/ui5-webcomponents/commit/0af8d2376e25e5abe6d940c72286ab7c682eea56))
278
+
279
+
280
+
281
+
282
+
283
+ ## [1.13.1](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.5...v1.13.1) (2023-05-11)
284
+
285
+
286
+ ### Bug Fixes
287
+
288
+ * **create-package:** revert `moduleResolution` setting to `node` ([#7020](https://github.com/SAP/ui5-webcomponents/issues/7020)) ([9fc84e2](https://github.com/SAP/ui5-webcomponents/commit/9fc84e288452616ee72f3a2b6fc31d9752f05f6f))
289
+
290
+
291
+
292
+
293
+
294
+ # [1.13.0-rc.5](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.4...v1.13.0-rc.5) (2023-05-11)
295
+
296
+
297
+ ### Bug Fixes
298
+
299
+ * **create-webcomponents-package:** fix package creation issues with test and lint ([#6976](https://github.com/SAP/ui5-webcomponents/issues/6976)) ([dd70f3a](https://github.com/SAP/ui5-webcomponents/commit/dd70f3aa8ef70b592f1d4e0f3f9894c6280fb1bf))
300
+
301
+
302
+
303
+
304
+
305
+ # [1.13.0-rc.4](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.3...v1.13.0-rc.4) (2023-05-04)
306
+
307
+
308
+ ### Features
309
+
310
+ * generate TS from HBS templates ([#6558](https://github.com/SAP/ui5-webcomponents/issues/6558)) ([02611b2](https://github.com/SAP/ui5-webcomponents/commit/02611b2e24b2c2a06129b8e60a8bc680d9501e39))
311
+
312
+
313
+
314
+
315
+
316
+ # [1.13.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.2...v1.13.0-rc.3) (2023-04-27)
317
+
318
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
319
+
320
+
321
+
322
+
323
+
324
+ # [1.13.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.1...v1.13.0-rc.2) (2023-04-20)
325
+
326
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
327
+
328
+
329
+
330
+
331
+
332
+ # [1.13.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.0...v1.13.0-rc.1) (2023-04-13)
333
+
334
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
335
+
336
+
337
+
338
+
339
+
340
+ # [1.13.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0...v1.13.0-rc.0) (2023-04-06)
341
+
342
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
343
+
344
+
345
+
346
+
347
+
348
+ # [1.12.0](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0-rc.3...v1.12.0) (2023-04-04)
349
+
350
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
351
+
352
+
353
+
354
+
355
+
356
+ # [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)
357
+
358
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
359
+
360
+
361
+
362
+
363
+
364
+ # [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)
365
+
366
+
367
+ ### Bug Fixes
368
+
369
+ * 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))
370
+
371
+
372
+
373
+
374
+
375
+ # [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)
376
+
377
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
378
+
379
+
380
+
381
+
382
+
383
+ # [1.12.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0...v1.12.0-rc.0) (2023-03-09)
384
+
385
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
386
+
387
+
388
+
389
+
390
+
391
+ # [1.11.0](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.4...v1.11.0) (2023-03-06)
392
+
393
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
394
+
395
+
396
+
397
+
398
+
399
+ # [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)
400
+
401
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
402
+
403
+
404
+
405
+
406
+
407
+ # [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)
408
+
409
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
410
+
411
+
412
+
413
+
414
+
415
+ # [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)
416
+
417
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
418
+
419
+
420
+
421
+
422
+
423
+ # [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)
424
+
425
+
426
+ ### Features
427
+
428
+ * **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)
429
+
430
+
431
+
432
+
433
+
434
+ # [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)
435
+
436
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
437
+
438
+
439
+
440
+
441
+
442
+ ## [1.10.4-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.10.3...v1.10.4-rc.0) (2023-01-26)
443
+
444
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
445
+
446
+
447
+
448
+
449
+
450
+ ## [1.10.3](https://github.com/SAP/ui5-webcomponents/compare/v1.10.2...v1.10.3) (2023-01-25)
451
+
452
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
453
+
454
+
455
+
456
+
457
+
458
+ ## [1.10.1](https://github.com/SAP/ui5-webcomponents/compare/v0.0.0-7b49a7ff1...v1.10.1) (2023-01-24)
459
+
460
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
461
+
462
+
463
+
464
+
465
+
466
+ # [1.10.0](https://github.com/SAP/ui5-webcomponents/compare/v1.9.3...v1.10.0) (2023-01-20)
467
+
468
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
469
+
470
+
471
+
472
+
473
+
474
+ ## [1.9.3](https://github.com/SAP/ui5-webcomponents/compare/v1.9.2...v1.9.3) (2022-12-16)
475
+
476
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
477
+
478
+
479
+
480
+
481
+
482
+ ## [1.9.1](https://github.com/SAP/ui5-webcomponents/compare/v1.9.0...v1.9.1) (2022-11-10)
483
+
484
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
485
+
486
+
487
+
488
+
489
+
490
+ # [1.9.0](https://github.com/SAP/ui5-webcomponents/compare/v1.8.0...v1.9.0) (2022-10-31)
491
+
492
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
493
+
494
+
495
+
496
+
497
+
498
+ # [1.8.0](https://github.com/SAP/ui5-webcomponents/compare/v1.7.1...v1.8.0) (2022-10-03)
499
+
500
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
501
+
502
+
503
+
504
+
505
+
506
+ ## [1.7.1](https://github.com/SAP/ui5-webcomponents/compare/v1.7.0...v1.7.1) (2022-09-08)
507
+
508
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
509
+
510
+
511
+
512
+
513
+
514
+ # [1.7.0](https://github.com/SAP/ui5-webcomponents/compare/v1.6.0...v1.7.0) (2022-09-02)
515
+
516
+ **Note:** Version bump only for package @ui5/create-webcomponents-package
517
+
518
+
519
+
520
+
521
+
6
522
  # [1.6.0](https://github.com/SAP/ui5-webcomponents/compare/v1.5.0...v1.6.0) (2022-07-25)
7
523
 
8
524
 
package/README.md CHANGED
@@ -1,22 +1,45 @@
1
1
  ![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-webcomponents/main/docs/images/UI5_logo_wide.png)
2
2
 
3
+
3
4
  # UI5 Web Components - Create Package
4
5
 
5
6
  [![npm Package Version](https://badge.fury.io/js/%40ui5%2Fwebcomponents.svg)](https://www.npmjs.com/package/@ui5/webcomponents)
6
7
 
7
8
  Provides an `npm init` script for creating new "UI5 Web Components" packages.
8
9
 
9
- ## Usage
10
+ ## Usage with npm
11
+
12
+ ```
13
+ Usage:
14
+
15
+ # npm 6.x
16
+ npm init @ui5/webcomponents-package [OPTIONS]
17
+ # npm 7+, an extra double-dash is needed:
18
+ npm init @ui5/webcomponents-package -- [OPTIONS]
10
19
 
11
- with `npm`
20
+ Options:
21
+ --name <string> - defines the package name
22
+ --component-name <string> - defines the component class name that will be created in your new package
23
+ --tag <string> - defines the tag name of the sample web component that will be created in your new package. The tag will be derived from the component name if not provided.
24
+ --enable-typescript - enables TypeScript support for the package
25
+ --skip - skips configuration and generates package with a default value for each parameter that wasn't passed
26
+ ```
12
27
 
13
- - `npm init @ui5/webcomponents-package` (the user will be asked for **name**, **port**, **tag**);
14
- - `npm init @ui5/webcomponents-package <NEW-PACKAGE-NAME>` (the user will be asked for **port** and **tag** only).
28
+ The script creates a new directory, and fills it with a `package.json` file and all necessary source files, and resources for a new
29
+ components package.
15
30
 
16
- And with `yarn`
31
+ ## Usage with yarn
17
32
 
18
- - `yarn create @ui5/webcomponents-package`
19
- - `yarn create @ui5/webcomponents-package <NEW-PACKAGE-NAME>`.
33
+ ```
34
+ Usage:
35
+ yarn create @ui5/webcomponents-package [OPTIONS]
36
+ Options:
37
+ --name <string> - defines the package name
38
+ --component-name <string> - defines the component class name that will be created in your new package
39
+ --tag <string> - defines the tag name of the sample web component that will be created in your new package
40
+ --enable-typescript - enables TypeScript support for the package
41
+ --skip - skips configuration and generates package with a default value for each parameter that wasn't passed
42
+ ```
20
43
 
21
44
  The script creates a new directory, and fills it with a `package.json` file and all necessary source files, and resources for a new
22
45
  components package.
@@ -27,7 +50,7 @@ components package.
27
50
  - [UI5 Web Components - Playground and API Reference](https://sap.github.io/ui5-webcomponents/playground/)
28
51
 
29
52
  ## Support
30
- 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/).
53
+ 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://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).
31
54
 
32
55
  ## Contribute
33
56
  Please check our [Contribution Guidelines](https://github.com/SAP/ui5-webcomponents/blob/main/docs/6-contributing/02-conventions-and-guidelines.md).