@ui5/webcomponents-tools 0.0.0-2c7615fe9 → 0.0.0-2cf9f07f8

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 (95) hide show
  1. package/CHANGELOG.md +582 -0
  2. package/README.md +5 -6
  3. package/assets-meta.js +11 -2
  4. package/bin/dev.js +1 -5
  5. package/components-package/eslint.js +34 -0
  6. package/components-package/nps.js +89 -58
  7. package/components-package/postcss.components.js +18 -15
  8. package/components-package/postcss.themes.js +23 -16
  9. package/components-package/vite.config.js +13 -0
  10. package/components-package/wdio.js +400 -344
  11. package/components-package/wdio.sync.js +368 -0
  12. package/icons-collection/nps.js +46 -15
  13. package/lib/copy-and-watch/index.js +24 -1
  14. package/lib/copy-list/index.js +17 -17
  15. package/lib/create-icons/index.js +124 -58
  16. package/lib/create-illustrations/index.js +143 -38
  17. package/lib/create-new-component/index.js +71 -104
  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 +13 -9
  23. package/lib/generate-custom-elements-manifest/index.js +327 -0
  24. package/lib/generate-js-imports/illustrations.js +83 -0
  25. package/lib/generate-json-imports/i18n.js +38 -31
  26. package/lib/generate-json-imports/themes.js +31 -24
  27. package/lib/hbs2lit/src/compiler.js +24 -4
  28. package/lib/hbs2lit/src/includesReplacer.js +5 -5
  29. package/lib/hbs2lit/src/litVisitor2.js +95 -24
  30. package/lib/hbs2lit/src/svgProcessor.js +12 -5
  31. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +32 -4
  32. package/lib/hbs2ui5/index.js +56 -23
  33. package/lib/i18n/defaults.js +65 -57
  34. package/lib/i18n/toJSON.js +12 -11
  35. package/lib/jsdoc/configTypescript.json +29 -0
  36. package/lib/jsdoc/plugin.js +41 -0
  37. package/lib/jsdoc/preprocess.js +146 -0
  38. package/lib/jsdoc/template/publish.js +21 -2
  39. package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
  40. package/lib/postcss-css-to-esm/index.js +54 -9
  41. package/lib/postcss-css-to-json/index.js +19 -3
  42. package/lib/postcss-p/postcss-p.mjs +14 -0
  43. package/lib/postcss-scope-vars/index.js +24 -0
  44. package/lib/replace-global-core/index.js +13 -8
  45. package/lib/scoping/get-all-tags.js +1 -8
  46. package/lib/scoping/missing-dependencies.js +65 -0
  47. package/lib/scoping/report-tags-usage.js +28 -0
  48. package/lib/scoping/scope-test-pages.js +1 -1
  49. package/lib/test-runner/test-runner.js +71 -0
  50. package/package.json +35 -38
  51. package/bin/init-ui5-package.js +0 -3
  52. package/components-package/rollup.js +0 -216
  53. package/lib/documentation/index.js +0 -165
  54. package/lib/documentation/templates/api-component-since.js +0 -3
  55. package/lib/documentation/templates/api-css-variables-section.js +0 -24
  56. package/lib/documentation/templates/api-events-section.js +0 -35
  57. package/lib/documentation/templates/api-methods-section.js +0 -26
  58. package/lib/documentation/templates/api-properties-section.js +0 -40
  59. package/lib/documentation/templates/api-slots-section.js +0 -28
  60. package/lib/documentation/templates/template.js +0 -38
  61. package/lib/hash/config.js +0 -10
  62. package/lib/hash/generate.js +0 -19
  63. package/lib/hash/upToDate.js +0 -31
  64. package/lib/init-package/index.js +0 -136
  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 -31
  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/lib/polyfill-placeholder/index.js +0 -5
  93. package/lib/serve/index.js +0 -46
  94. package/lib/serve/serve.json +0 -3
  95. package/package-lock.json +0 -48
@@ -1,58 +1,124 @@
1
- const fs = require("fs");
2
- const path = require("path");
3
- const mkdirp = require("mkdirp");
4
-
5
- const collectionName = process.argv[2] || "SAP-icons";
6
- const srcFile = path.normalize(`src/${collectionName}.json`);
7
- const destDir = path.normalize("dist/");
8
-
9
- mkdirp.sync(destDir);
10
-
11
- const template = (name, pathData, ltr, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
12
-
13
- const name = "${name}";
14
- const pathData = "${pathData}";
15
- const ltr = ${ltr};
16
- const collection = "${collection}";
17
- const packageName = "${packageName}";
18
-
19
- registerIcon(name, { pathData, ltr, collection, packageName });
20
-
21
- export default { pathData };`;
22
-
23
-
24
- const accTemplate = (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 { pathData, accData };`;
37
-
38
- const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
39
- <path d="${pathData}"/>
40
- </svg>`;
41
-
42
- const createIcons = (file) => {
43
- const json = JSON.parse(fs.readFileSync(file));
44
-
45
- for (let name in json.data) {
46
- const iconData = json.data[name];
47
- const pathData = iconData.path;
48
- const ltr = !!iconData.ltr;
49
- const acc = iconData.acc;
50
-
51
- const content = acc ? accTemplate(name, pathData, ltr, acc, json.collection, json.packageName) : template(name, pathData, ltr, json.collection, json.packageName);
52
-
53
- fs.writeFileSync(path.join(destDir, `${name}.js`), content);
54
- fs.writeFileSync(path.join(destDir, `${name}.svg`), svgTemplate(pathData));
55
- }
56
- };
57
-
58
- createIcons(srcFile);
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
+ });
@@ -1,33 +1,113 @@
1
- const fs = require("fs");
1
+ const fs = require("fs").promises;
2
2
  const path = require("path");
3
- const mkdirp = require("mkdirp");
4
3
 
5
- if (process.argv.length < 4) {
6
- return;
4
+ if (process.argv.length < 7) {
5
+ throw new Error("Not enough arguments");
7
6
  }
8
7
 
9
- const fileNamePattern = /sapIllus-.+-(.+).svg/;
10
- const srcPath = process.argv[2];
11
- const destPath = process.argv[3];
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 collection = process.argv[7];
61
+ const fileNamePattern = new RegExp(`${illustrationsPrefix}-.+-(.+).svg`);
12
62
  // collect each illustration name because each one should have Sample.js file
13
- const fileNames = new Set();
63
+ const fileNames = new Set();
64
+
65
+ try {
66
+ await fs.access(srcPath);
67
+ } catch (error) {
68
+ console.log(`The path ${srcPath} does not exist.`);
69
+ return Promise.resolve(null);
70
+ }
71
+
72
+ console.log(`Generating illustrations from ${srcPath} to ${destPath}`)
73
+
74
+ const svgImportTemplate = svgContent => {
75
+ return `export default \`${svgContent}\`;`
76
+ };
77
+ const svgToJs = async fileName => {
78
+ const svg = await fs.readFile(path.join(srcPath, fileName), {encoding: "utf-8"});
79
+ const fileContent = svgImportTemplate(svg);
80
+ fileName = fileName.replace(/\.svg$/, ".js");
14
81
 
15
- const svgImportTemplate = svgContent => { return `export default \`${svgContent}\`;`};
16
- const illustrationImportTemplate = illustrationName => {
17
- const illustationNameUpperCase = illustrationName.toUpperCase();
82
+ return fs.writeFile(path.join(destPath, fileName), fileContent);
83
+ };
84
+ const illustrationImportTemplate = illustrationName => {
85
+ let illustrationNameForTranslation = illustrationName;
18
86
 
19
- return `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
20
- import dialogSvg from "./sapIllus-Dialog-${illustrationName}.js";
21
- import sceneSvg from "./sapIllus-Scene-${illustrationName}.js";
22
- import spotSvg from "./sapIllus-Spot-${illustrationName}.js";
87
+ if (defaultText) {
88
+ if (FALLBACK_TEXTS[illustrationNameForTranslation]) {
89
+ illustrationNameForTranslation = FALLBACK_TEXTS[illustrationNameForTranslation];
90
+ } else if (illustrationName.indexOf("_v") !== -1) {
91
+ illustrationNameForTranslation = illustrationNameForTranslation.substr(0, illustrationNameForTranslation.indexOf('_v'));
92
+ }
93
+ }
94
+
95
+ const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
96
+
97
+ return defaultText ? `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
98
+ import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
99
+ import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
100
+ import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
23
101
  import {
24
- IM_TITLE_${illustationNameUpperCase},
25
- IM_SUBTITLE_${illustationNameUpperCase},
102
+ IM_TITLE_${illustrationNameUpperCase},
103
+ IM_SUBTITLE_${illustrationNameUpperCase},
26
104
  } from "../generated/i18n/i18n-defaults.js";
27
105
 
28
106
  const name = "${illustrationName}";
29
- const title = IM_TITLE_${illustationNameUpperCase};
30
- const subtitle = IM_SUBTITLE_${illustationNameUpperCase};
107
+ const set = "${illustrationSet}";
108
+ const collection = "${collection}";
109
+ const title = IM_TITLE_${illustrationNameUpperCase};
110
+ const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};
31
111
 
32
112
  registerIllustration(name, {
33
113
  dialogSvg,
@@ -35,36 +115,61 @@ registerIllustration(name, {
35
115
  spotSvg,
36
116
  title,
37
117
  subtitle,
118
+ set,
119
+ collection,
38
120
  });
39
121
 
40
122
  export {
41
123
  dialogSvg,
42
124
  sceneSvg,
43
125
  spotSvg,
44
- };`};
126
+ };` :
127
+ `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
128
+ import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
129
+ import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
130
+ import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
45
131
 
46
- const svgToJs = fileName => {
47
- const svg = fs.readFileSync(path.join(srcPath, fileName), { encoding: "utf-8" });
48
- const fileContent = svgImportTemplate(svg);
49
- fileName = fileName.replace(/\.svg$/, ".js");
132
+ const name = "${illustrationName}";
133
+ const set = "${illustrationSet}";
134
+ const collection = "${collection}";
50
135
 
51
- fs.writeFileSync(path.join(destPath, fileName), fileContent);
52
- }
136
+ registerIllustration(name, {
137
+ dialogSvg,
138
+ sceneSvg,
139
+ spotSvg,
140
+ set,
141
+ collection,
142
+ });
53
143
 
54
- mkdirp.sync(destPath);
144
+ export {
145
+ dialogSvg,
146
+ sceneSvg,
147
+ spotSvg,
148
+ };`
149
+ };
55
150
 
56
- const illustrationFileNames = fs.readdirSync(path.normalize(srcPath));
151
+ await fs.mkdir(destPath, { recursive: true });
57
152
 
58
- // convert SVG to JS imports
59
- illustrationFileNames.forEach(illustration => {
60
- if (fileNamePattern.test(illustration)) {
61
- let [fileName, illustrationName] = illustration.match(fileNamePattern);
153
+ const illustrationFileNames = await fs.readdir(path.normalize(srcPath));
62
154
 
63
- svgToJs(fileName);
64
- fileNames.add(illustrationName);
155
+ // convert SVG to JS imports
156
+ const promises = [];
157
+ illustrationFileNames.forEach(illustration => {
158
+ if (fileNamePattern.test(illustration)) {
159
+ let [fileName, illustrationName] = illustration.match(fileNamePattern);
160
+
161
+ promises.push(svgToJs(fileName));
162
+ fileNames.add(illustrationName);
163
+ }
164
+ });
165
+
166
+ for (let illustrationName of fileNames) {
167
+ promises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
65
168
  }
66
- });
67
169
 
68
- for (let illustrationName of fileNames) {
69
- fs.writeFileSync(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName));
70
- }
170
+ return Promise.all(promises);
171
+ };
172
+
173
+ generate().then(() => {
174
+ console.log("Illustrations generated.");
175
+ });
@@ -1,80 +1,30 @@
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, f.e.:
9
+ * Foo -> "my-foo" (adds preffix)
10
+ * FooBar -> "foo-bar"
13
11
  */
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
- },
12
+ const hyphaneteComponentName = (componentName) => {
13
+ const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
14
+
15
+ return result.includes("-") ? result : `my-${result}`;
25
16
  };
26
17
 
27
18
  /**
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
19
+ * Capitalizes first letter of string.
46
20
  */
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
- }
72
-
73
- ${componentName}.define();
21
+ const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
74
22
 
75
- export default ${componentName};
76
- `;
77
- };
23
+ /**
24
+ * Validates component name, enforcing PascalCase pattern - Button, MyButton.
25
+ */
26
+ const PascalCasePattern = /^[A-Z][A-Za-z0-9]+$/;
27
+ const isNameValid = name => typeof name === "string" && PascalCasePattern.test(name);
78
28
 
79
29
  const getPackageName = () => {
80
30
  if (!fs.existsSync("./package.json")) {
@@ -108,47 +58,64 @@ const getLibraryName = packageName => {
108
58
  return packageName.substr("webcomponents-".length);
109
59
  };
110
60
 
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;
61
+ const generateFiles = (componentName, tagName, library, packageName, isTypeScript) => {
62
+ componentName = capitalizeFirstLetter(componentName);
63
+ const filePaths = {
64
+ "main": isTypeScript
65
+ ? `./src/${componentName}.ts`
66
+ : `./src/${componentName}.js`,
67
+ "css": `./src/themes/${componentName}.css`,
68
+ "template": `./src/${componentName}.hbs`,
69
+ };
70
+
71
+ const FileContentTemplate = isTypeScript
72
+ ? tsFileContentTemplate(componentName, tagName, library, packageName)
73
+ : jsFileContentTemplate(componentName, tagName, library, packageName);
74
+
75
+ fs.writeFileSync(filePaths.main, FileContentTemplate, { flag: "wx+" });
76
+ fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
77
+ fs.writeFileSync(filePaths.template, "<div>Hello World</div>", { flag: "wx+" });
78
+
79
+ console.log(`Successfully generated ${filePaths.main}`);
80
+ console.log(`Successfully generated ${filePaths.css}`);
81
+ console.log(`Successfully generated ${filePaths.template}`);
82
+
83
+ // Change the color of the output
84
+ console.warn('\x1b[33m%s\x1b[0m', `
85
+ Make sure to import the component in your bundle by using:
86
+ import "./dist/${componentName}.js";`);
122
87
  }
123
88
 
124
- const tagName = `ui5-${camelToKebabCase(componentName)}`;
125
-
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);
89
+ // Main function
90
+ const createWebComponent = async () => {
91
+ const packageName = getPackageName();
92
+ const library = getLibraryName(packageName);
132
93
 
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+" });
94
+ const consoleArguments = process.argv.slice(2);
95
+ let componentName = consoleArguments[0];
136
96
 
97
+ if (componentName && !isNameValid(componentName)) {
98
+ throw new Error(`${componentName} is invalid component name. Use only letters (at least two) and start with capital one: Button, MyButton, etc.`);
99
+ }
137
100
 
138
- console.log(`Successfully generated ${componentName}.js`);
139
- console.log(`Successfully generated ${componentName}.css`);
140
- console.log(`Successfully generated ${componentName}.hbs`);
101
+ if (!componentName) {
102
+ const response = await prompts({
103
+ type: "text",
104
+ name: "componentName",
105
+ message: "Please enter a component name:",
106
+ validate: (value) => isNameValid(value) ? true : "Component name should follow PascalCase naming convention (f.e. Button, MyButton, etc.).",
107
+ });
108
+ componentName = response.componentName;
109
+
110
+ if (!componentName) {
111
+ process.exit();
112
+ }
113
+ }
141
114
 
142
- const bundleLogger = fs.createWriteStream("./bundle.common.js", {
143
- flags: "a" // appending
144
- });
115
+ const isTypeScript = fs.existsSync(path.join(process.cwd(), "tsconfig.json"));
116
+ const tagName = hyphaneteComponentName(componentName);
145
117
 
146
- bundleLogger.write(`
147
- // TODO: Move this line in order to keep the file sorted alphabetically
148
- import ${componentName} from "./dist/${componentName}.js";`);
118
+ generateFiles(componentName, tagName, library, packageName, isTypeScript);
119
+ };
149
120
 
150
- // Change the color of the output
151
- console.warn('\x1b[33m%s\x1b[0m', `
152
- Component is imported in bundle.common.js.
153
- Do NOT forget to sort the file in alphabeticall order.
154
- `);
121
+ 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;