@ui5/webcomponents-tools 0.0.0-155f8e0a7 → 0.0.0-16056b836

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 (92) hide show
  1. package/CHANGELOG.md +451 -0
  2. package/README.md +5 -6
  3. package/assets-meta.js +16 -1
  4. package/bin/dev.js +1 -5
  5. package/components-package/eslint.js +34 -0
  6. package/components-package/nps.js +103 -50
  7. package/components-package/postcss.components.js +13 -13
  8. package/components-package/postcss.themes.js +19 -16
  9. package/components-package/vite.config.js +13 -0
  10. package/components-package/wdio.js +393 -344
  11. package/components-package/wdio.sync.js +360 -0
  12. package/icons-collection/nps.js +52 -11
  13. package/lib/copy-and-watch/index.js +30 -5
  14. package/lib/copy-list/index.js +28 -0
  15. package/lib/create-icons/index.js +124 -54
  16. package/lib/create-illustrations/index.js +161 -0
  17. package/lib/create-new-component/index.js +73 -97
  18. package/lib/create-new-component/jsFileContentTemplate.js +73 -0
  19. package/lib/create-new-component/tsFileContentTemplate.js +80 -0
  20. package/lib/dev-server/dev-server.js +66 -0
  21. package/lib/dev-server/virtual-index-html-plugin.js +52 -0
  22. package/lib/esm-abs-to-rel/index.js +58 -0
  23. package/lib/generate-custom-elements-manifest/index.js +327 -0
  24. package/lib/generate-js-imports/illustrations.js +72 -0
  25. package/lib/generate-json-imports/i18n.js +75 -30
  26. package/lib/generate-json-imports/themes.js +62 -24
  27. package/lib/hbs2lit/src/compiler.js +20 -3
  28. package/lib/hbs2lit/src/includesReplacer.js +5 -5
  29. package/lib/hbs2lit/src/litVisitor2.js +77 -14
  30. package/lib/hbs2lit/src/svgProcessor.js +3 -3
  31. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +4 -11
  32. package/lib/hbs2ui5/index.js +37 -21
  33. package/lib/i18n/defaults.js +65 -57
  34. package/lib/i18n/toJSON.js +13 -12
  35. package/lib/jsdoc/config.json +1 -1
  36. package/lib/jsdoc/configTypescript.json +29 -0
  37. package/lib/jsdoc/plugin.js +62 -1
  38. package/lib/jsdoc/preprocess.js +146 -0
  39. package/lib/jsdoc/template/publish.js +30 -2
  40. package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
  41. package/lib/postcss-css-to-esm/index.js +64 -16
  42. package/lib/postcss-css-to-json/index.js +31 -11
  43. package/lib/postcss-new-files/index.js +36 -0
  44. package/lib/postcss-p/postcss-p.mjs +14 -0
  45. package/lib/replace-global-core/index.js +25 -0
  46. package/lib/scoping/get-all-tags.js +1 -8
  47. package/lib/scoping/lint-src.js +1 -1
  48. package/lib/scoping/missing-dependencies.js +65 -0
  49. package/lib/scoping/report-tags-usage.js +28 -0
  50. package/lib/scoping/scope-test-pages.js +1 -1
  51. package/lib/test-runner/test-runner.js +71 -0
  52. package/package.json +52 -53
  53. package/bin/init-ui5-package.js +0 -3
  54. package/components-package/rollup.js +0 -145
  55. package/components-package/serve.json +0 -3
  56. package/lib/documentation/index.js +0 -143
  57. package/lib/documentation/templates/api-component-since.js +0 -3
  58. package/lib/documentation/templates/api-css-variables-section.js +0 -24
  59. package/lib/documentation/templates/api-events-section.js +0 -35
  60. package/lib/documentation/templates/api-methods-section.js +0 -26
  61. package/lib/documentation/templates/api-properties-section.js +0 -40
  62. package/lib/documentation/templates/api-slots-section.js +0 -28
  63. package/lib/documentation/templates/template.js +0 -38
  64. package/lib/init-package/index.js +0 -123
  65. package/lib/init-package/resources/.eslintignore +0 -3
  66. package/lib/init-package/resources/bundle.es5.js +0 -25
  67. package/lib/init-package/resources/bundle.esm.js +0 -34
  68. package/lib/init-package/resources/config/.eslintrc.js +0 -1
  69. package/lib/init-package/resources/config/postcss.components/postcss.config.js +0 -1
  70. package/lib/init-package/resources/config/postcss.themes/postcss.config.js +0 -1
  71. package/lib/init-package/resources/config/rollup.config.js +0 -1
  72. package/lib/init-package/resources/config/wdio.conf.js +0 -1
  73. package/lib/init-package/resources/package-scripts.js +0 -11
  74. package/lib/init-package/resources/src/Assets.js +0 -5
  75. package/lib/init-package/resources/src/MyFirstComponent.hbs +0 -1
  76. package/lib/init-package/resources/src/MyFirstComponent.js +0 -56
  77. package/lib/init-package/resources/src/i18n/messagebundle.properties +0 -2
  78. package/lib/init-package/resources/src/i18n/messagebundle_de.properties +0 -1
  79. package/lib/init-package/resources/src/i18n/messagebundle_en.properties +0 -1
  80. package/lib/init-package/resources/src/i18n/messagebundle_es.properties +0 -1
  81. package/lib/init-package/resources/src/i18n/messagebundle_fr.properties +0 -1
  82. package/lib/init-package/resources/src/themes/MyFirstComponent.css +0 -11
  83. package/lib/init-package/resources/src/themes/sap_belize/parameters-bundle.css +0 -3
  84. package/lib/init-package/resources/src/themes/sap_belize_hcb/parameters-bundle.css +0 -3
  85. package/lib/init-package/resources/src/themes/sap_belize_hcw/parameters-bundle.css +0 -3
  86. package/lib/init-package/resources/src/themes/sap_fiori_3/parameters-bundle.css +0 -3
  87. package/lib/init-package/resources/src/themes/sap_fiori_3_dark/parameters-bundle.css +0 -3
  88. package/lib/init-package/resources/src/themes/sap_fiori_3_hcb/parameters-bundle.css +0 -3
  89. package/lib/init-package/resources/src/themes/sap_fiori_3_hcw/parameters-bundle.css +0 -3
  90. package/lib/init-package/resources/test/pages/index.html +0 -56
  91. package/lib/init-package/resources/test/specs/Demo.spec.js +0 -12
  92. package/package-lock.json +0 -48
@@ -1,54 +1,124 @@
1
- const fs = require("fs");
2
- const path = require("path");
3
- const mkdirp = require("mkdirp");
4
-
5
- const srcDir = `src/icon-collections/`;
6
- const destDir = `dist/icons/`;
7
-
8
- mkdirp.sync(destDir);
9
-
10
- const template = (name, pathData, ltr) => `import { registerIcon } from "@ui5/webcomponents-base/dist/SVGIconRegistry.js";
11
-
12
- const name = "${name}";
13
- const pathData = "${pathData}";
14
- const ltr = ${ltr};
15
-
16
- registerIcon(name, { pathData, ltr});
17
-
18
- export default { pathData };`;
19
-
20
- const accTemplate = (name, pathData, ltr, accData) => `import { registerIcon } from "@ui5/webcomponents-base/dist/SVGIconRegistry.js";
21
- import { ${accData.key} } from "../generated/i18n/i18n-defaults.js";
22
-
23
- const name = "${name}";
24
- const pathData = "${pathData}";
25
- const ltr = ${ltr};
26
- const accData = ${accData.key};
27
-
28
- registerIcon(name, { pathData, ltr, accData });
29
-
30
- export default { pathData, accData };`;
31
-
32
-
33
- const createIcons = (file) => {
34
- const json = JSON.parse(fs.readFileSync(file));
35
-
36
- for (let name in json.data) {
37
- const iconData = json.data[name];
38
- const pathData = iconData.path;
39
- const ltr = !!iconData.ltr;
40
- const acc = iconData.acc;
41
-
42
- const content = acc ? accTemplate(name, pathData, ltr, acc) : template(name, pathData, ltr);
43
-
44
- fs.writeFileSync(path.join(destDir, `${name}.js`), content);
45
- }
46
-
47
- };
48
-
49
- fs.readdirSync(srcDir).forEach(collectionFile => {
50
- createIcons(path.join(srcDir, collectionFile));
51
- });
52
-
53
-
54
-
1
+ const fs = require("fs").promises;
2
+ const path = require("path");
3
+
4
+ const collectionName = process.argv[2] || "SAP-icons-v4";
5
+ const collectionVersion = process.argv[3];
6
+ const srcFile = collectionVersion ? path.normalize(`src/${collectionVersion}/${collectionName}.json`) : path.normalize(`src/${collectionName}.json`);
7
+ const destDir = collectionVersion ? path.normalize(`dist/${collectionVersion}/`) : path.normalize("dist/");
8
+
9
+ const iconTemplate = (name, pathData, ltr, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
10
+
11
+ const name = "${name}";
12
+ const pathData = "${pathData}";
13
+ const ltr = ${ltr};
14
+ const accData = null;
15
+ const collection = "${collection}";
16
+ const packageName = "${packageName}";
17
+
18
+ registerIcon(name, { pathData, ltr, collection, packageName });
19
+
20
+ export default "${collection}/${name}";
21
+ export { pathData, ltr, accData };`;
22
+
23
+
24
+ const iconAccTemplate = (name, pathData, ltr, accData, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
25
+ import { ${accData.key} } from "../generated/i18n/i18n-defaults.js";
26
+
27
+ const name = "${name}";
28
+ const pathData = "${pathData}";
29
+ const ltr = ${ltr};
30
+ const accData = ${accData.key};
31
+ const collection = "${collection}";
32
+ const packageName = "${packageName}";
33
+
34
+ registerIcon(name, { pathData, ltr, accData, collection, packageName });
35
+
36
+ export default "${collection}/${name}";
37
+ export { pathData, ltr, accData };`;
38
+
39
+
40
+
41
+ const collectionTemplate = (name, versions, fullName) => `import { isLegacyThemeFamily } from "@ui5/webcomponents-base/dist/config/Theme.js";
42
+ import { pathData as pathData${versions[0]}, ltr, accData } from "./${versions[0]}/${name}.js";
43
+ import { pathData as pathData${versions[1]} } from "./${versions[1]}/${name}.js";
44
+
45
+ const pathData = isLegacyThemeFamily() ? pathData${versions[0]} : pathData${versions[1]};
46
+
47
+ export default "${fullName}";
48
+ export { pathData, ltr, accData };`;
49
+
50
+
51
+ const typeDefinitionTemplate = (name, accData, collection) => `declare const pathData: string;
52
+ declare const ltr: boolean;
53
+ declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
54
+ declare const _default: "${collection}/${name}";
55
+
56
+ export default _default;
57
+ export { pathData, ltr, accData };`
58
+
59
+ const collectionTypeDefinitionTemplate = (name, accData) => `declare const pathData: string;
60
+ declare const ltr: boolean;
61
+ declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
62
+ declare const _default: "${name}";
63
+
64
+ export default _default;
65
+ export { pathData, ltr, accData };`
66
+
67
+
68
+ const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
69
+ <path d="${pathData}"/>
70
+ </svg>`;
71
+
72
+ const createIcons = async (file) => {
73
+ await fs.mkdir(destDir, { recursive: true });
74
+
75
+ const json = JSON.parse(await fs.readFile(file));
76
+
77
+ const promises = [];
78
+ for (let name in json.data) {
79
+ const iconData = json.data[name];
80
+ const pathData = iconData.path;
81
+ const ltr = !!iconData.ltr;
82
+ const acc = iconData.acc;
83
+ const packageName = json.packageName;
84
+ const collection = json.collection;
85
+
86
+ const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName) : iconTemplate(name, pathData, ltr, collection, packageName);
87
+
88
+ promises.push(fs.writeFile(path.join(destDir, `${name}.js`), content));
89
+ promises.push(fs.writeFile(path.join(destDir, `${name}.svg`), svgTemplate(pathData)));
90
+ promises.push(fs.writeFile(path.join(destDir, `${name}.d.ts`), typeDefinitionTemplate(name, acc, collection)));
91
+
92
+ // For versioned icons collections, the script creates top level (unversioned) module that internally imports the versioned ones.
93
+ // For example, the top level "@ui5/ui5-webcomponents-icons/dist/accept.js" imports:
94
+ // - "@ui5/ui5-webcomponents-icons/dist/v5/accept.js"
95
+ // - "@ui5/ui5-webcomponents-icons/dist/v4/accept.js"
96
+
97
+ if (json.version) {
98
+ // The exported value from the top level (unversioned) icon module depends on whether the collection is the default,
99
+ // to add or not the collection name to the exported value:
100
+ // For the default collection (SAPIcons) we export just the icon name - "export default { 'accept' }"
101
+ // For non-default collections (SAPTNTIcons and SAPBSIcons) we export the full name - "export default { 'tnt/actor' }"
102
+ const effectiveName = isDefaultCollection(collection) ? name : getUnversionedFullIconName(name, collection);
103
+ promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.js`), collectionTemplate(name, json.versions, effectiveName)));
104
+ promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.d.ts`), collectionTypeDefinitionTemplate(effectiveName, acc)));
105
+ }
106
+ }
107
+
108
+ return Promise.all(promises);
109
+ };
110
+
111
+ const isDefaultCollection = collectionName => collectionName === "SAP-icons-v4" || collectionName === "SAP-icons-v5";
112
+ const getUnversionedFullIconName = (name, collection) => `${getUnversionedCollectionName(collection)}/${name}`;
113
+ const getUnversionedCollectionName = collectionName => CollectionVersionedToUnversionedMap[collectionName] || collectionName;
114
+
115
+ const CollectionVersionedToUnversionedMap = {
116
+ "tnt-v2": "tnt",
117
+ "tnt-v3": "tnt",
118
+ "business-suite-v1": "business-suite",
119
+ "business-suite-v2": "business-suite",
120
+ };
121
+
122
+ createIcons(srcFile).then(() => {
123
+ console.log("Icons created.");
124
+ });
@@ -0,0 +1,161 @@
1
+ const fs = require("fs").promises;
2
+ const path = require("path");
3
+
4
+ if (process.argv.length < 7) {
5
+ throw new Error("Not enough arguments");
6
+ }
7
+
8
+ const generate = async () => {
9
+
10
+ const ORIGINAL_TEXTS = {
11
+ UnableToLoad: "UnableToLoad",
12
+ UnableToUpload: "UnableToUpload",
13
+ NoActivities: "NoActivities",
14
+ BeforeSearch: "BeforeSearch",
15
+ NoSearchResults: "NoSearchResults",
16
+ NoEntries: "NoEntries",
17
+ NoData: "NoData",
18
+ NoNotifications: "NoNotifications",
19
+ BalloonSky: "BalloonSky",
20
+ SuccessScreen: "SuccessScreen",
21
+ NoMail: "NoMail",
22
+ NoSavedItems: "NoSavedItems",
23
+ NoTasks: "NoTasks"
24
+ };
25
+
26
+ const FALLBACK_TEXTS = {
27
+ ReloadScreen: ORIGINAL_TEXTS.UnableToLoad,
28
+ Connection: ORIGINAL_TEXTS.UnableToLoad,
29
+ ErrorScreen: ORIGINAL_TEXTS.UnableToUpload,
30
+ EmptyCalendar: ORIGINAL_TEXTS.NoActivities,
31
+ SearchEarth: ORIGINAL_TEXTS.BeforeSearch,
32
+ SearchFolder: ORIGINAL_TEXTS.NoSearchResults,
33
+ EmptyList: ORIGINAL_TEXTS.NoEntries,
34
+ Tent: ORIGINAL_TEXTS.NoData,
35
+ SleepingBell: ORIGINAL_TEXTS.NoNotifications,
36
+ SimpleBalloon: ORIGINAL_TEXTS.BalloonSky,
37
+ SimpleBell: ORIGINAL_TEXTS.NoNotifications,
38
+ SimpleCalendar: ORIGINAL_TEXTS.NoActivities,
39
+ SimpleCheckMark: ORIGINAL_TEXTS.SuccessScreen,
40
+ SimpleConnection: ORIGINAL_TEXTS.UnableToLoad,
41
+ SimpleEmptyDoc: ORIGINAL_TEXTS.NoData,
42
+ SimpleEmptyList: ORIGINAL_TEXTS.NoEntries,
43
+ SimpleError: ORIGINAL_TEXTS.UnableToUpload,
44
+ SimpleMagnifier: ORIGINAL_TEXTS.BeforeSearch,
45
+ SimpleMail: ORIGINAL_TEXTS.NoMail,
46
+ SimpleNoSavedItems: ORIGINAL_TEXTS.NoSavedItems,
47
+ SimpleNotFoundMagnifier: ORIGINAL_TEXTS.NoSearchResults,
48
+ SimpleReload: ORIGINAL_TEXTS.UnableToLoad,
49
+ SimpleTask: ORIGINAL_TEXTS.NoTasks,
50
+ SuccessBalloon: ORIGINAL_TEXTS.BalloonSky,
51
+ SuccessCheckMark: ORIGINAL_TEXTS.SuccessScreen,
52
+ SuccessHighFive: ORIGINAL_TEXTS.BalloonSky
53
+ };
54
+
55
+ const srcPath = process.argv[2];
56
+ const defaultText = process.argv[3] === "true";
57
+ const illustrationsPrefix = process.argv[4];
58
+ const illustrationSet = process.argv[5];
59
+ const destPath = process.argv[6];
60
+ const fileNamePattern = new RegExp(`${illustrationsPrefix}-.+-(.+).svg`);
61
+ // collect each illustration name because each one should have Sample.js file
62
+ const fileNames = new Set();
63
+
64
+ const svgImportTemplate = svgContent => {
65
+ return `export default \`${svgContent}\`;`
66
+ };
67
+ const svgToJs = async fileName => {
68
+ const svg = await fs.readFile(path.join(srcPath, fileName), {encoding: "utf-8"});
69
+ const fileContent = svgImportTemplate(svg);
70
+ fileName = fileName.replace(/\.svg$/, ".js");
71
+
72
+ return fs.writeFile(path.join(destPath, fileName), fileContent);
73
+ };
74
+ const illustrationImportTemplate = illustrationName => {
75
+ let illustrationNameForTranslation = illustrationName;
76
+
77
+ if (defaultText) {
78
+ if (FALLBACK_TEXTS[illustrationNameForTranslation]) {
79
+ illustrationNameForTranslation = FALLBACK_TEXTS[illustrationNameForTranslation];
80
+ } else if (illustrationName.indexOf("_v") !== -1) {
81
+ illustrationNameForTranslation = illustrationNameForTranslation.substr(0, illustrationNameForTranslation.indexOf('_v'));
82
+ }
83
+ }
84
+
85
+ const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
86
+
87
+ return defaultText ? `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
88
+ import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
89
+ import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
90
+ import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
91
+ import {
92
+ IM_TITLE_${illustrationNameUpperCase},
93
+ IM_SUBTITLE_${illustrationNameUpperCase},
94
+ } from "../generated/i18n/i18n-defaults.js";
95
+
96
+ const name = "${illustrationName}";
97
+ const set = "${illustrationSet}";
98
+ const title = IM_TITLE_${illustrationNameUpperCase};
99
+ const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};
100
+
101
+ registerIllustration(name, {
102
+ dialogSvg,
103
+ sceneSvg,
104
+ spotSvg,
105
+ title,
106
+ subtitle,
107
+ set,
108
+ });
109
+
110
+ export {
111
+ dialogSvg,
112
+ sceneSvg,
113
+ spotSvg,
114
+ };` :
115
+ `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
116
+ import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
117
+ import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
118
+ import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
119
+
120
+ const name = "${illustrationName}";
121
+ const set = "${illustrationSet}";
122
+
123
+ registerIllustration(name, {
124
+ dialogSvg,
125
+ sceneSvg,
126
+ spotSvg,
127
+ set,
128
+ });
129
+
130
+ export {
131
+ dialogSvg,
132
+ sceneSvg,
133
+ spotSvg,
134
+ };`
135
+ };
136
+
137
+ await fs.mkdir(destPath, { recursive: true });
138
+
139
+ const illustrationFileNames = await fs.readdir(path.normalize(srcPath));
140
+
141
+ // convert SVG to JS imports
142
+ const promises = [];
143
+ illustrationFileNames.forEach(illustration => {
144
+ if (fileNamePattern.test(illustration)) {
145
+ let [fileName, illustrationName] = illustration.match(fileNamePattern);
146
+
147
+ promises.push(svgToJs(fileName));
148
+ fileNames.add(illustrationName);
149
+ }
150
+ });
151
+
152
+ for (let illustrationName of fileNames) {
153
+ promises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
154
+ }
155
+
156
+ return Promise.all(promises);
157
+ };
158
+
159
+ generate().then(() => {
160
+ console.log("Illustrations generated.");
161
+ });
@@ -1,80 +1,31 @@
1
1
  const fs = require("fs");
2
-
3
- const jsFileContentTemplate = componentName => {
4
- return `import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
5
- import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
6
- import ${componentName}Template from "./generated/templates/${componentName}Template.lit.js";
7
-
8
- // Styles
9
- import ${componentName}Css from "./generated/themes/${componentName}.css.js";
2
+ const path = require("path");
3
+ const prompts = require("prompts");
4
+ const jsFileContentTemplate = require("./jsFileContentTemplate.js");
5
+ const tsFileContentTemplate = require("./tsFileContentTemplate.js");
10
6
 
11
7
  /**
12
- * @public
8
+ * Hyphanates the given PascalCase string.
9
+ * For Example:
10
+ * FooBar -> "foo-bar"
11
+ * Foobar -> "foobar-tag" (adds suffix)
13
12
  */
14
- const metadata = {
15
- tag: "${tagName}",
16
- properties: /** @lends sap.ui.webcomponents.${library}.${componentName}.prototype */ {
17
- //
18
- },
19
- slots: /** @lends sap.ui.webcomponents.${library}.${componentName}.prototype */ {
20
- //
21
- },
22
- events: /** @lends sap.ui.webcomponents.${library}.${componentName}.prototype */ {
23
- //
24
- },
13
+ const hyphaneteComponentName = (componentName) => {
14
+ const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
15
+
16
+ return result.includes("-") ? result : `${result}-tag`;
25
17
  };
26
18
 
27
19
  /**
28
- * @class
29
- *
30
- * <h3 class="comment-api-title">Overview</h3>
31
- *
32
- *
33
- * <h3>Usage</h3>
34
- *
35
- * For the <code>${tagName}</code>
36
- * <h3>ES6 Module Import</h3>
37
- *
38
- * <code>import ${packageName}/dist/${componentName}.js";</code>
39
- *
40
- * @constructor
41
- * @author SAP SE
42
- * @alias sap.ui.webcomponents.${library}.${componentName}
43
- * @extends UI5Element
44
- * @tagname ${tagName}
45
- * @public
20
+ * Capitalizes first letter of string.
46
21
  */
47
- class ${componentName} extends UI5Element {
48
- static get metadata() {
49
- return metadata;
50
- }
51
-
52
- static get render() {
53
- return litRender;
54
- }
55
-
56
- static get styles() {
57
- return ${componentName}Css;
58
- }
59
-
60
- static get template() {
61
- return ${componentName}Template;
62
- }
63
-
64
- static get dependencies() {
65
- return [];
66
- }
67
-
68
- static async onDefine() {
69
-
70
- }
71
- }
22
+ const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
72
23
 
73
- ${componentName}.define();
74
-
75
- export default ${componentName};
76
- `;
77
- };
24
+ /**
25
+ * Validates component name, enforcing PascalCase pattern - Button, MyButton.
26
+ */
27
+ const PascalCasePattern = /^([A-Z]+)([A-Za-z]+)$/
28
+ const isNameValid = name => typeof name === "string" && PascalCasePattern.test(name);
78
29
 
79
30
  const getPackageName = () => {
80
31
  if (!fs.existsSync("./package.json")) {
@@ -108,39 +59,64 @@ const getLibraryName = packageName => {
108
59
  return packageName.substr("webcomponents-".length);
109
60
  };
110
61
 
111
- const camelToKebabCase = string => string.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
112
-
113
- const packageName = getPackageName();
114
- const library = getLibraryName(packageName);
115
-
116
- const consoleArguments = process.argv.slice(2);
117
- const componentName = consoleArguments[0];
118
-
119
- if (!componentName){
120
- console.error("Please enter component name.");
121
- return;
62
+ const generateFiles = (componentName, tagName, library, packageName, isTypeScript) => {
63
+ componentName = capitalizeFirstLetter(componentName);
64
+ const filePaths = {
65
+ "main": isTypeScript
66
+ ? `./src/${componentName}.ts`
67
+ : `./src/${componentName}.js`,
68
+ "css": `./src/themes/${componentName}.css`,
69
+ "template": `./src/${componentName}.hbs`,
70
+ };
71
+
72
+ const FileContentTemplate = isTypeScript
73
+ ? tsFileContentTemplate(componentName, tagName, library, packageName)
74
+ : jsFileContentTemplate(componentName, tagName, library, packageName);
75
+
76
+ fs.writeFileSync(filePaths.main, FileContentTemplate, { flag: "wx+" });
77
+ fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
78
+ fs.writeFileSync(filePaths.template, "<div>Hello World</div>", { flag: "wx+" });
79
+
80
+ console.log(`Successfully generated ${filePaths.main}`);
81
+ console.log(`Successfully generated ${filePaths.css}`);
82
+ console.log(`Successfully generated ${filePaths.template}`);
83
+
84
+ // Change the color of the output
85
+ console.warn('\x1b[33m%s\x1b[0m', `
86
+ Make sure to import the component in your bundle by using:
87
+ import ${componentName} from "./dist/${componentName}.js";`);
122
88
  }
123
89
 
124
- const tagName = `ui5-${camelToKebabCase(componentName)}`;
90
+ // Main function
91
+ const createWebComponent = async () => {
92
+ const packageName = getPackageName();
93
+ const library = getLibraryName(packageName);
125
94
 
126
- const filePaths = {
127
- "js": `./src/${componentName}.js`,
128
- "css": `./src/themes/${componentName}.css`,
129
- "hbs": `./src/${componentName}.hbs`,
130
- };
131
- const sJsFileContentTemplate = jsFileContentTemplate(componentName);
95
+ const consoleArguments = process.argv.slice(2);
96
+ let componentName = consoleArguments[0];
132
97
 
133
- fs.writeFileSync(filePaths.js, sJsFileContentTemplate, { flag: "wx+" });
134
- fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
135
- fs.writeFileSync(filePaths.hbs, "<div>Hello World</div>", { flag: "wx+" });
98
+ if (componentName && !isNameValid(componentName)) {
99
+ throw new Error(`${componentName} is invalid component name. Use only letters (at least two) and start with capital one: Button, MyButton, etc.`);
100
+ }
136
101
 
102
+ if (!componentName) {
103
+ const response = await prompts({
104
+ type: "text",
105
+ name: "componentName",
106
+ message: "Please enter a component name:",
107
+ validate: (value) => isNameValid(value),
108
+ });
109
+ componentName = response.componentName;
110
+
111
+ if (!componentName) {
112
+ process.exit();
113
+ }
114
+ }
115
+
116
+ const isTypeScript = fs.existsSync(path.join(process.cwd(), "tsconfig.json"));
117
+ const tagName = hyphaneteComponentName(componentName);
137
118
 
138
- console.log(`Successfully generated ${componentName}.js`);
139
- console.log(`Successfully generated ${componentName}.css`);
140
- console.log(`Successfully generated ${componentName}.hbs`);
119
+ generateFiles(componentName, tagName, library, packageName, isTypeScript);
120
+ };
141
121
 
142
- // Change the color of the output
143
- console.warn('\x1b[33m%s\x1b[0m', `
144
- Please import the generated component in bundle.esm.js:
145
- import ${componentName} from "./dist/${componentName}.js";
146
- `);
122
+ createWebComponent();
@@ -0,0 +1,73 @@
1
+ const jsFileContentTemplate = (componentName, tagName, library, packageName) => {
2
+ return `import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
3
+ import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
4
+ import ${componentName}Template from "./generated/templates/${componentName}Template.lit.js";
5
+
6
+ // Styles
7
+ import ${componentName}Css from "./generated/themes/${componentName}.css.js";
8
+
9
+ /**
10
+ * @public
11
+ */
12
+ const metadata = {
13
+ tag: "${tagName}",
14
+ properties: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
15
+ //
16
+ },
17
+ slots: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
18
+ //
19
+ },
20
+ events: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
21
+ //
22
+ },
23
+ };
24
+
25
+ /**
26
+ * @class
27
+ *
28
+ * <h3 class="comment-api-title">Overview</h3>
29
+ *
30
+ *
31
+ * <h3>Usage</h3>
32
+ *
33
+ * For the <code>${tagName}</code>
34
+ * <h3>ES6 Module Import</h3>
35
+ *
36
+ * <code>import ${packageName}/dist/${componentName}.js";</code>
37
+ *
38
+ * @constructor
39
+ * @author SAP SE
40
+ * @alias sap.ui.webc.${library}.${componentName}
41
+ * @extends sap.ui.webc.base.UI5Element
42
+ * @tagname ${tagName}
43
+ * @public
44
+ */
45
+ class ${componentName} extends UI5Element {
46
+ static get metadata() {
47
+ return metadata;
48
+ }
49
+
50
+ static get render() {
51
+ return litRender;
52
+ }
53
+
54
+ static get styles() {
55
+ return ${componentName}Css;
56
+ }
57
+
58
+ static get template() {
59
+ return ${componentName}Template;
60
+ }
61
+
62
+ static get dependencies() {
63
+ return [];
64
+ }
65
+ }
66
+
67
+ ${componentName}.define();
68
+
69
+ export default ${componentName};
70
+ `;
71
+ };
72
+
73
+ module.exports = jsFileContentTemplate;
@@ -0,0 +1,80 @@
1
+ const tsFileContentTemplate = (componentName, tagName, library, packageName) => {
2
+ return `import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
3
+ import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
4
+ import property from "@ui5/webcomponents-base/dist/decorators/property.js";
5
+ import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
6
+ import event from "@ui5/webcomponents-base/dist/decorators/event.js";
7
+ import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
8
+
9
+ import ${componentName}Template from "./generated/templates/${componentName}Template.lit.js";
10
+
11
+ // Styles
12
+ import ${componentName}Css from "./generated/themes/${componentName}.css.js";
13
+
14
+ /**
15
+ * @class
16
+ *
17
+ * <h3 class="comment-api-title">Overview</h3>
18
+ *
19
+ *
20
+ * <h3>Usage</h3>
21
+ *
22
+ * For the <code>${tagName}</code>
23
+ * <h3>ES6 Module Import</h3>
24
+ *
25
+ * <code>import ${packageName}/dist/${componentName}.js";</code>
26
+ *
27
+ * @constructor
28
+ * @author SAP SE
29
+ * @alias sap.ui.webc.${library}.${componentName}
30
+ * @extends sap.ui.webc.base.UI5Element
31
+ * @tagname ${tagName}
32
+ * @public
33
+ */
34
+ @customElement({
35
+ tag: "${tagName}",
36
+ renderer: litRender,
37
+ styles: ${componentName}Css,
38
+ template: ${componentName}Template,
39
+ dependencies: [],
40
+ })
41
+
42
+ /**
43
+ * Example custom event.
44
+ * Please keep in mind that all public events should be documented in the API Reference as shown below.
45
+ *
46
+ * @event sap.ui.webc.${library}.${componentName}#interact
47
+ * @public
48
+ */
49
+ @event("interact", { detail: { /* event payload ( optional ) */ } })
50
+ class ${componentName} extends UI5Element {
51
+ /**
52
+ * Defines the value of the component.
53
+ *
54
+ * @type {string}
55
+ * @name sap.ui.webc.${library}.${componentName}.prototype.value
56
+ * @defaultvalue ""
57
+ * @public
58
+ */
59
+ @property()
60
+ value!: string;
61
+
62
+ /**
63
+ * Defines the text of the component.
64
+ *
65
+ * @type {Node[]}
66
+ * @name sap.ui.webc.${library}.${componentName}.prototype.default
67
+ * @slot
68
+ * @public
69
+ */
70
+ @slot({ type: Node, "default": true })
71
+ text!: Array<Node>;
72
+ }
73
+
74
+ ${componentName}.define();
75
+
76
+ export default ${componentName};
77
+ `;
78
+ };
79
+
80
+ module.exports = tsFileContentTemplate;