@ui5/create-webcomponents-package 0.0.0-35e2c9666 → 0.0.0-3e3654870

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